Package-level declarations

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.

Associates the specified origination identity with a pool.

Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.

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.

Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

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 500KB 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.

Removes the current account default protect configuration.

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 account-level monthly spending limit override for sending multimedia messages (MMS). 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 Quotas for Server Migration Service in the Server Migration Service User Guide.

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 the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.

Permanently delete the protect configuration rule set number override.

Permanently delete an existing registration from your account.

Permanently delete the specified registration attachment.

Delete the value in a registration form field.

Deletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.

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 Quotas in the AWS End User Messaging SMS User 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 Quotas in the AWS End User Messaging SMS User 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 AWS End User Messaging SMS and Voice 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 protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.

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 monthly spend limits for sending voice and text messages.

Retrieves the specified verified destination numbers.

Removes the specified origination identity from an existing pool.

Disassociate a protect configuration from a configuration set.

Discard the current version of the registration.

Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.

Retrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.

Lists all associated origination identities in your pool.

Retrieve all of the protect configuration rule set number overrides that match the filters.

Retrieve all of the origination identities 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.

Set the MessageFeedbackStatus as RECEIVED or FAILED for the passed in MessageId.

Creates an opted out destination phone number in the opt-out list.

Create or update a phone number rule override and associate it with a protect configuration.

Creates or updates a field value for a registration.

Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.

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 Request a phone number in the AWS End User Messaging SMS 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 multimedia message (MMS) and sends it to a recipient's phone number.

Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked.

Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.

Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.

Sets a configuration set's default for message feedback.

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 MMS 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 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 resource. When you specify an existing tag key, the value is overwritten with the new value. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.

Removes the association of the specified tags from a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and 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.

Update the setting for an existing protect configuration.

Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.

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.