pinpointsmsvoice: Amazon Pinpoint SMS and Voice Service

In paws.customer.engagement: 'Amazon Web Services' Customer Engagement Services

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: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
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)

paws.customer.engagement documentation built on Sept. 12, 2023, 1:19 a.m.