2024/04/30 - Amazon Pinpoint SMS Voice V2 - 13 new 14 updated api methods
Changes Amazon Pinpoint has added two new features Multimedia services (MMS) and protect configurations. Use the three new MMS APIs to send media messages to a mobile phone which includes image, audio, text, or video files. Use the ten new protect configurations APIs to block messages to specific countries.
Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
See also: AWS API Documentation
Request Syntax
client.describe_protect_configurations(
ProtectConfigurationIds=[
'string',
],
Filters=[
{
'Name': 'account-default'|'deletion-protection-enabled',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of protect configuration identifiers to search for.
(string) --
list
An array of ProtectConfigurationFilter objects to filter the results.
(dict) --
The filter definition for filtering protect configurations that meet a specified criteria.
Name (string) -- [REQUIRED]
The name of the attribute to filter on.
Values (list) -- [REQUIRED]
An array of 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
{
'ProtectConfigurations': [
{
'ProtectConfigurationArn': 'string',
'ProtectConfigurationId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'AccountDefault': True|False,
'DeletionProtectionEnabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProtectConfigurations (list) --
An array of ProtectConfigurationInformation objects that contain the details for the request.
(dict) --
Provides information on the specified protect configuration.
ProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the protect configuration.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
CreatedTimestamp (datetime) --
The time when the protect configuration was created, in UNIX epoch time format.
AccountDefault (boolean) --
This is true if the protect configuration is set as your account default protect configuration.
DeletionProtectionEnabled (boolean) --
The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
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.
Update a country rule set to ALLOW or BLOCK 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',
CountryRuleSetUpdates={
'string': {
'ProtectStatus': 'ALLOW'|'BLOCK'
}
}
)
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 Amazon Pinpoint SMS user guide.
(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',
'CountryRuleSet': {
'string': {
'ProtectStatus': 'ALLOW'|'BLOCK'
}
}
}
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.
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.
See also: AWS API Documentation
Request Syntax
client.set_account_default_protect_configuration(
ProtectConfigurationId='string'
)
string
[REQUIRED]
The unique identifier for the protect configuration.
dict
Response Syntax
{
'DefaultProtectConfigurationArn': 'string',
'DefaultProtectConfigurationId': 'string'
}
Response Structure
(dict) --
DefaultProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the account default protect configuration.
DefaultProtectConfigurationId (string) --
The unique identifier of the account default protect configuration.
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.
See also: AWS API Documentation
Request Syntax
client.delete_protect_configuration(
ProtectConfigurationId='string'
)
string
[REQUIRED]
The unique identifier for the protect configuration.
dict
Response Syntax
{
'ProtectConfigurationArn': 'string',
'ProtectConfigurationId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'AccountDefault': True|False,
'DeletionProtectionEnabled': True|False
}
Response Structure
(dict) --
ProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the protect configuration.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
CreatedTimestamp (datetime) --
The time when the protect configuration was created, in UNIX epoch time format.
AccountDefault (boolean) --
This is true if the protect configuration is set as your account default protect configuration.
DeletionProtectionEnabled (boolean) --
The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
Update the setting for an existing protect configuration.
See also: AWS API Documentation
Request Syntax
client.update_protect_configuration(
ProtectConfigurationId='string',
DeletionProtectionEnabled=True|False
)
string
[REQUIRED]
The unique identifier for the protect configuration.
boolean
When set to true deletion protection is enabled. By default this is set to false.
dict
Response Syntax
{
'ProtectConfigurationArn': 'string',
'ProtectConfigurationId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'AccountDefault': True|False,
'DeletionProtectionEnabled': True|False
}
Response Structure
(dict) --
ProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the protect configuration.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
CreatedTimestamp (datetime) --
The time when the protect configuration was created, in UNIX epoch time format.
AccountDefault (boolean) --
This is true if the protect configuration is set as your account default protect configuration.
DeletionProtectionEnabled (boolean) --
The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
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.
See also: AWS API Documentation
Request Syntax
client.create_protect_configuration(
ClientToken='string',
DeletionProtectionEnabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
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.
boolean
When set to true deletion protection is enabled. By default this is set to false.
list
An array of key and value pair tags that are associated with the resource.
(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
{
'ProtectConfigurationArn': 'string',
'ProtectConfigurationId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'AccountDefault': True|False,
'DeletionProtectionEnabled': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the protect configuration.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
CreatedTimestamp (datetime) --
The time when the protect configuration was created, in UNIX epoch time format.
AccountDefault (boolean) --
This is true if the protect configuration is set as your account default protect configuration.
DeletionProtectionEnabled (boolean) --
When set to true deletion protection is enabled. By default this is set to false.
Tags (list) --
An array of key and value pair tags that are associated with the resource.
(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.
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 .
See also: AWS API Documentation
Request Syntax
client.delete_media_message_spend_limit_override()
dict
Response Syntax
{
'MonthlyLimit': 123
}
Response Structure
(dict) --
MonthlyLimit (integer) --
The current monthly limit, in US dollars.
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.
See also: AWS API Documentation
Request Syntax
client.set_media_message_spend_limit_override(
MonthlyLimit=123
)
integer
[REQUIRED]
The new monthly limit to enforce on text messages.
dict
Response Syntax
{
'MonthlyLimit': 123
}
Response Structure
(dict) --
MonthlyLimit (integer) --
The current monthly limit to enforce on sending text messages.
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'
)
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',
'CountryRuleSet': {
'string': {
'ProtectStatus': 'ALLOW'|'BLOCK'
}
}
}
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 Amazon Pinpoint SMS user guide.
(string) --
(dict) --
The types of statuses that can be used.
ProtectStatus (string) --
The types of protection that can be used.
Disassociate a protect configuration from a configuration set.
See also: AWS API Documentation
Request Syntax
client.disassociate_protect_configuration(
ProtectConfigurationId='string',
ConfigurationSetName='string'
)
string
[REQUIRED]
The unique identifier for the protect configuration.
string
[REQUIRED]
The name of the ConfigurationSet.
dict
Response Syntax
{
'ConfigurationSetArn': 'string',
'ConfigurationSetName': 'string',
'ProtectConfigurationArn': 'string',
'ProtectConfigurationId': 'string'
}
Response Structure
(dict) --
ConfigurationSetArn (string) --
The Amazon Resource Name (ARN) of the configuration set.
ConfigurationSetName (string) --
The name of the ConfigurationSet.
ProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the protect configuration.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
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.
See also: AWS API Documentation
Request Syntax
client.associate_protect_configuration(
ProtectConfigurationId='string',
ConfigurationSetName='string'
)
string
[REQUIRED]
The unique identifier for the protect configuration.
string
[REQUIRED]
The name of the ConfigurationSet.
dict
Response Syntax
{
'ConfigurationSetArn': 'string',
'ConfigurationSetName': 'string',
'ProtectConfigurationArn': 'string',
'ProtectConfigurationId': 'string'
}
Response Structure
(dict) --
ConfigurationSetArn (string) --
The Amazon Resource Name (ARN) of the configuration set.
ConfigurationSetName (string) --
The name of the ConfigurationSet.
ProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the protect configuration.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
See also: AWS API Documentation
Request Syntax
client.send_media_message(
DestinationPhoneNumber='string',
OriginationIdentity='string',
MessageBody='string',
MediaUrls=[
'string',
],
ConfigurationSetName='string',
MaxPrice='string',
TimeToLive=123,
Context={
'string': 'string'
},
DryRun=True|False,
ProtectConfigurationId='string'
)
string
[REQUIRED]
The destination phone number in E.164 format.
string
[REQUIRED]
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
string
The text body of the message.
list
An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
(string) --
string
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
string
The maximum amount that you want to spend, in US dollars, per each MMS message.
integer
How long the text message is valid for. 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) --
boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
string
The unique identifier of the protect configuration to use.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
MessageId (string) --
The unique identifier for the message.
Removes the current account default protect configuration.
See also: AWS API Documentation
Request Syntax
client.delete_account_default_protect_configuration()
dict
Response Syntax
{
'DefaultProtectConfigurationArn': 'string',
'DefaultProtectConfigurationId': 'string'
}
Response Structure
(dict) --
DefaultProtectConfigurationArn (string) --
The Amazon Resource Name (ARN) of the account default protect configuration.
DefaultProtectConfigurationId (string) --
The unique identifier of the account default protect configuration.
{'MatchingEventTypes': {'MEDIA_ALL',
'MEDIA_BLOCKED',
'MEDIA_CARRIER_BLOCKED',
'MEDIA_CARRIER_UNREACHABLE',
'MEDIA_DELIVERED',
'MEDIA_FILE_INACCESSIBLE',
'MEDIA_FILE_SIZE_EXCEEDED',
'MEDIA_FILE_TYPE_UNSUPPORTED',
'MEDIA_INVALID',
'MEDIA_INVALID_MESSAGE',
'MEDIA_PENDING',
'MEDIA_QUEUED',
'MEDIA_SPAM',
'MEDIA_SUCCESSFUL',
'MEDIA_TTL_EXPIRED',
'MEDIA_UNKNOWN',
'MEDIA_UNREACHABLE'}}
Response {'EventDestination': {'MatchingEventTypes': {'MEDIA_ALL',
'MEDIA_BLOCKED',
'MEDIA_CARRIER_BLOCKED',
'MEDIA_CARRIER_UNREACHABLE',
'MEDIA_DELIVERED',
'MEDIA_FILE_INACCESSIBLE',
'MEDIA_FILE_SIZE_EXCEEDED',
'MEDIA_FILE_TYPE_UNSUPPORTED',
'MEDIA_INVALID',
'MEDIA_INVALID_MESSAGE',
'MEDIA_PENDING',
'MEDIA_QUEUED',
'MEDIA_SPAM',
'MEDIA_SUCCESSFUL',
'MEDIA_TTL_EXPIRED',
'MEDIA_UNKNOWN',
'MEDIA_UNREACHABLE'}}}
Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
See also: AWS API Documentation
Request Syntax
client.create_event_destination(
ConfigurationSetName='string',
EventDestinationName='string',
MatchingEventTypes=[
'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED'|'MEDIA_ALL'|'MEDIA_PENDING'|'MEDIA_QUEUED'|'MEDIA_SUCCESSFUL'|'MEDIA_DELIVERED'|'MEDIA_INVALID'|'MEDIA_INVALID_MESSAGE'|'MEDIA_UNREACHABLE'|'MEDIA_CARRIER_UNREACHABLE'|'MEDIA_BLOCKED'|'MEDIA_CARRIER_BLOCKED'|'MEDIA_SPAM'|'MEDIA_UNKNOWN'|'MEDIA_TTL_EXPIRED'|'MEDIA_FILE_INACCESSIBLE'|'MEDIA_FILE_TYPE_UNSUPPORTED'|'MEDIA_FILE_SIZE_EXCEEDED',
],
CloudWatchLogsDestination={
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
KinesisFirehoseDestination={
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
SnsDestination={
'TopicArn': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
string
[REQUIRED]
The name that identifies the event destination.
list
[REQUIRED]
An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.
Note
The TEXT_SENT event type is not supported.
(string) --
dict
An object that contains information about an event destination for logging to Amazon CloudWatch Logs.
IamRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
LogGroupArn (string) -- [REQUIRED]
The name of the Amazon CloudWatch log group that you want to record events in.
dict
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn (string) -- [REQUIRED]
The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
DeliveryStreamArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the delivery stream.
dict
An object that contains information about an event destination for logging to Amazon SNS.
TopicArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
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
{
'ConfigurationSetArn': 'string',
'ConfigurationSetName': 'string',
'EventDestination': {
'EventDestinationName': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED'|'MEDIA_ALL'|'MEDIA_PENDING'|'MEDIA_QUEUED'|'MEDIA_SUCCESSFUL'|'MEDIA_DELIVERED'|'MEDIA_INVALID'|'MEDIA_INVALID_MESSAGE'|'MEDIA_UNREACHABLE'|'MEDIA_CARRIER_UNREACHABLE'|'MEDIA_BLOCKED'|'MEDIA_CARRIER_BLOCKED'|'MEDIA_SPAM'|'MEDIA_UNKNOWN'|'MEDIA_TTL_EXPIRED'|'MEDIA_FILE_INACCESSIBLE'|'MEDIA_FILE_TYPE_UNSUPPORTED'|'MEDIA_FILE_SIZE_EXCEEDED',
],
'CloudWatchLogsDestination': {
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'SnsDestination': {
'TopicArn': 'string'
}
}
}
Response Structure
(dict) --
ConfigurationSetArn (string) --
The ARN of the configuration set.
ConfigurationSetName (string) --
The name of the configuration set.
EventDestination (dict) --
The details of the destination where events are logged.
EventDestinationName (string) --
The name of the EventDestination.
Enabled (boolean) --
When set to true events will be logged.
MatchingEventTypes (list) --
An array of event types that determine which events to log.
Note
The TEXT_SENT event type is not supported.
(string) --
CloudWatchLogsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
LogGroupArn (string) --
The name of the Amazon CloudWatch log group that you want to record events in.
KinesisFirehoseDestination (dict) --
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn (string) --
The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
DeliveryStreamArn (string) --
The Amazon Resource Name (ARN) of the delivery stream.
SnsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon SNS.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
{'EventDestinations': {'MatchingEventTypes': {'MEDIA_ALL',
'MEDIA_BLOCKED',
'MEDIA_CARRIER_BLOCKED',
'MEDIA_CARRIER_UNREACHABLE',
'MEDIA_DELIVERED',
'MEDIA_FILE_INACCESSIBLE',
'MEDIA_FILE_SIZE_EXCEEDED',
'MEDIA_FILE_TYPE_UNSUPPORTED',
'MEDIA_INVALID',
'MEDIA_INVALID_MESSAGE',
'MEDIA_PENDING',
'MEDIA_QUEUED',
'MEDIA_SPAM',
'MEDIA_SUCCESSFUL',
'MEDIA_TTL_EXPIRED',
'MEDIA_UNKNOWN',
'MEDIA_UNREACHABLE'}}}
Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
See also: AWS API Documentation
Request Syntax
client.delete_configuration_set(
ConfigurationSetName='string'
)
string
[REQUIRED]
The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
dict
Response Syntax
{
'ConfigurationSetArn': 'string',
'ConfigurationSetName': 'string',
'EventDestinations': [
{
'EventDestinationName': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED'|'MEDIA_ALL'|'MEDIA_PENDING'|'MEDIA_QUEUED'|'MEDIA_SUCCESSFUL'|'MEDIA_DELIVERED'|'MEDIA_INVALID'|'MEDIA_INVALID_MESSAGE'|'MEDIA_UNREACHABLE'|'MEDIA_CARRIER_UNREACHABLE'|'MEDIA_BLOCKED'|'MEDIA_CARRIER_BLOCKED'|'MEDIA_SPAM'|'MEDIA_UNKNOWN'|'MEDIA_TTL_EXPIRED'|'MEDIA_FILE_INACCESSIBLE'|'MEDIA_FILE_TYPE_UNSUPPORTED'|'MEDIA_FILE_SIZE_EXCEEDED',
],
'CloudWatchLogsDestination': {
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'SnsDestination': {
'TopicArn': 'string'
}
},
],
'DefaultMessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'DefaultSenderId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ConfigurationSetArn (string) --
The Amazon Resource Name (ARN) of the deleted configuration set.
ConfigurationSetName (string) --
The name of the deleted configuration set.
EventDestinations (list) --
An array of any EventDestination objects that were associated with the deleted configuration set.
(dict) --
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.
EventDestinationName (string) --
The name of the EventDestination.
Enabled (boolean) --
When set to true events will be logged.
MatchingEventTypes (list) --
An array of event types that determine which events to log.
Note
The TEXT_SENT event type is not supported.
(string) --
CloudWatchLogsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
LogGroupArn (string) --
The name of the Amazon CloudWatch log group that you want to record events in.
KinesisFirehoseDestination (dict) --
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn (string) --
The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
DeliveryStreamArn (string) --
The Amazon Resource Name (ARN) of the delivery stream.
SnsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon SNS.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
DefaultMessageType (string) --
The default message type of the configuration set that was deleted.
DefaultSenderId (string) --
The default Sender ID of the configuration set that was deleted.
CreatedTimestamp (datetime) --
The time that the deleted configuration set was created in UNIX epoch time format.
{'EventDestination': {'MatchingEventTypes': {'MEDIA_ALL',
'MEDIA_BLOCKED',
'MEDIA_CARRIER_BLOCKED',
'MEDIA_CARRIER_UNREACHABLE',
'MEDIA_DELIVERED',
'MEDIA_FILE_INACCESSIBLE',
'MEDIA_FILE_SIZE_EXCEEDED',
'MEDIA_FILE_TYPE_UNSUPPORTED',
'MEDIA_INVALID',
'MEDIA_INVALID_MESSAGE',
'MEDIA_PENDING',
'MEDIA_QUEUED',
'MEDIA_SPAM',
'MEDIA_SUCCESSFUL',
'MEDIA_TTL_EXPIRED',
'MEDIA_UNKNOWN',
'MEDIA_UNREACHABLE'}}}
Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
See also: AWS API Documentation
Request Syntax
client.delete_event_destination(
ConfigurationSetName='string',
EventDestinationName='string'
)
string
[REQUIRED]
The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
string
[REQUIRED]
The name of the event destination to delete.
dict
Response Syntax
{
'ConfigurationSetArn': 'string',
'ConfigurationSetName': 'string',
'EventDestination': {
'EventDestinationName': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED'|'MEDIA_ALL'|'MEDIA_PENDING'|'MEDIA_QUEUED'|'MEDIA_SUCCESSFUL'|'MEDIA_DELIVERED'|'MEDIA_INVALID'|'MEDIA_INVALID_MESSAGE'|'MEDIA_UNREACHABLE'|'MEDIA_CARRIER_UNREACHABLE'|'MEDIA_BLOCKED'|'MEDIA_CARRIER_BLOCKED'|'MEDIA_SPAM'|'MEDIA_UNKNOWN'|'MEDIA_TTL_EXPIRED'|'MEDIA_FILE_INACCESSIBLE'|'MEDIA_FILE_TYPE_UNSUPPORTED'|'MEDIA_FILE_SIZE_EXCEEDED',
],
'CloudWatchLogsDestination': {
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'SnsDestination': {
'TopicArn': 'string'
}
}
}
Response Structure
(dict) --
ConfigurationSetArn (string) --
The Amazon Resource Name (ARN) of the configuration set.
ConfigurationSetName (string) --
The name of the configuration set the event destination was deleted from.
EventDestination (dict) --
The event destination object that was deleted.
EventDestinationName (string) --
The name of the EventDestination.
Enabled (boolean) --
When set to true events will be logged.
MatchingEventTypes (list) --
An array of event types that determine which events to log.
Note
The TEXT_SENT event type is not supported.
(string) --
CloudWatchLogsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
LogGroupArn (string) --
The name of the Amazon CloudWatch log group that you want to record events in.
KinesisFirehoseDestination (dict) --
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn (string) --
The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
DeliveryStreamArn (string) --
The Amazon Resource Name (ARN) of the delivery stream.
SnsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon SNS.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
{'AccountAttributes': {'Name': {'DEFAULT_PROTECT_CONFIGURATION_ID'}}}
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.
New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
See also: AWS API Documentation
Request Syntax
client.describe_account_attributes(
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
{
'AccountAttributes': [
{
'Name': 'ACCOUNT_TIER'|'DEFAULT_PROTECT_CONFIGURATION_ID',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AccountAttributes (list) --
An array of AccountAttributes objects.
(dict) --
Displays the attributes associated with a single Amazon Web Services account.
Name (string) --
The name of the account attribute.
Value (string) --
The value associated with the account attribute name.
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': {'protect-configuration-id'}}}
Response {'ConfigurationSets': {'EventDestinations': {'MatchingEventTypes': {'MEDIA_ALL',
'MEDIA_BLOCKED',
'MEDIA_CARRIER_BLOCKED',
'MEDIA_CARRIER_UNREACHABLE',
'MEDIA_DELIVERED',
'MEDIA_FILE_INACCESSIBLE',
'MEDIA_FILE_SIZE_EXCEEDED',
'MEDIA_FILE_TYPE_UNSUPPORTED',
'MEDIA_INVALID',
'MEDIA_INVALID_MESSAGE',
'MEDIA_PENDING',
'MEDIA_QUEUED',
'MEDIA_SPAM',
'MEDIA_SUCCESSFUL',
'MEDIA_TTL_EXPIRED',
'MEDIA_UNKNOWN',
'MEDIA_UNREACHABLE'}},
'ProtectConfigurationId': 'string'}}
Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
See also: AWS API Documentation
Request Syntax
client.describe_configuration_sets(
ConfigurationSetNames=[
'string',
],
Filters=[
{
'Name': 'event-destination-name'|'matching-event-types'|'default-message-type'|'default-sender-id'|'protect-configuration-id',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
(string) --
list
An array of filters to apply to the results that are returned.
(dict) --
The information for configuration sets 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
{
'ConfigurationSets': [
{
'ConfigurationSetArn': 'string',
'ConfigurationSetName': 'string',
'EventDestinations': [
{
'EventDestinationName': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED'|'MEDIA_ALL'|'MEDIA_PENDING'|'MEDIA_QUEUED'|'MEDIA_SUCCESSFUL'|'MEDIA_DELIVERED'|'MEDIA_INVALID'|'MEDIA_INVALID_MESSAGE'|'MEDIA_UNREACHABLE'|'MEDIA_CARRIER_UNREACHABLE'|'MEDIA_BLOCKED'|'MEDIA_CARRIER_BLOCKED'|'MEDIA_SPAM'|'MEDIA_UNKNOWN'|'MEDIA_TTL_EXPIRED'|'MEDIA_FILE_INACCESSIBLE'|'MEDIA_FILE_TYPE_UNSUPPORTED'|'MEDIA_FILE_SIZE_EXCEEDED',
],
'CloudWatchLogsDestination': {
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'SnsDestination': {
'TopicArn': 'string'
}
},
],
'DefaultMessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'DefaultSenderId': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'ProtectConfigurationId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConfigurationSets (list) --
An array of ConfigurationSets objects.
(dict) --
Information related to a given configuration set in your Amazon Web Services account.
ConfigurationSetArn (string) --
The Resource Name (ARN) of the ConfigurationSet.
ConfigurationSetName (string) --
The name of the ConfigurationSet.
EventDestinations (list) --
An array of EventDestination objects that describe any events to log and where to log them.
(dict) --
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose, or Amazon SNS.
EventDestinationName (string) --
The name of the EventDestination.
Enabled (boolean) --
When set to true events will be logged.
MatchingEventTypes (list) --
An array of event types that determine which events to log.
Note
The TEXT_SENT event type is not supported.
(string) --
CloudWatchLogsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
LogGroupArn (string) --
The name of the Amazon CloudWatch log group that you want to record events in.
KinesisFirehoseDestination (dict) --
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn (string) --
The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
DeliveryStreamArn (string) --
The Amazon Resource Name (ARN) of the delivery stream.
SnsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon SNS.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
DefaultMessageType (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.
DefaultSenderId (string) --
The default sender ID used by the ConfigurationSet.
CreatedTimestamp (datetime) --
The time when the ConfigurationSet was created, in UNIX epoch time format.
ProtectConfigurationId (string) --
The unique identifier for the protect configuration.
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.
{'PhoneNumbers': {'NumberCapabilities': {'MMS'}}}
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
)
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.
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',
],
'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
'MonthlyLeasingPrice': 'string',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'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 an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint 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.
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.
{'SpendLimits': {'Name': {'MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT'}}}
Describes the current Amazon Pinpoint 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 spending quota for Amazon Pinpoint in the Amazon Pinpoint 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',
'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 Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint 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.
{'OriginationIdentities': {'NumberCapabilities': {'MMS'}}}
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',
],
'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.
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': {'MMS'}}
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',
],
'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 an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint 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': {'MMS'}}
Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide .
See also: AWS API Documentation
Request Syntax
client.request_phone_number(
IsoCountryCode='string',
MessageType='TRANSACTIONAL'|'PROMOTIONAL',
NumberCapabilities=[
'SMS'|'VOICE'|'MMS',
],
NumberType='LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
OptOutListName='string',
PoolId='string',
RegistrationId='string',
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.
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 phone number can't be deleted.
list
An array of tags (key and value pairs) 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',
],
'NumberType': 'LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
'MonthlyLeasingPrice': 'string',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'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 an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint 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.
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.
{'ProtectConfigurationId': 'string'}
Creates a new text message and sends it to a recipient's phone number.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide .
See also: AWS API Documentation
Request Syntax
client.send_text_message(
DestinationPhoneNumber='string',
OriginationIdentity='string',
MessageBody='string',
MessageType='TRANSACTIONAL'|'PROMOTIONAL',
Keyword='string',
ConfigurationSetName='string',
MaxPrice='string',
TimeToLive=123,
Context={
'string': 'string'
},
DestinationCountryParameters={
'string': 'string'
},
DryRun=True|False,
ProtectConfigurationId='string'
)
string
[REQUIRED]
The destination phone number in E.164 format.
string
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
string
The body of the text message.
string
The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
string
When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
string
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
string
The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
integer
How long the text message is valid for. 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) --
dict
This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
(string) --
(string) --
boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
string
The unique identifier for the protect configuration.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
MessageId (string) --
The unique identifier for the message.
{'ProtectConfigurationId': 'string'}
Allows you to send a request that sends a voice message through Amazon Pinpoint. This operation uses Amazon Polly to convert a text script into a voice message.
See also: AWS API Documentation
Request Syntax
client.send_voice_message(
DestinationPhoneNumber='string',
OriginationIdentity='string',
MessageBody='string',
MessageBodyTextType='TEXT'|'SSML',
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',
ConfigurationSetName='string',
MaxPricePerMinute='string',
TimeToLive=123,
Context={
'string': 'string'
},
DryRun=True|False,
ProtectConfigurationId='string'
)
string
[REQUIRED]
The destination phone number in E.164 format.
string
[REQUIRED]
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
string
The text to convert to a voice message.
string
Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
TEXT: This is the default value. When used the maximum character limit is 3000.
SSML: When used the maximum character limit is 6000 including SSML tagging.
string
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
string
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
string
The maximum amount to spend per voice message, in US dollars.
integer
How long the voice message is valid for. 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) --
boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
string
The unique identifier for the protect configuration.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
MessageId (string) --
The unique identifier for the message.
{'MatchingEventTypes': {'MEDIA_ALL',
'MEDIA_BLOCKED',
'MEDIA_CARRIER_BLOCKED',
'MEDIA_CARRIER_UNREACHABLE',
'MEDIA_DELIVERED',
'MEDIA_FILE_INACCESSIBLE',
'MEDIA_FILE_SIZE_EXCEEDED',
'MEDIA_FILE_TYPE_UNSUPPORTED',
'MEDIA_INVALID',
'MEDIA_INVALID_MESSAGE',
'MEDIA_PENDING',
'MEDIA_QUEUED',
'MEDIA_SPAM',
'MEDIA_SUCCESSFUL',
'MEDIA_TTL_EXPIRED',
'MEDIA_UNKNOWN',
'MEDIA_UNREACHABLE'}}
Response {'EventDestination': {'MatchingEventTypes': {'MEDIA_ALL',
'MEDIA_BLOCKED',
'MEDIA_CARRIER_BLOCKED',
'MEDIA_CARRIER_UNREACHABLE',
'MEDIA_DELIVERED',
'MEDIA_FILE_INACCESSIBLE',
'MEDIA_FILE_SIZE_EXCEEDED',
'MEDIA_FILE_TYPE_UNSUPPORTED',
'MEDIA_INVALID',
'MEDIA_INVALID_MESSAGE',
'MEDIA_PENDING',
'MEDIA_QUEUED',
'MEDIA_SPAM',
'MEDIA_SUCCESSFUL',
'MEDIA_TTL_EXPIRED',
'MEDIA_UNKNOWN',
'MEDIA_UNREACHABLE'}}}
Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
See also: AWS API Documentation
Request Syntax
client.update_event_destination(
ConfigurationSetName='string',
EventDestinationName='string',
Enabled=True|False,
MatchingEventTypes=[
'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED'|'MEDIA_ALL'|'MEDIA_PENDING'|'MEDIA_QUEUED'|'MEDIA_SUCCESSFUL'|'MEDIA_DELIVERED'|'MEDIA_INVALID'|'MEDIA_INVALID_MESSAGE'|'MEDIA_UNREACHABLE'|'MEDIA_CARRIER_UNREACHABLE'|'MEDIA_BLOCKED'|'MEDIA_CARRIER_BLOCKED'|'MEDIA_SPAM'|'MEDIA_UNKNOWN'|'MEDIA_TTL_EXPIRED'|'MEDIA_FILE_INACCESSIBLE'|'MEDIA_FILE_TYPE_UNSUPPORTED'|'MEDIA_FILE_SIZE_EXCEEDED',
],
CloudWatchLogsDestination={
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
KinesisFirehoseDestination={
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
SnsDestination={
'TopicArn': 'string'
}
)
string
[REQUIRED]
The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
string
[REQUIRED]
The name to use for the event destination.
boolean
When set to true logging is enabled.
list
An array of event types that determine which events to log.
Note
The TEXT_SENT event type is not supported.
(string) --
dict
An object that contains information about an event destination that sends data to CloudWatch Logs.
IamRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
LogGroupArn (string) -- [REQUIRED]
The name of the Amazon CloudWatch log group that you want to record events in.
dict
An object that contains information about an event destination for logging to Kinesis Data Firehose.
IamRoleArn (string) -- [REQUIRED]
The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
DeliveryStreamArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the delivery stream.
dict
An object that contains information about an event destination that sends data to Amazon SNS.
TopicArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
dict
Response Syntax
{
'ConfigurationSetArn': 'string',
'ConfigurationSetName': 'string',
'EventDestination': {
'EventDestinationName': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED'|'MEDIA_ALL'|'MEDIA_PENDING'|'MEDIA_QUEUED'|'MEDIA_SUCCESSFUL'|'MEDIA_DELIVERED'|'MEDIA_INVALID'|'MEDIA_INVALID_MESSAGE'|'MEDIA_UNREACHABLE'|'MEDIA_CARRIER_UNREACHABLE'|'MEDIA_BLOCKED'|'MEDIA_CARRIER_BLOCKED'|'MEDIA_SPAM'|'MEDIA_UNKNOWN'|'MEDIA_TTL_EXPIRED'|'MEDIA_FILE_INACCESSIBLE'|'MEDIA_FILE_TYPE_UNSUPPORTED'|'MEDIA_FILE_SIZE_EXCEEDED',
],
'CloudWatchLogsDestination': {
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'SnsDestination': {
'TopicArn': 'string'
}
}
}
Response Structure
(dict) --
ConfigurationSetArn (string) --
The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
ConfigurationSetName (string) --
The name of the configuration set.
EventDestination (dict) --
An EventDestination object containing the details of where events will be logged.
EventDestinationName (string) --
The name of the EventDestination.
Enabled (boolean) --
When set to true events will be logged.
MatchingEventTypes (list) --
An array of event types that determine which events to log.
Note
The TEXT_SENT event type is not supported.
(string) --
CloudWatchLogsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
LogGroupArn (string) --
The name of the Amazon CloudWatch log group that you want to record events in.
KinesisFirehoseDestination (dict) --
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn (string) --
The ARN of an Identity and Access Management role that is able to write event data to an Amazon Kinesis Data Firehose destination.
DeliveryStreamArn (string) --
The Amazon Resource Name (ARN) of the delivery stream.
SnsDestination (dict) --
An object that contains information about an event destination that sends logging events to Amazon SNS.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
{'NumberCapabilities': {'MMS'}}
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',
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 an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint 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. Valid values for this field can be either the OutOutListName or OutOutListArn.
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',
],
'NumberType': 'SHORT_CODE'|'LONG_CODE'|'TOLL_FREE'|'TEN_DLC'|'SIMULATOR',
'MonthlyLeasingPrice': 'string',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'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.
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.