2026/03/31 - Amazon Pinpoint SMS Voice V2 - 15 new16 updated api methods
Changes This release adds RCS for Business messaging and Notify support. RCS lets you create and manage agents, send and receive messages in the US and Canada via SendTextMessage API, and configure SMS fallback. Notify lets you send templated OTP messages globally in minutes with no phone number required.
Describes the specified notify templates or all notify templates in your account.
If you specify template IDs, the output includes information for only the specified notify templates. If you specify filters, the output includes information for only those notify templates that meet the filter criteria. If you don't specify template IDs or filters, the output includes information for all notify templates.
If you specify a template ID that isn't valid, an error is returned.
See also: AWS API Documentation
Request Syntax
client.describe_notify_templates(
TemplateIds=[
'string',
],
Filters=[
{
'Name': 'template-type'|'channels'|'tier-access'|'supported-countries'|'language-code'|'supported-voice-ids',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of template IDs to describe.
(string) --
Template identifier for notify templates. In UpdateNotifyConfiguration, pass UNSET_DEFAULT_TEMPLATE to clear the default template. The UNSET_DEFAULT_TEMPLATE value is only accepted by UpdateNotifyConfiguration.
list
An array of NotifyTemplateFilter objects to filter the results on.
(dict) --
The information for notify templates that meet a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array values to filter for.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'NotifyTemplates': [
{
'TemplateId': 'string',
'Version': 123,
'TemplateType': 'OTP_VERIFICATION',
'Channels': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'TierAccess': [
'BASIC'|'ADVANCED',
],
'Status': 'ACTIVE'|'INACTIVE',
'SupportedCountries': [
'string',
],
'LanguageCode': 'string',
'Content': 'string',
'Variables': {
'string': {
'Type': 'STRING'|'INTEGER'|'BOOLEAN',
'Required': True|False,
'Description': 'string',
'MaxLength': 123,
'MinValue': 123,
'MaxValue': 123,
'DefaultValue': 'string',
'Pattern': 'string',
'Sample': 'string',
'Source': 'CUSTOMER'|'SYSTEM'
}
},
'SupportedVoiceIds': [
'AMY'|'ASTRID'|'BIANCA'|'BRIAN'|'CAMILA'|'CARLA'|'CARMEN'|'CELINE'|'CHANTAL'|'CONCHITA'|'CRISTIANO'|'DORA'|'EMMA'|'ENRIQUE'|'EWA'|'FILIZ'|'GERAINT'|'GIORGIO'|'GWYNETH'|'HANS'|'INES'|'IVY'|'JACEK'|'JAN'|'JOANNA'|'JOEY'|'JUSTIN'|'KARL'|'KENDRA'|'KIMBERLY'|'LEA'|'LIV'|'LOTTE'|'LUCIA'|'LUPE'|'MADS'|'MAJA'|'MARLENE'|'MATHIEU'|'MATTHEW'|'MAXIM'|'MIA'|'MIGUEL'|'MIZUKI'|'NAJA'|'NICOLE'|'PENELOPE'|'RAVEENA'|'RICARDO'|'RUBEN'|'RUSSELL'|'SALLI'|'SEOYEON'|'TAKUMI'|'TATYANA'|'VICKI'|'VITORIA'|'ZEINA'|'ZHIYU',
],
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NotifyTemplates (list) --
An array of NotifyTemplateInformation objects that contain the results.
(dict) --
The information for a system-managed notify template in an Amazon Web Services account.
TemplateId (string) --
The unique identifier for the template.
Version (integer) --
The version of the template.
TemplateType (string) --
The type of the template.
Channels (list) --
The channels for the template. Supported values are SMS and VOICE.
(string) --
TierAccess (list) --
The tier access level for the template.
(string) --
The tier of a notify configuration.
BASIC - Basic tier.
ADVANCED - Advanced tier.
Status (string) --
The current status of the template.
SupportedCountries (list) --
An array of supported country codes for the template.
(string) --
LanguageCode (string) --
The language code for the template.
Content (string) --
The content of the template.
Variables (dict) --
An array of template variable metadata for the template.
(string) --
(dict) --
Contains metadata about a template variable.
Type (string) --
The type of the variable.
Required (boolean) --
Whether the variable is required.
Description (string) --
A description of the variable.
MaxLength (integer) --
The maximum length for string variables.
MinValue (integer) --
The minimum value for numeric variables.
MaxValue (integer) --
The maximum value for numeric variables.
DefaultValue (string) --
The default value for the variable.
Pattern (string) --
The regex pattern the variable value must match.
Sample (string) --
A sample value for the variable.
Source (string) --
The source of the variable, either CUSTOMER or SYSTEM.
SupportedVoiceIds (list) --
An array of supported voice IDs for voice templates.
(string) --
CreatedTimestamp (datetime) --
The time when the notify template was created, in UNIX epoch time format.
NextToken (string) --
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Describes the specified notify configurations or all notify configurations in your account.
If you specify notify configuration IDs, the output includes information for only the specified notify configurations. If you specify filters, the output includes information for only those notify configurations that meet the filter criteria. If you don't specify notify configuration IDs or filters, the output includes information for all notify configurations.
If you specify a notify configuration ID that isn't valid, an error is returned.
See also: AWS API Documentation
Request Syntax
client.describe_notify_configurations(
NotifyConfigurationIds=[
'string',
],
Filters=[
{
'Name': 'display-name'|'enabled-countries'|'enabled-channels'|'default-template'|'default-pool'|'use-case'|'status'|'deletion-protection-enabled'|'tier-upgrade-status',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of notify configuration IDs to describe.
(string) --
list
An array of NotifyConfigurationFilter objects to filter the results on.
(dict) --
The information for notify configurations that meet a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array values to filter for.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'NotifyConfigurations': [
{
'NotifyConfigurationArn': 'string',
'NotifyConfigurationId': 'string',
'DisplayName': 'string',
'UseCase': 'CODE_VERIFICATION',
'DefaultTemplateId': 'string',
'PoolId': 'string',
'EnabledCountries': [
'string',
],
'EnabledChannels': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'Tier': 'BASIC'|'ADVANCED',
'TierUpgradeStatus': 'BASIC'|'PENDING_UPGRADE'|'ADVANCED'|'REJECTED',
'Status': 'PENDING'|'ACTIVE'|'REJECTED'|'REQUIRES_VERIFICATION',
'RejectionReason': 'string',
'DeletionProtectionEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NotifyConfigurations (list) --
An array of NotifyConfigurationInformation objects that contain the results.
(dict) --
The information for a notify configuration in an Amazon Web Services account.
NotifyConfigurationArn (string) --
The Amazon Resource Name (ARN) for the notify configuration.
NotifyConfigurationId (string) --
The unique identifier for the notify configuration.
DisplayName (string) --
The display name associated with the notify configuration.
UseCase (string) --
The use case for the notify configuration.
DefaultTemplateId (string) --
The default template identifier associated with the notify configuration.
PoolId (string) --
The identifier of the pool associated with the notify configuration.
EnabledCountries (list) --
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
(string) --
EnabledChannels (list) --
An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
(string) --
Tier (string) --
The tier of the notify configuration.
TierUpgradeStatus (string) --
The tier upgrade status of the notify configuration.
Status (string) --
The current status of the notify configuration.
RejectionReason (string) --
The reason the notify configuration was rejected, if applicable.
DeletionProtectionEnabled (boolean) --
When set to true deletion protection is enabled. By default this is set to false.
CreatedTimestamp (datetime) --
The time when the notify configuration was created, in UNIX epoch time format.
NextToken (string) --
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Retrieves the specified RCS agents or all RCS agents associated with your Amazon Web Services account.
If you specify RCS agent IDs, the output includes information for only the specified RCS agents. If you specify filters, the output includes information for only those RCS agents that meet the filter criteria. If you don't specify RCS agent IDs or filters, the output includes information for all RCS agents.
See also: AWS API Documentation
Request Syntax
client.describe_rcs_agents(
RcsAgentIds=[
'string',
],
Owner='SELF'|'SHARED',
Filters=[
{
'Name': 'status'|'two-way-enabled'|'self-managed-opt-outs-enabled'|'opt-out-list-name'|'deletion-protection-enabled'|'two-way-channel-arn',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.
(string) --
string
Use SELF to filter the list of RCS agents to ones your account owns or use SHARED to filter on RCS agents shared with your account. The Owner and RcsAgentIds parameters can't be used at the same time.
list
An array of RcsAgentFilter objects to filter the results.
(dict) --
The information for an RCS agent that meets a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array values to filter for.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'RcsAgents': [
{
'RcsAgentArn': 'string',
'RcsAgentId': 'string',
'Status': 'CREATED'|'PENDING'|'TESTING'|'PARTIAL'|'ACTIVE'|'DELETED',
'CreatedTimestamp': datetime(2015, 1, 1),
'DeletionProtectionEnabled': True|False,
'OptOutListName': 'string',
'SelfManagedOptOutsEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'TwoWayEnabled': True|False,
'PoolId': 'string',
'TestingAgent': {
'Status': 'CREATED'|'PENDING'|'ACTIVE',
'TestingAgentId': 'string',
'RegistrationId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RcsAgents (list) --
An array of RcsAgentInformation objects that contain the details for the requested RCS agents.
(dict) --
The information for an RCS agent in an Amazon Web Services account.
RcsAgentArn (string) --
The Amazon Resource Name (ARN) of the RCS agent.
RcsAgentId (string) --
The unique identifier for the RCS agent.
Status (string) --
The current status of the RCS agent.
CreatedTimestamp (datetime) --
The time when the RCS agent was created, in UNIX epoch time format.
DeletionProtectionEnabled (boolean) --
When set to true the RCS agent can't be deleted.
OptOutListName (string) --
The name of the OptOutList associated with the RCS agent.
SelfManagedOptOutsEnabled (boolean) --
When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
TwoWayChannelArn (string) --
The Amazon Resource Name (ARN) of the two way channel.
TwoWayChannelRole (string) --
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
TwoWayEnabled (boolean) --
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
PoolId (string) --
The unique identifier of the pool associated with the RCS agent.
TestingAgent (dict) --
The testing agent information associated with the RCS agent.
Status (string) --
The current status of the testing agent.
TestingAgentId (string) --
The unique identifier for the testing agent.
RegistrationId (string) --
The unique identifier of the registration associated with the testing agent.
NextToken (string) --
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Creates a new notify configuration for managed messaging. A notify configuration defines the settings for sending templated messages, including the display name, use case, enabled channels, and enabled countries.
See also: AWS API Documentation
Request Syntax
client.create_notify_configuration(
DisplayName='string',
UseCase='CODE_VERIFICATION',
DefaultTemplateId='string',
PoolId='string',
EnabledCountries=[
'string',
],
EnabledChannels=[
'SMS'|'VOICE'|'MMS'|'RCS',
],
DeletionProtectionEnabled=True|False,
ClientToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The display name to associate with the notify configuration.
string
[REQUIRED]
The use case for the notify configuration.
string
The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
string
The identifier of the pool to associate with the notify configuration.
list
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
(string) --
list
[REQUIRED]
An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
(string) --
boolean
By default this is set to false. When set to true the notify configuration can't be deleted. You can change this value using the UpdateNotifyConfiguration action.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
list
An array of tags (key and value pairs) associated with the notify configuration.
(dict) --
The list of tags to be added to the specified topic.
Key (string) -- [REQUIRED]
The key identifier, or name, of the tag.
Value (string) -- [REQUIRED]
The string value associated with the key of the tag.
dict
Response Syntax
{
'NotifyConfigurationArn': 'string',
'NotifyConfigurationId': 'string',
'DisplayName': 'string',
'UseCase': 'CODE_VERIFICATION',
'DefaultTemplateId': 'string',
'PoolId': 'string',
'EnabledCountries': [
'string',
],
'EnabledChannels': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'Tier': 'BASIC'|'ADVANCED',
'TierUpgradeStatus': 'BASIC'|'PENDING_UPGRADE'|'ADVANCED'|'REJECTED',
'Status': 'PENDING'|'ACTIVE'|'REJECTED'|'REQUIRES_VERIFICATION',
'RejectionReason': 'string',
'DeletionProtectionEnabled': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
NotifyConfigurationArn (string) --
The Amazon Resource Name (ARN) for the notify configuration.
NotifyConfigurationId (string) --
The unique identifier for the notify configuration.
DisplayName (string) --
The display name associated with the notify configuration.
UseCase (string) --
The use case for the notify configuration.
DefaultTemplateId (string) --
The default template identifier associated with the notify configuration.
PoolId (string) --
The identifier of the pool associated with the notify configuration.
EnabledCountries (list) --
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
(string) --
EnabledChannels (list) --
An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
(string) --
Tier (string) --
The tier of the notify configuration.
TierUpgradeStatus (string) --
The tier upgrade status of the notify configuration.
Status (string) --
The current status of the notify configuration.
RejectionReason (string) --
The reason the notify configuration was rejected, if applicable.
DeletionProtectionEnabled (boolean) --
When set to true deletion protection is enabled. By default this is set to false.
Tags (list) --
An array of tags (key and value pairs) associated with the notify configuration.
(dict) --
The list of tags to be added to the specified topic.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value associated with the key of the tag.
CreatedTimestamp (datetime) --
The time when the notify configuration was created, in UNIX epoch time format.
Sends a templated voice message through a notify configuration to a recipient's phone number.
See also: AWS API Documentation
Request Syntax
client.send_notify_voice_message(
NotifyConfigurationId='string',
DestinationPhoneNumber='string',
TemplateId='string',
TemplateVariables={
'string': 'string'
},
VoiceId='AMY'|'ASTRID'|'BIANCA'|'BRIAN'|'CAMILA'|'CARLA'|'CARMEN'|'CELINE'|'CHANTAL'|'CONCHITA'|'CRISTIANO'|'DORA'|'EMMA'|'ENRIQUE'|'EWA'|'FILIZ'|'GERAINT'|'GIORGIO'|'GWYNETH'|'HANS'|'INES'|'IVY'|'JACEK'|'JAN'|'JOANNA'|'JOEY'|'JUSTIN'|'KARL'|'KENDRA'|'KIMBERLY'|'LEA'|'LIV'|'LOTTE'|'LUCIA'|'LUPE'|'MADS'|'MAJA'|'MARLENE'|'MATHIEU'|'MATTHEW'|'MAXIM'|'MIA'|'MIGUEL'|'MIZUKI'|'NAJA'|'NICOLE'|'PENELOPE'|'RAVEENA'|'RICARDO'|'RUBEN'|'RUSSELL'|'SALLI'|'SEOYEON'|'TAKUMI'|'TATYANA'|'VICKI'|'VITORIA'|'ZEINA'|'ZHIYU',
TimeToLive=123,
Context={
'string': 'string'
},
ConfigurationSetName='string',
DryRun=True|False,
MessageFeedbackEnabled=True|False
)
string
[REQUIRED]
The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.
string
[REQUIRED]
The destination phone number in E.164 format.
string
The unique identifier of the template to use for the message.
dict
[REQUIRED]
A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".
(string) --
(string) --
string
The voice ID to use for the voice message.
integer
How long the voice message is valid for, in seconds. By default this is 72 hours.
dict
You can specify custom data in this field. If you do, that data is logged to the event destination.
(string) --
(string) --
string
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
boolean
Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
dict
Response Syntax
{
'MessageId': 'string',
'TemplateId': 'string',
'ResolvedMessageBody': 'string'
}
Response Structure
(dict) --
MessageId (string) --
The unique identifier for the message.
TemplateId (string) --
The unique identifier of the template used for the message.
ResolvedMessageBody (string) --
The message body after template variable substitution has been applied.
Creates a new RCS agent for sending rich messages through the RCS channel. The RCS agent serves as an origination identity for sending RCS messages to your recipients.
See also: AWS API Documentation
Request Syntax
client.create_rcs_agent(
DeletionProtectionEnabled=True|False,
OptOutListName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
boolean
By default this is set to false. When set to true the RCS agent can't be deleted. You can change this value using the UpdateRcsAgent action.
string
The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.
list
An array of tags (key and value pairs) associated with the RCS agent.
(dict) --
The list of tags to be added to the specified topic.
Key (string) -- [REQUIRED]
The key identifier, or name, of the tag.
Value (string) -- [REQUIRED]
The string value associated with the key of the tag.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RcsAgentArn': 'string',
'RcsAgentId': 'string',
'Status': 'CREATED'|'PENDING'|'TESTING'|'PARTIAL'|'ACTIVE'|'DELETED',
'DeletionProtectionEnabled': True|False,
'OptOutListName': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'SelfManagedOptOutsEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'TwoWayEnabled': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
RcsAgentArn (string) --
The Amazon Resource Name (ARN) of the newly created RCS agent.
RcsAgentId (string) --
The unique identifier for the RCS agent.
Status (string) --
The current status of the RCS agent.
DeletionProtectionEnabled (boolean) --
When set to true deletion protection is enabled. By default this is set to false.
OptOutListName (string) --
The name of the OptOutList associated with the RCS agent.
CreatedTimestamp (datetime) --
The time when the RCS agent was created, in UNIX epoch time format.
SelfManagedOptOutsEnabled (boolean) --
By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
TwoWayChannelArn (string) --
The Amazon Resource Name (ARN) of the two way channel.
TwoWayChannelRole (string) --
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
TwoWayEnabled (boolean) --
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Tags (list) --
An array of tags (key and value pairs) associated with the RCS agent.
(dict) --
The list of tags to be added to the specified topic.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value associated with the key of the tag.
Lists countries that support notify messaging. You can optionally filter by channel, use case, or tier.
See also: AWS API Documentation
Request Syntax
client.list_notify_countries(
Channels=[
'SMS'|'VOICE'|'MMS'|'RCS',
],
UseCases=[
'CODE_VERIFICATION',
],
Tier='BASIC'|'ADVANCED',
NextToken='string',
MaxResults=123
)
list
An array of channels to filter the results by.
(string) --
list
An array of use cases to filter the results by.
(string) --
The use case for a notify configuration.
CODE_VERIFICATION - Code verification use case.
string
The tier to filter the results by.
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'NotifyCountries': [
{
'IsoCountryCode': 'string',
'CountryName': 'string',
'SupportedChannels': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'SupportedUseCases': [
'CODE_VERIFICATION',
],
'SupportedTiers': [
'BASIC'|'ADVANCED',
],
'CustomerOwnedIdentityRequired': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NotifyCountries (list) --
An array of NotifyCountryInformation objects that contain the results.
(dict) --
The information for a country that supports notify messaging.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
CountryName (string) --
The name of the country.
SupportedChannels (list) --
An array of supported channels for the country. Supported values include SMS and VOICE.
(string) --
SupportedUseCases (list) --
An array of supported use cases for the country.
(string) --
The use case for a notify configuration.
CODE_VERIFICATION - Code verification use case.
SupportedTiers (list) --
An array of supported tiers for the country.
(string) --
The tier of a notify configuration.
BASIC - Basic tier.
ADVANCED - Advanced tier.
CustomerOwnedIdentityRequired (boolean) --
Whether a customer-owned identity is required to send notify messages to this country.
NextToken (string) --
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Updates an existing notify configuration. You can update the default template, pool association, enabled channels, enabled countries, and deletion protection settings.
See also: AWS API Documentation
Request Syntax
client.update_notify_configuration(
NotifyConfigurationId='string',
DefaultTemplateId='string',
PoolId='string',
EnabledCountries=[
'string',
],
EnabledChannels=[
'SMS'|'VOICE'|'MMS'|'RCS',
],
DeletionProtectionEnabled=True|False
)
string
[REQUIRED]
The identifier of the notify configuration to update. The NotifyConfigurationId can be found using the DescribeNotifyConfigurations operation.
string
The template ID to set as the default, or the special value UNSET_DEFAULT_TEMPLATE to clear the current default template.
string
The pool ID or ARN to associate, or the special value UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool.
list
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
(string) --
list
An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
(string) --
boolean
When set to true the notify configuration can't be deleted.
dict
Response Syntax
{
'NotifyConfigurationArn': 'string',
'NotifyConfigurationId': 'string',
'DisplayName': 'string',
'UseCase': 'CODE_VERIFICATION',
'DefaultTemplateId': 'string',
'PoolId': 'string',
'EnabledCountries': [
'string',
],
'EnabledChannels': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'Tier': 'BASIC'|'ADVANCED',
'TierUpgradeStatus': 'BASIC'|'PENDING_UPGRADE'|'ADVANCED'|'REJECTED',
'Status': 'PENDING'|'ACTIVE'|'REJECTED'|'REQUIRES_VERIFICATION',
'RejectionReason': 'string',
'DeletionProtectionEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
NotifyConfigurationArn (string) --
The Amazon Resource Name (ARN) for the notify configuration.
NotifyConfigurationId (string) --
The unique identifier for the notify configuration.
DisplayName (string) --
The display name associated with the notify configuration.
UseCase (string) --
The use case for the notify configuration.
DefaultTemplateId (string) --
The default template identifier associated with the notify configuration.
PoolId (string) --
The identifier of the pool associated with the notify configuration.
EnabledCountries (list) --
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
(string) --
EnabledChannels (list) --
An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
(string) --
Tier (string) --
The tier of the notify configuration.
TierUpgradeStatus (string) --
The tier upgrade status of the notify configuration.
Status (string) --
The current status of the notify configuration.
RejectionReason (string) --
The reason the notify configuration was rejected, if applicable.
DeletionProtectionEnabled (boolean) --
When set to true deletion protection is enabled. By default this is set to false.
CreatedTimestamp (datetime) --
The time when the notify configuration was created, in UNIX epoch time format.
Retrieves the per-country launch status of an RCS agent, including carrier-level details for each country.
See also: AWS API Documentation
Request Syntax
client.describe_rcs_agent_country_launch_status(
RcsAgentId='string',
IsoCountryCodes=[
'string',
],
Filters=[
{
'Name': 'country-launch-status',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier of the RCS agent. You can use either the RcsAgentId or RcsAgentArn.
list
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, to filter the results.
(string) --
list
An array of CountryLaunchStatusFilter objects to filter the results.
(dict) --
The information for a country launch status that meets a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array values to filter for.
(string) --
integer
The maximum number of results to return per each request.
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
dict
Response Syntax
{
'RcsAgentId': 'string',
'RcsAgentArn': 'string',
'CountryLaunchStatus': [
{
'IsoCountryCode': 'string',
'Status': 'CREATED'|'PENDING'|'PARTIAL'|'ACTIVE'|'REJECTED',
'RcsPlatformId': 'string',
'RegistrationId': 'string',
'CarrierStatus': [
{
'CarrierName': 'string',
'Status': 'PENDING'|'ACTIVE'|'REJECTED'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RcsAgentId (string) --
The unique identifier for the RCS agent.
RcsAgentArn (string) --
The Amazon Resource Name (ARN) of the RCS agent.
CountryLaunchStatus (list) --
An array of CountryLaunchStatusInformation objects that contain the per-country launch status details.
(dict) --
Contains per-country launch status details for an RCS agent.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
Status (string) --
The launch status for this country.
RcsPlatformId (string) --
The RCS platform identifier for this country.
RegistrationId (string) --
The unique identifier of the registration associated with this country launch.
CarrierStatus (list) --
An array of CarrierStatusInformation objects containing carrier-level launch status details.
(dict) --
Contains carrier-level launch status details for an RCS agent within a country.
CarrierName (string) --
The name of the carrier.
Status (string) --
The launch status for this carrier.
NextToken (string) --
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Updates the configuration of an existing RCS agent. You can update the opt-out list, deletion protection, two-way messaging settings, and self-managed opt-outs configuration.
See also: AWS API Documentation
Request Syntax
client.update_rcs_agent(
RcsAgentId='string',
DeletionProtectionEnabled=True|False,
OptOutListName='string',
SelfManagedOptOutsEnabled=True|False,
TwoWayChannelArn='string',
TwoWayChannelRole='string',
TwoWayEnabled=True|False
)
string
[REQUIRED]
The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.
boolean
By default this is set to false. When set to true the RCS agent can't be deleted.
string
The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.
boolean
By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
string
The Amazon Resource Name (ARN) of the two way channel.
string
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
dict
Response Syntax
{
'RcsAgentArn': 'string',
'RcsAgentId': 'string',
'Status': 'CREATED'|'PENDING'|'TESTING'|'PARTIAL'|'ACTIVE'|'DELETED',
'CreatedTimestamp': datetime(2015, 1, 1),
'DeletionProtectionEnabled': True|False,
'OptOutListName': 'string',
'SelfManagedOptOutsEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'TwoWayEnabled': True|False
}
Response Structure
(dict) --
RcsAgentArn (string) --
The Amazon Resource Name (ARN) of the updated RCS agent.
RcsAgentId (string) --
The unique identifier for the RCS agent.
Status (string) --
The current status of the RCS agent.
CreatedTimestamp (datetime) --
The time when the RCS agent was created, in UNIX epoch time format.
DeletionProtectionEnabled (boolean) --
When set to true deletion protection is enabled. By default this is set to false.
OptOutListName (string) --
The name of the OptOutList associated with the RCS agent.
SelfManagedOptOutsEnabled (boolean) --
By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
TwoWayChannelArn (string) --
The Amazon Resource Name (ARN) of the two way channel.
TwoWayChannelRole (string) --
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
TwoWayEnabled (boolean) --
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Sets an account level monthly spend limit override for sending notify messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
See also: AWS API Documentation
Request Syntax
client.set_notify_message_spend_limit_override(
MonthlyLimit=123
)
integer
[REQUIRED]
The new monthly limit to enforce on notify messages.
dict
Response Syntax
{
'MonthlyLimit': 123
}
Response Structure
(dict) --
MonthlyLimit (integer) --
The current monthly limit, in US dollars.
Deletes an existing notify configuration.
If deletion protection is enabled, an error is returned.
See also: AWS API Documentation
Request Syntax
client.delete_notify_configuration(
NotifyConfigurationId='string'
)
string
[REQUIRED]
The identifier of the notify configuration to delete. The NotifyConfigurationId can be found using the DescribeNotifyConfigurations operation.
dict
Response Syntax
{
'NotifyConfigurationArn': 'string',
'NotifyConfigurationId': 'string',
'DisplayName': 'string',
'UseCase': 'CODE_VERIFICATION',
'DefaultTemplateId': 'string',
'PoolId': 'string',
'EnabledCountries': [
'string',
],
'EnabledChannels': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'Tier': 'BASIC'|'ADVANCED',
'TierUpgradeStatus': 'BASIC'|'PENDING_UPGRADE'|'ADVANCED'|'REJECTED',
'Status': 'PENDING'|'ACTIVE'|'REJECTED'|'REQUIRES_VERIFICATION',
'RejectionReason': 'string',
'DeletionProtectionEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
NotifyConfigurationArn (string) --
The Amazon Resource Name (ARN) for the notify configuration.
NotifyConfigurationId (string) --
The unique identifier for the notify configuration.
DisplayName (string) --
The display name associated with the notify configuration.
UseCase (string) --
The use case for the notify configuration.
DefaultTemplateId (string) --
The default template identifier associated with the notify configuration.
PoolId (string) --
The identifier of the pool associated with the notify configuration.
EnabledCountries (list) --
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
(string) --
EnabledChannels (list) --
An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
(string) --
Tier (string) --
The tier of the notify configuration.
TierUpgradeStatus (string) --
The tier upgrade status of the notify configuration.
Status (string) --
The current status of the notify configuration.
RejectionReason (string) --
The reason the notify configuration was rejected, if applicable.
DeletionProtectionEnabled (boolean) --
When set to true deletion protection is enabled. By default this is set to false.
CreatedTimestamp (datetime) --
The time when the notify configuration was created, in UNIX epoch time format.
Deletes an existing RCS agent. If deletion protection is enabled, an error is returned.
See also: AWS API Documentation
Request Syntax
client.delete_rcs_agent(
RcsAgentId='string'
)
string
[REQUIRED]
The unique identifier of the RCS agent to delete. You can use either the RcsAgentId or RcsAgentArn.
dict
Response Syntax
{
'RcsAgentArn': 'string',
'RcsAgentId': 'string',
'Status': 'CREATED'|'PENDING'|'TESTING'|'PARTIAL'|'ACTIVE'|'DELETED',
'CreatedTimestamp': datetime(2015, 1, 1),
'DeletionProtectionEnabled': True|False,
'OptOutListName': 'string',
'SelfManagedOptOutsEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'TwoWayEnabled': True|False
}
Response Structure
(dict) --
RcsAgentArn (string) --
The Amazon Resource Name (ARN) of the deleted RCS agent.
RcsAgentId (string) --
The unique identifier for the deleted RCS agent.
Status (string) --
The current status of the RCS agent.
CreatedTimestamp (datetime) --
The time when the RCS agent was created, in UNIX epoch time format.
DeletionProtectionEnabled (boolean) --
When set to true deletion protection is enabled. By default this is set to false.
OptOutListName (string) --
The name of the OptOutList that was associated with the deleted RCS agent.
SelfManagedOptOutsEnabled (boolean) --
By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
TwoWayChannelArn (string) --
The Amazon Resource Name (ARN) of the two way channel.
TwoWayChannelRole (string) --
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
TwoWayEnabled (boolean) --
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
Deletes an account-level monthly spending limit override for sending notify 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 End User Messaging SMS User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_notify_message_spend_limit_override()
dict
Response Syntax
{
'MonthlyLimit': 123
}
Response Structure
(dict) --
MonthlyLimit (integer) --
The current monthly limit, in US dollars.
Sends a templated text message through a notify configuration to a recipient's phone number.
See also: AWS API Documentation
Request Syntax
client.send_notify_text_message(
NotifyConfigurationId='string',
DestinationPhoneNumber='string',
TemplateId='string',
TemplateVariables={
'string': 'string'
},
TimeToLive=123,
Context={
'string': 'string'
},
ConfigurationSetName='string',
DryRun=True|False,
MessageFeedbackEnabled=True|False
)
string
[REQUIRED]
The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.
string
[REQUIRED]
The destination phone number in E.164 format.
string
The unique identifier of the template to use for the message.
dict
[REQUIRED]
A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".
(string) --
(string) --
integer
How long the text message is valid for, in seconds. By default this is 72 hours.
dict
You can specify custom data in this field. If you do, that data is logged to the event destination.
(string) --
(string) --
string
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
boolean
Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
dict
Response Syntax
{
'MessageId': 'string',
'TemplateId': 'string',
'ResolvedMessageBody': 'string'
}
Response Structure
(dict) --
MessageId (string) --
The unique identifier for the message.
TemplateId (string) --
The unique identifier of the template used for the message.
ResolvedMessageBody (string) --
The message body after template variable substitution has been applied.
{'RegistrationVersionStatus': {'REQUIRES_OFFLINE_REVIEW'}}
Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.
See also: AWS API Documentation
Request Syntax
client.create_registration_version(
RegistrationId='string'
)
string
[REQUIRED]
The unique identifier for the registration.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'VersionNumber': 123,
'RegistrationVersionStatus': 'DRAFT'|'SUBMITTED'|'AWS_REVIEWING'|'REVIEWING'|'REQUIRES_AUTHENTICATION'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED'|'REQUIRES_OFFLINE_REVIEW',
'RegistrationVersionStatusHistory': {
'DraftTimestamp': datetime(2015, 1, 1),
'SubmittedTimestamp': datetime(2015, 1, 1),
'AwsReviewingTimestamp': datetime(2015, 1, 1),
'ReviewingTimestamp': datetime(2015, 1, 1),
'RequiresAuthenticationTimestamp': datetime(2015, 1, 1),
'ApprovedTimestamp': datetime(2015, 1, 1),
'DiscardedTimestamp': datetime(2015, 1, 1),
'DeniedTimestamp': datetime(2015, 1, 1),
'RevokedTimestamp': datetime(2015, 1, 1),
'ArchivedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
RegistrationArn (string) --
The Amazon Resource Name (ARN) for the registration.
RegistrationId (string) --
The unique identifier for the registration.
VersionNumber (integer) --
The new version number of the registration.
RegistrationVersionStatus (string) --
The status of the registration.
APPROVED: Your registration has been approved.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
DENIED: You must fix your registration and resubmit it.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DRAFT: The initial status of a registration version after it’s created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REVIEWING: Your registration has been accepted and is being reviewed.
REVOKED: Your previously approved registration has been revoked.
SUBMITTED: Your registration has been submitted.
RegistrationVersionStatusHistory (dict) --
A RegistrationVersionStatusHistory object that contains timestamps for the registration.
DraftTimestamp (datetime) --
The time when the registration was in the draft state, in UNIX epoch time format.
SubmittedTimestamp (datetime) --
The time when the registration was in the submitted state, in UNIX epoch time format.
AwsReviewingTimestamp (datetime) --
The time when the registration was in the AWS reviewing state, in UNIX epoch time format.
ReviewingTimestamp (datetime) --
The time when the registration was in the reviewing state, in UNIX epoch time format.
RequiresAuthenticationTimestamp (datetime) --
The time when the registration was in the requires authentication state, in UNIX epoch time format.
ApprovedTimestamp (datetime) --
The time when the registration was in the approved state, in UNIX epoch time format.
DiscardedTimestamp (datetime) --
The time when the registration was in the discarded state, in UNIX epoch time format.
DeniedTimestamp (datetime) --
The time when the registration was in the denied state, in UNIX epoch time format.
RevokedTimestamp (datetime) --
The time when the registration was in the revoked state, in UNIX epoch time format.
ArchivedTimestamp (datetime) --
The time when the registration was in the archived state, in UNIX epoch time format.
{'RcsAgentId': 'string'}
Response {'RcsAgentId': 'string', 'Status': {'UNSUPPORTED'}}
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.
See also: AWS API Documentation
Request Syntax
client.create_verified_destination_number(
DestinationPhoneNumber='string',
RcsAgentId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The verified destination phone number, in E.164 format.
string
The unique identifier of the RCS agent to associate with the verified destination number. You can use either the RcsAgentId or RcsAgentArn.
list
An array of tags (key and value pairs) to associate with the destination number.
(dict) --
The list of tags to be added to the specified topic.
Key (string) -- [REQUIRED]
The key identifier, or name, of the tag.
Value (string) -- [REQUIRED]
The string value associated with the key of the tag.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'VerifiedDestinationNumberArn': 'string',
'VerifiedDestinationNumberId': 'string',
'DestinationPhoneNumber': 'string',
'Status': 'PENDING'|'VERIFIED'|'UNSUPPORTED',
'RcsAgentId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
VerifiedDestinationNumberArn (string) --
The Amazon Resource Name (ARN) for the verified destination phone number.
VerifiedDestinationNumberId (string) --
The unique identifier for the verified destination phone number.
DestinationPhoneNumber (string) --
The verified destination phone number, in E.164 format.
Status (string) --
The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.
VERIFIED: The phone number is verified and can receive messages.
RcsAgentId (string) --
The unique identifier of the RCS agent associated with the verified destination number.
Tags (list) --
An array of tags (key and value pairs) to associate with the destination number.
(dict) --
The list of tags to be added to the specified topic.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value associated with the key of the tag.
CreatedTimestamp (datetime) --
The time when the verified phone number was created, in UNIX epoch time format.
{'PhoneNumbers': {'NumberCapabilities': {'RCS'}}}
Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an error is returned.
See also: AWS API Documentation
Request Syntax
client.describe_phone_numbers(
PhoneNumberIds=[
'string',
],
Filters=[
{
'Name': 'status'|'iso-country-code'|'message-type'|'number-capability'|'number-type'|'two-way-enabled'|'self-managed-opt-outs-enabled'|'opt-out-list-name'|'deletion-protection-enabled'|'two-way-channel-arn',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123,
Owner='SELF'|'SHARED'
)
list
The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
(string) --
list
An array of PhoneNumberFilter objects to filter the results.
(dict) --
The information for a phone number that meets a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array values to filter for.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
string
Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
dict
Response Syntax
{
'PhoneNumbers': [
{
'PhoneNumberArn': 'string',
'PhoneNumberId': 'string',
'PhoneNumber': 'string',
'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
'IsoCountryCode': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'NumberCapabilities': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
'MonthlyLeasingPrice': 'string',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'InternationalSendingEnabled': True|False,
'DeletionProtectionEnabled': True|False,
'PoolId': 'string',
'RegistrationId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PhoneNumbers (list) --
An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
(dict) --
The information for a phone number, in E.164 format, in an Amazon Web Services account.
PhoneNumberArn (string) --
The Amazon Resource Name (ARN) associated with the phone number.
PhoneNumberId (string) --
The unique identifier for the phone number.
PhoneNumber (string) --
The phone number in E.164 format.
Status (string) --
The current status of the phone number.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageType (string) --
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
NumberCapabilities (list) --
Describes if the origination identity can be used for text messages, voice calls or both.
(string) --
NumberType (string) --
The type of phone number.
MonthlyLeasingPrice (string) --
The price, in US dollars, to lease the phone number.
TwoWayEnabled (boolean) --
By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
TwoWayChannelArn (string) --
The Amazon Resource Name (ARN) of the two way channel.
TwoWayChannelRole (string) --
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
SelfManagedOptOutsEnabled (boolean) --
When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
OptOutListName (string) --
The name of the OptOutList associated with the phone number.
InternationalSendingEnabled (boolean) --
When set to true the international sending of phone number is Enabled.
DeletionProtectionEnabled (boolean) --
When set to true the phone number can't be deleted.
PoolId (string) --
The unique identifier of the pool associated with the phone number.
RegistrationId (string) --
The unique identifier for the registration.
CreatedTimestamp (datetime) --
The time when the phone number was created, in UNIX epoch time format.
NextToken (string) --
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
{'RegistrationAttachments': {'AttachmentUrl': 'string'}}
Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.describe_registration_attachments(
RegistrationAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'attachment-status',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
(string) --
list
An array of RegistrationAttachmentFilter objects to filter the results.
(dict) --
The filter definition for filtering registration attachments that meets a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array of values to filter on.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'RegistrationAttachments': [
{
'RegistrationAttachmentArn': 'string',
'RegistrationAttachmentId': 'string',
'AttachmentStatus': 'UPLOAD_IN_PROGRESS'|'UPLOAD_COMPLETE'|'UPLOAD_FAILED'|'DELETED',
'AttachmentUploadErrorReason': 'INTERNAL_ERROR',
'CreatedTimestamp': datetime(2015, 1, 1),
'AttachmentUrl': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationAttachments (list) --
An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
(dict) --
Provides information on the specified registration attachments.
RegistrationAttachmentArn (string) --
The Amazon Resource Name (ARN) for the registration attachment.
RegistrationAttachmentId (string) --
The unique identifier for the registration attachment.
AttachmentStatus (string) --
The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.
UPLOAD_COMPLETE The attachment has been uploaded.
UPLOAD_FAILED The attachment failed to uploaded.
DELETED The attachment has been deleted..
AttachmentUploadErrorReason (string) --
A description of why the upload didn't successfully complete.
CreatedTimestamp (datetime) --
The time when the registration attachment was created, in UNIX epoch time format.
AttachmentUrl (string) --
The URL to the document that's associated with the registration attachment.
NextToken (string) --
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
{'RegistrationVersions': {'RegistrationVersionStatus': {'REQUIRES_OFFLINE_REVIEW'}}}
Retrieves the specified registration version.
See also: AWS API Documentation
Request Syntax
client.describe_registration_versions(
RegistrationId='string',
VersionNumbers=[
123,
],
Filters=[
{
'Name': 'registration-version-status',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the registration.
list
An array of registration version numbers.
(integer) --
list
An array of RegistrationVersionFilter objects to filter the results.
(dict) --
The filter definition for filtering registration versions that meets a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array of values to filter on.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'RegistrationVersions': [
{
'VersionNumber': 123,
'RegistrationVersionStatus': 'DRAFT'|'SUBMITTED'|'AWS_REVIEWING'|'REVIEWING'|'REQUIRES_AUTHENTICATION'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED'|'REQUIRES_OFFLINE_REVIEW',
'RegistrationVersionStatusHistory': {
'DraftTimestamp': datetime(2015, 1, 1),
'SubmittedTimestamp': datetime(2015, 1, 1),
'AwsReviewingTimestamp': datetime(2015, 1, 1),
'ReviewingTimestamp': datetime(2015, 1, 1),
'RequiresAuthenticationTimestamp': datetime(2015, 1, 1),
'ApprovedTimestamp': datetime(2015, 1, 1),
'DiscardedTimestamp': datetime(2015, 1, 1),
'DeniedTimestamp': datetime(2015, 1, 1),
'RevokedTimestamp': datetime(2015, 1, 1),
'ArchivedTimestamp': datetime(2015, 1, 1)
},
'DeniedReasons': [
{
'Reason': 'string',
'ShortDescription': 'string',
'LongDescription': 'string',
'DocumentationTitle': 'string',
'DocumentationLink': 'string'
},
],
'Feedback': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationArn (string) --
The Amazon Resource Name (ARN) for the registration.
RegistrationId (string) --
The unique identifier for the registration.
RegistrationVersions (list) --
An array of RegistrationVersions objects.
(dict) --
Provides information about the specified version of the registration.
VersionNumber (integer) --
The version number of the registration.
RegistrationVersionStatus (string) --
The status of the registration.
APPROVED: Your registration has been approved.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
DENIED: You must fix your registration and resubmit it.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DRAFT: The initial status of a registration version after it’s created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REVIEWING: Your registration has been accepted and is being reviewed.
REVOKED: Your previously approved registration has been revoked.
SUBMITTED: Your registration has been submitted.
RegistrationVersionStatusHistory (dict) --
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
DraftTimestamp (datetime) --
The time when the registration was in the draft state, in UNIX epoch time format.
SubmittedTimestamp (datetime) --
The time when the registration was in the submitted state, in UNIX epoch time format.
AwsReviewingTimestamp (datetime) --
The time when the registration was in the AWS reviewing state, in UNIX epoch time format.
ReviewingTimestamp (datetime) --
The time when the registration was in the reviewing state, in UNIX epoch time format.
RequiresAuthenticationTimestamp (datetime) --
The time when the registration was in the requires authentication state, in UNIX epoch time format.
ApprovedTimestamp (datetime) --
The time when the registration was in the approved state, in UNIX epoch time format.
DiscardedTimestamp (datetime) --
The time when the registration was in the discarded state, in UNIX epoch time format.
DeniedTimestamp (datetime) --
The time when the registration was in the denied state, in UNIX epoch time format.
RevokedTimestamp (datetime) --
The time when the registration was in the revoked state, in UNIX epoch time format.
ArchivedTimestamp (datetime) --
The time when the registration was in the archived state, in UNIX epoch time format.
DeniedReasons (list) --
An array of RegistrationDeniedReasonInformation objects.
(dict) --
Provides the reason a registration was rejected.
Reason (string) --
The reason a registration was rejected.
ShortDescription (string) --
A short description of the rejection reason.
LongDescription (string) --
A long description of the rejection reason.
DocumentationTitle (string) --
The title of the document.
DocumentationLink (string) --
The link to the document.
Feedback (string) --
Generative AI feedback information provided during the registration review process. This includes comments, suggestions, or additional requirements.
NextToken (string) --
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
{'SpendLimits': {'Name': {'NOTIFY_MESSAGE_MONTHLY_SPEND_LIMIT'}}}
Describes the current monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS, MMS, or Voice spending quota in the End User Messaging SMS User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_spend_limits(
NextToken='string',
MaxResults=123
)
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'SpendLimits': [
{
'Name': 'TEXT_MESSAGE_MONTHLY_SPEND_LIMIT'|'VOICE_MESSAGE_MONTHLY_SPEND_LIMIT'|'MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT'|'NOTIFY_MESSAGE_MONTHLY_SPEND_LIMIT',
'EnforcedLimit': 123,
'MaxLimit': 123,
'Overridden': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SpendLimits (list) --
An array of SpendLimit objects that contain the details for the requested spend limits.
(dict) --
Describes the current monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting a spending quota increase in the End User Messaging SMS User Guide.
Name (string) --
The name for the SpendLimit.
EnforcedLimit (integer) --
The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.
MaxLimit (integer) --
The maximum amount of money that you are able to spend to send messages each month, in US dollars.
Overridden (boolean) --
When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.
NextToken (string) --
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
{'Filters': {'Name': {'rcs-agent-id'}}}
Response {'VerifiedDestinationNumbers': {'RcsAgentId': 'string',
'Status': {'UNSUPPORTED'}}}
Retrieves the specified verified destination numbers.
See also: AWS API Documentation
Request Syntax
client.describe_verified_destination_numbers(
VerifiedDestinationNumberIds=[
'string',
],
DestinationPhoneNumbers=[
'string',
],
Filters=[
{
'Name': 'status'|'rcs-agent-id',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of VerifiedDestinationNumberid to retrieve.
(string) --
list
An array of verified destination phone number, in E.164 format.
(string) --
list
An array of VerifiedDestinationNumberFilter objects to filter the results.
(dict) --
The filter definition for filtering verified destination phone numbers that meets a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array of values to filter on.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'VerifiedDestinationNumbers': [
{
'VerifiedDestinationNumberArn': 'string',
'VerifiedDestinationNumberId': 'string',
'DestinationPhoneNumber': 'string',
'Status': 'PENDING'|'VERIFIED'|'UNSUPPORTED',
'RcsAgentId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VerifiedDestinationNumbers (list) --
An array of VerifiedDestinationNumberInformation objects
(dict) --
Provides information about the requested verified destintion phone number.
VerifiedDestinationNumberArn (string) --
The Amazon Resource Name (ARN) for the verified destination phone number.
VerifiedDestinationNumberId (string) --
The unique identifier for the verified destination phone number.
DestinationPhoneNumber (string) --
The verified destination phone number, in E.164 format.
Status (string) --
The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.
VERIFIED: The phone number is verified and can receive messages.
RcsAgentId (string) --
The unique identifier of the RCS agent associated with the verified destination number.
CreatedTimestamp (datetime) --
The time when the destination phone number was created, in UNIX epoch time format.
NextToken (string) --
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
{'RegistrationVersionStatus': {'REQUIRES_OFFLINE_REVIEW'}}
Discard the current version of the registration.
See also: AWS API Documentation
Request Syntax
client.discard_registration_version(
RegistrationId='string'
)
string
[REQUIRED]
The unique identifier for the registration.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'VersionNumber': 123,
'RegistrationVersionStatus': 'DRAFT'|'SUBMITTED'|'AWS_REVIEWING'|'REVIEWING'|'REQUIRES_AUTHENTICATION'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED'|'REQUIRES_OFFLINE_REVIEW',
'RegistrationVersionStatusHistory': {
'DraftTimestamp': datetime(2015, 1, 1),
'SubmittedTimestamp': datetime(2015, 1, 1),
'AwsReviewingTimestamp': datetime(2015, 1, 1),
'ReviewingTimestamp': datetime(2015, 1, 1),
'RequiresAuthenticationTimestamp': datetime(2015, 1, 1),
'ApprovedTimestamp': datetime(2015, 1, 1),
'DiscardedTimestamp': datetime(2015, 1, 1),
'DeniedTimestamp': datetime(2015, 1, 1),
'RevokedTimestamp': datetime(2015, 1, 1),
'ArchivedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
RegistrationArn (string) --
The Amazon Resource Name (ARN) for the registration.
RegistrationId (string) --
The unique identifier for the registration.
VersionNumber (integer) --
The version number of the registration.
RegistrationVersionStatus (string) --
The status of the registration version.
APPROVED: Your registration has been approved.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
DENIED: You must fix your registration and resubmit it.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DRAFT: The initial status of a registration version after it’s created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REVIEWING: Your registration has been accepted and is being reviewed.
REVOKED: Your previously approved registration has been revoked.
SUBMITTED: Your registration has been submitted.
RegistrationVersionStatusHistory (dict) --
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
DraftTimestamp (datetime) --
The time when the registration was in the draft state, in UNIX epoch time format.
SubmittedTimestamp (datetime) --
The time when the registration was in the submitted state, in UNIX epoch time format.
AwsReviewingTimestamp (datetime) --
The time when the registration was in the AWS reviewing state, in UNIX epoch time format.
ReviewingTimestamp (datetime) --
The time when the registration was in the reviewing state, in UNIX epoch time format.
RequiresAuthenticationTimestamp (datetime) --
The time when the registration was in the requires authentication state, in UNIX epoch time format.
ApprovedTimestamp (datetime) --
The time when the registration was in the approved state, in UNIX epoch time format.
DiscardedTimestamp (datetime) --
The time when the registration was in the discarded state, in UNIX epoch time format.
DeniedTimestamp (datetime) --
The time when the registration was in the denied state, in UNIX epoch time format.
RevokedTimestamp (datetime) --
The time when the registration was in the revoked state, in UNIX epoch time format.
ArchivedTimestamp (datetime) --
The time when the registration was in the archived state, in UNIX epoch time format.
{'NumberCapability': {'RCS'}}
Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
See also: AWS API Documentation
Request Syntax
client.get_protect_configuration_country_rule_set(
ProtectConfigurationId='string',
NumberCapability='SMS'|'VOICE'|'MMS'|'RCS'
)
string
[REQUIRED]
The unique identifier for the protect configuration.
string
[REQUIRED]
The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.
dict
Response Syntax
{
'ProtectConfigurationArn': 'string',
'ProtectConfigurationId': 'string',
'NumberCapability': 'SMS'|'VOICE'|'MMS'|'RCS',
'CountryRuleSet': {
'string': {
'ProtectStatus': 'ALLOW'|'BLOCK'|'MONITOR'|'FILTER'
}
}
}
Response Structure
(dict) --
ProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the protect configuration.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
NumberCapability (string) --
The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.
CountryRuleSet (dict) --
A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the End User Messaging SMS User Guide.
(string) --
(dict) --
The types of statuses that can be used.
ProtectStatus (string) --
The types of protection that can be used.
{'OriginationIdentities': {'NumberCapabilities': {'RCS'}}}
Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
See also: AWS API Documentation
Request Syntax
client.list_pool_origination_identities(
PoolId='string',
Filters=[
{
'Name': 'iso-country-code'|'number-capability',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the pool. This value can be either the PoolId or PoolArn.
list
An array of PoolOriginationIdentitiesFilter objects to filter the results..
(dict) --
Information about origination identities associated with a pool that meets a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array values to filter for.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'PoolArn': 'string',
'PoolId': 'string',
'OriginationIdentities': [
{
'OriginationIdentityArn': 'string',
'OriginationIdentity': 'string',
'IsoCountryCode': 'string',
'NumberCapabilities': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'PhoneNumber': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PoolArn (string) --
The Amazon Resource Name (ARN) for the pool.
PoolId (string) --
The unique PoolId of the pool.
OriginationIdentities (list) --
An array of any OriginationIdentityMetadata objects.
(dict) --
The metadata for an origination identity associated with a pool.
OriginationIdentityArn (string) --
The Amazon Resource Name (ARN) associated with the origination identity.
OriginationIdentity (string) --
The unique identifier of the origination identity.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. This field is optional and may not be present for origination identity types that are not country-specific, such as RCS agents.
NumberCapabilities (list) --
Describes if the origination identity can be used for text messages, voice calls or both.
(string) --
PhoneNumber (string) --
The phone number in E.164 format.
NextToken (string) --
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
{'NumberCapabilities': {'RCS'}}
Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
See also: AWS API Documentation
Request Syntax
client.release_phone_number(
PhoneNumberId='string'
)
string
[REQUIRED]
The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
dict
Response Syntax
{
'PhoneNumberArn': 'string',
'PhoneNumberId': 'string',
'PhoneNumber': 'string',
'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
'IsoCountryCode': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'NumberCapabilities': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
'MonthlyLeasingPrice': 'string',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'RegistrationId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
PhoneNumberArn (string) --
The PhoneNumberArn of the phone number that was released.
PhoneNumberId (string) --
The PhoneNumberId of the phone number that was released.
PhoneNumber (string) --
The phone number that was released.
Status (string) --
The current status of the request.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageType (string) --
The message type that was associated with the phone number.
NumberCapabilities (list) --
Specifies if the number could be used for text messages, voice, or both.
(string) --
NumberType (string) --
The type of number that was released.
MonthlyLeasingPrice (string) --
The monthly price of the phone number, in US dollars.
TwoWayEnabled (boolean) --
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
TwoWayChannelArn (string) --
The Amazon Resource Name (ARN) of the TwoWayChannel.
TwoWayChannelRole (string) --
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
SelfManagedOptOutsEnabled (boolean) --
By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
OptOutListName (string) --
The name of the OptOutList that was associated with the phone number.
RegistrationId (string) --
The unique identifier for the registration.
CreatedTimestamp (datetime) --
The time when the phone number was created, in UNIX epoch time format.
{'NumberCapabilities': {'RCS'}}
Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the End User Messaging SMS User Guide.
See also: AWS API Documentation
Request Syntax
client.request_phone_number(
IsoCountryCode='string',
MessageType='TRANSACTIONAL'|'PROMOTIONAL',
NumberCapabilities=[
'SMS'|'VOICE'|'MMS'|'RCS',
],
NumberType='LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
OptOutListName='string',
PoolId='string',
RegistrationId='string',
InternationalSendingEnabled=True|False,
DeletionProtectionEnabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
string
[REQUIRED]
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
list
[REQUIRED]
Indicates if the phone number will be used for text messages, voice messages, or both.
(string) --
string
[REQUIRED]
The type of phone number to request.
When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL.
string
The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
string
The pool to associated with the phone number. You can use the PoolId or PoolArn.
string
Use this field to attach your phone number for an external registration process.
boolean
By default this is set to false. When set to true the international sending of phone number is Enabled.
boolean
By default this is set to false. When set to true the phone number can't be deleted.
list
An array of tags (key and value pairs) to associate with the requested phone number.
(dict) --
The list of tags to be added to the specified topic.
Key (string) -- [REQUIRED]
The key identifier, or name, of the tag.
Value (string) -- [REQUIRED]
The string value associated with the key of the tag.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'PhoneNumberArn': 'string',
'PhoneNumberId': 'string',
'PhoneNumber': 'string',
'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
'IsoCountryCode': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'NumberCapabilities': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'NumberType': 'LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
'MonthlyLeasingPrice': 'string',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'InternationalSendingEnabled': True|False,
'DeletionProtectionEnabled': True|False,
'PoolId': 'string',
'RegistrationId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
PhoneNumberArn (string) --
The Amazon Resource Name (ARN) of the requested phone number.
PhoneNumberId (string) --
The unique identifier of the new phone number.
PhoneNumber (string) --
The new phone number that was requested.
Status (string) --
The current status of the request.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageType (string) --
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
NumberCapabilities (list) --
Indicates if the phone number will be used for text messages, voice messages or both.
(string) --
NumberType (string) --
The type of number that was released.
MonthlyLeasingPrice (string) --
The monthly price, in US dollars, to lease the phone number.
TwoWayEnabled (boolean) --
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
TwoWayChannelArn (string) --
The ARN used to identify the two way channel.
TwoWayChannelRole (string) --
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
SelfManagedOptOutsEnabled (boolean) --
By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
OptOutListName (string) --
The name of the OptOutList that is associated with the requested phone number.
InternationalSendingEnabled (boolean) --
By default this is set to false. When set to true the international sending of phone number is Enabled.
DeletionProtectionEnabled (boolean) --
By default this is set to false. When set to true the phone number can't be deleted.
PoolId (string) --
The unique identifier of the pool associated with the phone number
RegistrationId (string) --
The unique identifier for the registration.
Tags (list) --
An array of key and value pair tags that are associated with the phone number.
(dict) --
The list of tags to be added to the specified topic.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value associated with the key of the tag.
CreatedTimestamp (datetime) --
The time when the phone number was created, in UNIX epoch time format.
{'RegistrationVersionStatus': {'REQUIRES_OFFLINE_REVIEW'}}
Submit the specified registration for review and approval.
See also: AWS API Documentation
Request Syntax
client.submit_registration_version(
RegistrationId='string',
AwsReview=True|False
)
string
[REQUIRED]
The unique identifier for the registration.
boolean
Set to true to request AWS review of the registration. When enabled, AWS will perform additional validation and review of the registration submission before processing.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'VersionNumber': 123,
'RegistrationVersionStatus': 'DRAFT'|'SUBMITTED'|'AWS_REVIEWING'|'REVIEWING'|'REQUIRES_AUTHENTICATION'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED'|'REQUIRES_OFFLINE_REVIEW',
'RegistrationVersionStatusHistory': {
'DraftTimestamp': datetime(2015, 1, 1),
'SubmittedTimestamp': datetime(2015, 1, 1),
'AwsReviewingTimestamp': datetime(2015, 1, 1),
'ReviewingTimestamp': datetime(2015, 1, 1),
'RequiresAuthenticationTimestamp': datetime(2015, 1, 1),
'ApprovedTimestamp': datetime(2015, 1, 1),
'DiscardedTimestamp': datetime(2015, 1, 1),
'DeniedTimestamp': datetime(2015, 1, 1),
'RevokedTimestamp': datetime(2015, 1, 1),
'ArchivedTimestamp': datetime(2015, 1, 1)
},
'AwsReview': True|False
}
Response Structure
(dict) --
RegistrationArn (string) --
The Amazon Resource Name (ARN) for the registration.
RegistrationId (string) --
The unique identifier for the registration.
VersionNumber (integer) --
The version number of the registration.
RegistrationVersionStatus (string) --
The status of the registration version.
APPROVED: Your registration has been approved.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
DENIED: You must fix your registration and resubmit it.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DRAFT: The initial status of a registration version after it’s created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REVIEWING: Your registration has been accepted and is being reviewed.
REVOKED: Your previously approved registration has been revoked.
SUBMITTED: Your registration has been submitted.
RegistrationVersionStatusHistory (dict) --
The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
DraftTimestamp (datetime) --
The time when the registration was in the draft state, in UNIX epoch time format.
SubmittedTimestamp (datetime) --
The time when the registration was in the submitted state, in UNIX epoch time format.
AwsReviewingTimestamp (datetime) --
The time when the registration was in the AWS reviewing state, in UNIX epoch time format.
ReviewingTimestamp (datetime) --
The time when the registration was in the reviewing state, in UNIX epoch time format.
RequiresAuthenticationTimestamp (datetime) --
The time when the registration was in the requires authentication state, in UNIX epoch time format.
ApprovedTimestamp (datetime) --
The time when the registration was in the approved state, in UNIX epoch time format.
DiscardedTimestamp (datetime) --
The time when the registration was in the discarded state, in UNIX epoch time format.
DeniedTimestamp (datetime) --
The time when the registration was in the denied state, in UNIX epoch time format.
RevokedTimestamp (datetime) --
The time when the registration was in the revoked state, in UNIX epoch time format.
ArchivedTimestamp (datetime) --
The time when the registration was in the archived state, in UNIX epoch time format.
AwsReview (boolean) --
Indicates whether AWS review was requested for this registration submission.
{'NumberCapabilities': {'RCS'}}
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.
If the origination phone number is associated with a pool, an error is returned.
See also: AWS API Documentation
Request Syntax
client.update_phone_number(
PhoneNumberId='string',
TwoWayEnabled=True|False,
TwoWayChannelArn='string',
TwoWayChannelRole='string',
SelfManagedOptOutsEnabled=True|False,
OptOutListName='string',
InternationalSendingEnabled=True|False,
DeletionProtectionEnabled=True|False
)
string
[REQUIRED]
The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
boolean
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
string
The Amazon Resource Name (ARN) of the two way channel.
string
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
boolean
By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
string
The OptOutList to add the phone number to. You can use either the opt out list name or the opt out list ARN.
boolean
By default this is set to false. When set to true the international sending of phone number is Enabled.
boolean
By default this is set to false. When set to true the phone number can't be deleted.
dict
Response Syntax
{
'PhoneNumberArn': 'string',
'PhoneNumberId': 'string',
'PhoneNumber': 'string',
'Status': 'PENDING'|'ACTIVE'|'ASSOCIATING'|'DISASSOCIATING'|'DELETED',
'IsoCountryCode': 'string',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'NumberCapabilities': [
'SMS'|'VOICE'|'MMS'|'RCS',
],
'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
'MonthlyLeasingPrice': 'string',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'InternationalSendingEnabled': True|False,
'DeletionProtectionEnabled': True|False,
'RegistrationId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
PhoneNumberArn (string) --
The Amazon Resource Name (ARN) of the updated phone number.
PhoneNumberId (string) --
The unique identifier of the phone number.
PhoneNumber (string) --
The phone number that was updated.
Status (string) --
The current status of the request.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageType (string) --
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
NumberCapabilities (list) --
Specifies if the number could be used for text messages, voice or both.
(string) --
NumberType (string) --
The type of number that was requested.
MonthlyLeasingPrice (string) --
The monthly leasing price of the phone number, in US dollars.
TwoWayEnabled (boolean) --
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
TwoWayChannelArn (string) --
The Amazon Resource Name (ARN) of the two way channel.
TwoWayChannelRole (string) --
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
SelfManagedOptOutsEnabled (boolean) --
This is true if self managed opt-out are enabled.
OptOutListName (string) --
The name of the OptOutList associated with the phone number.
InternationalSendingEnabled (boolean) --
When set to true the international sending of phone number is Enabled.
DeletionProtectionEnabled (boolean) --
When set to true the phone number can't be deleted.
RegistrationId (string) --
The unique identifier for the registration.
CreatedTimestamp (datetime) --
The time when the phone number was created, in UNIX epoch time format.
{'NumberCapability': {'RCS'}}
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.
See also: AWS API Documentation
Request Syntax
client.update_protect_configuration_country_rule_set(
ProtectConfigurationId='string',
NumberCapability='SMS'|'VOICE'|'MMS'|'RCS',
CountryRuleSetUpdates={
'string': {
'ProtectStatus': 'ALLOW'|'BLOCK'|'MONITOR'|'FILTER'
}
}
)
string
[REQUIRED]
The unique identifier for the protect configuration.
string
[REQUIRED]
The number capability to apply the CountryRuleSetUpdates updates to.
dict
[REQUIRED]
A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the End User Messaging SMS User Guide.
For example, to set the United States as allowed and Canada as blocked, the CountryRuleSetUpdates would be formatted as: "CountryRuleSetUpdates": { "US" : { "ProtectStatus": "ALLOW" } "CA" : { "ProtectStatus": "BLOCK" } }
(string) --
(dict) --
The types of statuses that can be used.
ProtectStatus (string) -- [REQUIRED]
The types of protection that can be used.
dict
Response Syntax
{
'ProtectConfigurationArn': 'string',
'ProtectConfigurationId': 'string',
'NumberCapability': 'SMS'|'VOICE'|'MMS'|'RCS',
'CountryRuleSet': {
'string': {
'ProtectStatus': 'ALLOW'|'BLOCK'|'MONITOR'|'FILTER'
}
}
}
Response Structure
(dict) --
ProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the protect configuration.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
NumberCapability (string) --
The number capability that was updated
CountryRuleSet (dict) --
An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.
(string) --
(dict) --
The types of statuses that can be used.
ProtectStatus (string) --
The types of protection that can be used.
{'Status': {'UNSUPPORTED'}}
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.
See also: AWS API Documentation
Request Syntax
client.verify_destination_number(
VerifiedDestinationNumberId='string',
VerificationCode='string'
)
string
[REQUIRED]
The unique identifier for the verififed destination phone number.
string
[REQUIRED]
The verification code that was received by the verified destination phone number.
dict
Response Syntax
{
'VerifiedDestinationNumberArn': 'string',
'VerifiedDestinationNumberId': 'string',
'DestinationPhoneNumber': 'string',
'Status': 'PENDING'|'VERIFIED'|'UNSUPPORTED',
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
VerifiedDestinationNumberArn (string) --
The Amazon Resource Name (ARN) for the verified destination phone number.
VerifiedDestinationNumberId (string) --
The unique identifier for the verified destination phone number.
DestinationPhoneNumber (string) --
The phone number in E.164 format.
Status (string) --
The status for being able to send messages to the phone number.
CreatedTimestamp (datetime) --
The time when the destination phone number was created, in UNIX epoch time format.