Client
pinpointsmsvoice | R Documentation |
Amazon Pinpoint SMS and Voice Service¶
Description¶
Pinpoint SMS and Voice Messaging public facing APIs
Usage¶
pinpointsmsvoice(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments¶
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value¶
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've
assigned to the client. The available operations are listed in the
Operations section.
Service syntax¶
svc <- pinpointsmsvoice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
create_configuration_set | Create a new configuration set |
create_configuration_set_event_destination | Create a new event destination in a configuration set |
delete_configuration_set | Deletes an existing configuration set |
delete_configuration_set_event_destination | Deletes an event destination in a configuration set |
get_configuration_set_event_destinations | Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination |
list_configuration_sets | List all of the configuration sets associated with your Amazon Pinpoint account in the current region |
send_voice_message | Create a new voice message and send it to a recipient's phone number |
update_configuration_set_event_destination | Update an event destination in a configuration set |
Examples¶
## Not run:
svc <- pinpointsmsvoice()
svc$create_configuration_set(
Foo = 123
)
## End(Not run)