Client

pinpointsmsvoicev2

R Documentation

Amazon Pinpoint SMS Voice V2¶

Description¶

Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. This guide provides information about AWS End User Messaging SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.

If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The AWS End User Messaging SMS and Voice version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.

Usage¶

pinpointsmsvoicev2(
  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 <- pinpointsmsvoicev2(
  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¶

associate_origination_identity: Associates the specified origination identity with a pool
associate_protect_configuration: Associate a protect configuration with a configuration set
create_configuration_set: Creates a new configuration set
create_event_destination: Creates a new event destination in a configuration set
create_opt_out_list: Creates a new opt-out list
create_pool: Creates a new pool and associates the specified origination identity to the pool
create_protect_configuration: Create a new protect configuration
create_registration: Creates a new registration based on the RegistrationType field
create_registration_association: Associate the registration with an origination identity such as a phone number or sender ID
create_registration_attachment: Create a new registration attachment to use for uploading a file or a URL to a file
create_registration_version: Create a new version of the registration and increase the VersionNumber
create_verified_destination_number: You can only send messages to verified destination numbers when your account is in the sandbox; Removes the current account default protect configuration
delete_configuration_set: Deletes an existing configuration set
delete_default_message_type: Deletes an existing default message type on a configuration set
delete_default_sender_id: Deletes an existing default sender ID on a configuration set
delete_event_destination: Deletes an existing event destination
delete_keyword: Deletes an existing keyword from an origination phone number or pool; Deletes an account-level monthly spending limit override for sending multimedia messages (MMS)
delete_opted_out_number: Deletes an existing opted out destination phone number from the specified opt-out list
delete_opt_out_list: Deletes an existing opt-out list
delete_pool: Deletes an existing pool
delete_protect_configuration: Permanently delete the protect configuration
delete_registration: Permanently delete an existing registration from your account
delete_registration_attachment: Permanently delete the specified registration attachment
delete_registration_field_value: Delete the value in a registration form field; Deletes an account-level monthly spending limit override for sending text messages
delete_verified_destination_number: Delete a verified destination phone number; Deletes an account level monthly spend limit override for sending voice messages
describe_account_attributes: Describes attributes of your Amazon Web Services account
describe_account_limits: Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your account
describe_configuration_sets: Describes the specified configuration sets or all in your account
describe_keywords: Describes the specified keywords or all keywords on your origination phone number or pool
describe_opted_out_numbers: Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list
describe_opt_out_lists: Describes the specified opt-out list or all opt-out lists in your account
describe_phone_numbers: Describes the specified origination phone number, or all the phone numbers in your account
describe_pools: Retrieves the specified pools or all pools associated with your Amazon Web Services account
describe_protect_configurations: Retrieves the protect configurations that match any of filters
describe_registration_attachments: Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account; Retrieves the specified registration type field definitions
describe_registration_field_values: Retrieves the specified registration field values
describe_registrations: Retrieves the specified registrations; Retrieves the specified registration section definitions; Retrieves the specified registration type definitions
describe_registration_versions: Retrieves the specified registration version
describe_sender_ids: Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account
describe_spend_limits: Describes the current monthly spend limits for sending voice and text messages
describe_verified_destination_numbers: Retrieves the specified verified destiona numbers
disassociate_origination_identity: Removes the specified origination identity from an existing pool
disassociate_protect_configuration: Disassociate a protect configuration from a configuration set
discard_registration_version: Discard the current version of the registration; Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration
list_pool_origination_identities: Lists all associated origination identities in your pool
list_registration_associations: Retreive all of the origination identies that are associated with a registration
list_tags_for_resource: List all tags associated with a resource
put_keyword: Creates or updates a keyword configuration on an origination phone number or pool
put_opted_out_number: Creates an opted out destination phone number in the opt-out list
put_registration_field_value: Creates or updates a field value for a registration
release_phone_number: Releases an existing origination phone number in your account
release_sender_id: Releases an existing sender ID in your account
request_phone_number: Request an origination phone number for use in your account
request_sender_id: Request a new sender ID that doesn't require registration; Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number
send_media_message: Creates a new multimedia message (MMS) and sends it to a recipient's phone number
send_text_message: Creates a new text message and sends it to a recipient's phone number
send_voice_message: Allows you to send a request that sends a voice message; Set a protect configuration as your account default
set_default_message_type: Sets the default message type on a configuration set
set_default_sender_id: Sets default sender ID on a configuration set; Sets an account level monthly spend limit override for sending MMS messages
set_text_message_spend_limit_override: Sets an account level monthly spend limit override for sending text messages; Sets an account level monthly spend limit override for sending voice messages
submit_registration_version: Submit the specified registration for review and approval
tag_resource: Adds or overwrites only the specified tags for the specified resource
untag_resource: Removes the association of the specified tags from a resource
update_event_destination: Updates an existing event destination in a configuration set
update_phone_number: Updates the configuration of an existing origination phone number
update_pool: Updates the configuration of an existing pool
update_protect_configuration: Update the setting for an existing protect configuration; Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties
update_sender_id: Updates the configuration of an existing sender ID
verify_destination_number: Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages

Examples¶

## Not run: 
svc <- pinpointsmsvoicev2()
svc$associate_origination_identity(
  Foo = 123
)

## End(Not run)