PinpointSmsVoiceV2Client
Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint 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 Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, it's also helpful to review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The Amazon Pinpoint 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.
Functions
Associates the specified origination identity with a pool.
Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
Creates a new event destination in a configuration set.
Creates a new opt-out list.
Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
Creates a new registration based on the RegistrationType field.
Associate the registration with an origination identity such as a phone number or sender ID.
Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
Deletes an existing configuration set.
Deletes an existing default message type on a configuration set.
Deletes an existing default sender ID on a configuration set.
Deletes an existing event destination.
Deletes an existing keyword from an origination phone number or pool.
Deletes an existing opted out destination phone number from the specified opt-out list.
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
Permanently delete an existing registration from your account.
Permanently delete the specified registration attachment.
Delete the value in a registration form field.
Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Delete a verified destination phone number.
Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
Describes the specified configuration sets or all in your account.
Describes the specified keywords or all keywords on your origination phone number or pool.
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
Describes the specified opt-out list or all opt-out lists in your account.
Describes the specified origination phone number, or all the phone numbers in your account.
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
Retrieves the specified registration field values.
Retrieves the specified registrations.
Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
Retrieves the specified registration version.
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
Retrieves the specified verified destiona numbers.
Removes the specified origination identity from an existing pool.
Discard the current version of the registration.
Lists all associated origination identities in your pool.
Retreive all of the origination identies that are associated with a registration.
List all tags associated with a resource.
Creates or updates a keyword configuration on an origination phone number or pool.
Creates an opted out destination phone number in the opt-out list.
Creates or updates a field value for a registration.
Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
Releases an existing sender ID in your account.
Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
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. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
Creates a new text message and sends it to a recipient's phone number.
Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
Sets the default message type on a configuration set.
Sets default sender ID on a configuration set.
Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Submit the specified registration for review and approval.
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Updates the configuration of an existing sender ID.
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.
Inherited functions
Associates the specified origination identity with a pool.
Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
Creates a new event destination in a configuration set.
Creates a new opt-out list.
Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
Creates a new registration based on the RegistrationType field.
Associate the registration with an origination identity such as a phone number or sender ID.
Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
Deletes an existing configuration set.
Deletes an existing default message type on a configuration set.
Deletes an existing default sender ID on a configuration set.
Deletes an existing event destination.
Deletes an existing keyword from an origination phone number or pool.
Deletes an existing opted out destination phone number from the specified opt-out list.
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
Permanently delete an existing registration from your account.
Permanently delete the specified registration attachment.
Delete the value in a registration form field.
Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Delete a verified destination phone number.
Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
Paginate over DescribeAccountAttributesResponse results.
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
Paginate over DescribeAccountLimitsResponse results.
Describes the specified configuration sets or all in your account.
Paginate over DescribeConfigurationSetsResponse results.
Describes the specified keywords or all keywords on your origination phone number or pool.
Paginate over DescribeKeywordsResponse results.
Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
Paginate over DescribeOptedOutNumbersResponse results.
Describes the specified opt-out list or all opt-out lists in your account.
Paginate over DescribeOptOutListsResponse results.
Describes the specified origination phone number, or all the phone numbers in your account.
Paginate over DescribePhoneNumbersResponse results.
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
Paginate over DescribePoolsResponse results.
Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
Paginate over DescribeRegistrationAttachmentsResponse results.
Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
Paginate over DescribeRegistrationFieldDefinitionsResponse results.
Retrieves the specified registration field values.
Paginate over DescribeRegistrationFieldValuesResponse results.
Retrieves the specified registrations.
Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
Paginate over DescribeRegistrationSectionDefinitionsResponse results.
Paginate over DescribeRegistrationsResponse results.
Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
Paginate over DescribeRegistrationTypeDefinitionsResponse results.
Retrieves the specified registration version.
Paginate over DescribeRegistrationVersionsResponse results.
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
Paginate over DescribeSenderIdsResponse results.
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.
Paginate over DescribeSpendLimitsResponse results.
Retrieves the specified verified destiona numbers.
Paginate over DescribeVerifiedDestinationNumbersResponse results.
Removes the specified origination identity from an existing pool.
Discard the current version of the registration.
Lists all associated origination identities in your pool.
Paginate over ListPoolOriginationIdentitiesResponse results.
Retreive all of the origination identies that are associated with a registration.
Paginate over ListRegistrationAssociationsResponse results.
List all tags associated with a resource.
Creates or updates a keyword configuration on an origination phone number or pool.
Creates an opted out destination phone number in the opt-out list.
Creates or updates a field value for a registration.
Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
Releases an existing sender ID in your account.
Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.
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. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
Creates a new text message and sends it to a recipient's phone number.
Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
Sets the default message type on a configuration set.
Sets default sender ID on a configuration set.
Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Submit the specified registration for review and approval.
Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Updates the configuration of an existing sender ID.
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.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.