2023/11/16 - Amazon Pinpoint SMS Voice V2 - 26 new11 updated api methods
Changes Amazon Pinpoint now offers additional operations as part of version 2 of the SMS and voice APIs. This release includes 26 new APIs to create and manage phone number registrations, add verified destination numbers, and request sender IDs.
Permanently delete an existing registration from your account.
See also: AWS API Documentation
Request Syntax
client.delete_registration(
RegistrationId='string'
)
string
[REQUIRED]
The unique identifier for the registration.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'RegistrationType': 'string',
'RegistrationStatus': 'CREATED'|'SUBMITTED'|'REVIEWING'|'PROVISIONING'|'COMPLETE'|'REQUIRES_UPDATES'|'CLOSED'|'DELETED',
'CurrentVersionNumber': 123,
'ApprovedVersionNumber': 123,
'LatestDeniedVersionNumber': 123,
'AdditionalAttributes': {
'string': 'string'
},
'CreatedTimestamp': 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.
RegistrationType (string) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
RegistrationStatus (string) --
The status of the registration.
CREATED: Your registration is created but not submitted.
SUBMITTED: Your registration has been submitted and is awaiting review.
REVIEWING: Your registration has been accepted and is being reviewed.
PROVISIONING: Your registration has been approved and your origination identity is being created.
COMPLETE: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED: The registration has been deleted.
CurrentVersionNumber (integer) --
The current version number of the registration.
ApprovedVersionNumber (integer) --
The version number of the registration that was approved.
LatestDeniedVersionNumber (integer) --
The latest version number of the registration that was denied.
AdditionalAttributes (dict) --
Metadata about a given registration which is specific to that registration type.
(string) --
(string) --
CreatedTimestamp (datetime) --
The time when the registration was created, in UNIX epoch time format.
Delete the value in a registration form field.
See also: AWS API Documentation
Request Syntax
client.delete_registration_field_value(
RegistrationId='string',
FieldPath='string'
)
string
[REQUIRED]
The unique identifier for the registration.
string
[REQUIRED]
The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'VersionNumber': 123,
'FieldPath': 'string',
'SelectChoices': [
'string',
],
'TextValue': 'string',
'RegistrationAttachmentId': 'string'
}
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.
FieldPath (string) --
The path to the registration form field.
SelectChoices (list) --
An array of values for the form field.
(string) --
TextValue (string) --
The text data for a free form field.
RegistrationAttachmentId (string) --
The unique identifier for the registration attachment.
Retrieves the specified verified destiona numbers.
See also: AWS API Documentation
Request Syntax
client.describe_verified_destination_numbers(
VerifiedDestinationNumberIds=[
'string',
],
DestinationPhoneNumbers=[
'string',
],
Filters=[
{
'Name': 'status',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of VerifiedDestinationNumberid to retreive.
(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',
'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.
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.
Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
See also: AWS API Documentation
Request Syntax
client.send_destination_number_verification_code(
VerifiedDestinationNumberId='string',
VerificationChannel='TEXT'|'VOICE',
LanguageCode='DE_DE'|'EN_GB'|'EN_US'|'ES_419'|'ES_ES'|'FR_CA'|'FR_FR'|'IT_IT'|'JA_JP'|'KO_KR'|'PT_BR'|'ZH_CN'|'ZH_TW',
OriginationIdentity='string',
ConfigurationSetName='string',
Context={
'string': 'string'
},
DestinationCountryParameters={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier for the verified destination phone number.
string
[REQUIRED]
Choose to send the verification code as an SMS or voice message.
string
Choose the language to use for the message.
string
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
string
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
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) --
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
MessageId (string) --
The unique identifier for the message.
Submit the specified registration for review and approval.
See also: AWS API Documentation
Request Syntax
client.submit_registration_version(
RegistrationId='string'
)
string
[REQUIRED]
The unique identifier for the registration.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'VersionNumber': 123,
'RegistrationVersionStatus': 'DRAFT'|'SUBMITTED'|'REVIEWING'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED',
'RegistrationVersionStatusHistory': {
'DraftTimestamp': datetime(2015, 1, 1),
'SubmittedTimestamp': datetime(2015, 1, 1),
'ReviewingTimestamp': 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.
DRAFT: The initial status of a registration version after it’s created.
SUBMITTED: Your registration has been submitted.
REVIEWING: Your registration has been accepted and is being reviewed.
APPROVED: Your registration has been approved.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DENIED: You must fix your registration and resubmit it.
REVOKED: Your previously approved registration has been revoked.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
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.
ReviewingTimestamp (datetime) --
The time when the registration was in the reviewing 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.
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',
'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.
Retreive all of the origination identies that are associated with a registration.
See also: AWS API Documentation
Request Syntax
client.list_registration_associations(
RegistrationId='string',
Filters=[
{
'Name': 'resource-type'|'iso-country-code',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the registration.
list
An array of RegistrationAssociationFilter to apply to the results that are returned.
(dict) --
The filter definition for filtering registrations 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 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
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'RegistrationType': 'string',
'RegistrationAssociations': [
{
'ResourceArn': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'IsoCountryCode': 'string',
'PhoneNumber': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationArn (string) --
The Amazon Resource Name (ARN) for the registration.
RegistrationId (string) --
The unique identifier for the registration.
RegistrationType (string) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
RegistrationAssociations (list) --
An array of RegistrationAssociationMetadata objects.
(dict) --
Metadata for the origination identity that is associated with the registration.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
ResourceId (string) --
The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
ResourceType (string) --
The origination identity type.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
PhoneNumber (string) --
The phone number associated with the registration in E.164 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.
Updates the configuration of an existing sender ID.
See also: AWS API Documentation
Request Syntax
client.update_sender_id(
SenderId='string',
IsoCountryCode='string',
DeletionProtectionEnabled=True|False
)
string
[REQUIRED]
The sender ID to update.
string
[REQUIRED]
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
boolean
By default this is set to false. When set to true the sender ID can't be deleted.
dict
Response Syntax
{
'SenderIdArn': 'string',
'SenderId': 'string',
'IsoCountryCode': 'string',
'MessageTypes': [
'TRANSACTIONAL'|'PROMOTIONAL',
],
'MonthlyLeasingPrice': 'string',
'DeletionProtectionEnabled': True|False,
'Registered': True|False,
'RegistrationId': 'string'
}
Response Structure
(dict) --
SenderIdArn (string) --
The Amazon Resource Name (ARN) associated with the SenderId.
SenderId (string) --
The sender ID that was updated.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageTypes (list) --
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.
(string) --
MonthlyLeasingPrice (string) --
The monthly price, in US dollars, to lease the sender ID.
DeletionProtectionEnabled (boolean) --
By default this is set to false. When set to true the sender ID can't be deleted.
Registered (boolean) --
True if the sender ID is registered..
RegistrationId (string) --
The unique identifier for the registration.
Creates or updates a field value for a registration.
See also: AWS API Documentation
Request Syntax
client.put_registration_field_value(
RegistrationId='string',
FieldPath='string',
SelectChoices=[
'string',
],
TextValue='string',
RegistrationAttachmentId='string'
)
string
[REQUIRED]
The unique identifier for the registration.
string
[REQUIRED]
The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
list
An array of values for the form field.
(string) --
string
The text data for a free form field.
string
The unique identifier for the registration attachment.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'VersionNumber': 123,
'FieldPath': 'string',
'SelectChoices': [
'string',
],
'TextValue': 'string',
'RegistrationAttachmentId': 'string'
}
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.
FieldPath (string) --
The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
SelectChoices (list) --
An array of values for the form field.
(string) --
TextValue (string) --
The text data for a free form field.
RegistrationAttachmentId (string) --
The unique identifier for the registration attachment.
Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.
See also: AWS API Documentation
Request Syntax
client.describe_registration_section_definitions(
RegistrationType='string',
SectionPaths=[
'string',
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
list
An array of paths for the registration form section.
(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
{
'RegistrationType': 'string',
'RegistrationSectionDefinitions': [
{
'SectionPath': 'string',
'DisplayHints': {
'Title': 'string',
'ShortDescription': 'string',
'LongDescription': 'string',
'DocumentationTitle': 'string',
'DocumentationLink': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationType (string) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
RegistrationSectionDefinitions (list) --
An array of RegistrationSectionDefinition objects.
(dict) --
Provides information on the specified section definition.
SectionPath (string) --
The path to the section of the registration.
DisplayHints (dict) --
The path to the section of the registration.
Title (string) --
The title of the display hint.
ShortDescription (string) --
A short description of the display hint.
LongDescription (string) --
A full description of the display hint.
DocumentationTitle (string) --
The title of the document the display hint is associated with.
DocumentationLink (string) --
The link to the document the display hint is associated with.
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.
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'|'REVIEWING'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED',
'RegistrationVersionStatusHistory': {
'DraftTimestamp': datetime(2015, 1, 1),
'SubmittedTimestamp': datetime(2015, 1, 1),
'ReviewingTimestamp': 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.
DRAFT: The initial status of a registration version after it’s created.
SUBMITTED: Your registration has been submitted.
REVIEWING: Your registration has been accepted and is being reviewed.
APPROVED: Your registration has been approved.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DENIED: You must fix your registration and resubmit it.
REVOKED: Your previously approved registration has been revoked.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
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.
ReviewingTimestamp (datetime) --
The time when the registration was in the reviewing 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.
Releases an existing sender ID in your account.
See also: AWS API Documentation
Request Syntax
client.release_sender_id(
SenderId='string',
IsoCountryCode='string'
)
string
[REQUIRED]
The sender ID to release.
string
[REQUIRED]
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
dict
Response Syntax
{
'SenderIdArn': 'string',
'SenderId': 'string',
'IsoCountryCode': 'string',
'MessageTypes': [
'TRANSACTIONAL'|'PROMOTIONAL',
],
'MonthlyLeasingPrice': 'string',
'Registered': True|False,
'RegistrationId': 'string'
}
Response Structure
(dict) --
SenderIdArn (string) --
The Amazon Resource Name (ARN) associated with the SenderId.
SenderId (string) --
The sender ID that was released.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageTypes (list) --
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.
(string) --
MonthlyLeasingPrice (string) --
The monthly price, in US dollars, to lease the sender ID.
Registered (boolean) --
True if the sender ID is registered.
RegistrationId (string) --
The unique identifier for the registration.
Permanently delete the specified registration attachment.
See also: AWS API Documentation
Request Syntax
client.delete_registration_attachment(
RegistrationAttachmentId='string'
)
string
[REQUIRED]
The unique identifier for the registration attachment.
dict
Response Syntax
{
'RegistrationAttachmentArn': 'string',
'RegistrationAttachmentId': 'string',
'AttachmentStatus': 'UPLOAD_IN_PROGRESS'|'UPLOAD_COMPLETE'|'UPLOAD_FAILED'|'DELETED',
'AttachmentUploadErrorReason': 'INTERNAL_ERROR',
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
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) --
The error message if the upload failed.
CreatedTimestamp (datetime) --
The time when the registration attachment was created, in UNIX epoch time format.
Retrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.
See also: AWS API Documentation
Request Syntax
client.describe_registration_type_definitions(
RegistrationTypes=[
'string',
],
Filters=[
{
'Name': 'supported-association-resource-type'|'supported-association-iso-country-code',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
(string) --
list
An array of RegistrationFilter objects to filter the results.
(dict) --
The filter definition for filtering registration types 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
{
'RegistrationTypeDefinitions': [
{
'RegistrationType': 'string',
'SupportedAssociations': [
{
'ResourceType': 'string',
'IsoCountryCode': 'string',
'AssociationBehavior': 'ASSOCIATE_BEFORE_SUBMIT'|'ASSOCIATE_ON_APPROVAL'|'ASSOCIATE_AFTER_COMPLETE',
'DisassociationBehavior': 'DISASSOCIATE_ALL_CLOSES_REGISTRATION'|'DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION'|'DELETE_REGISTRATION_DISASSOCIATES'
},
],
'DisplayHints': {
'Title': 'string',
'ShortDescription': 'string',
'LongDescription': 'string',
'DocumentationTitle': 'string',
'DocumentationLink': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationTypeDefinitions (list) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
(dict) --
Provides information on the supported registration type.
RegistrationType (string) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
SupportedAssociations (list) --
The supported association behavior for the registration type.
(dict) --
The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.
ResourceType (string) --
Defines the behavior of when an origination identity and registration can be associated with each other.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
AssociationBehavior (string) --
The association behavior.
ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.
ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
DisassociationBehavior (string) --
The disassociation behavior.
DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.
DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.
DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.
DisplayHints (dict) --
Provides help information on the registration.
Title (string) --
The title of the display hint.
ShortDescription (string) --
A short description of the display hint.
LongDescription (string) --
A full description of the display hint.
DocumentationTitle (string) --
The title of the document the display hint is associated with.
DocumentationLink (string) --
The link to the document the display hint is associated with.
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.
Retrieves the specified registration field values.
See also: AWS API Documentation
Request Syntax
client.describe_registration_field_values(
RegistrationId='string',
VersionNumber=123,
SectionPath='string',
FieldPaths=[
'string',
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the registration.
integer
The version number of the registration.
string
The path to the section of the registration.
list
An array of paths to the registration form field.
(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',
'VersionNumber': 123,
'RegistrationFieldValues': [
{
'FieldPath': 'string',
'SelectChoices': [
'string',
],
'TextValue': 'string',
'RegistrationAttachmentId': 'string',
'DeniedReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationArn (string) --
The Amazon Resource Name (ARN) for the registration.
RegistrationId (string) --
The unique identifier for the registration.
VersionNumber (integer) --
The current version of the registration.
RegistrationFieldValues (list) --
An array of RegistrationFieldValues objects that contain the values for the requested registration.
(dict) --
Provides the values of the specified field.
FieldPath (string) --
The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
SelectChoices (list) --
An array of values for the form field.
(string) --
TextValue (string) --
The text data for a free form field.
RegistrationAttachmentId (string) --
The unique identifier for the registration attachment.
DeniedReason (string) --
A description of why the registration was denied.
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.
Associate the registration with an origination identity such as a phone number or sender ID.
See also: AWS API Documentation
Request Syntax
client.create_registration_association(
RegistrationId='string',
ResourceId='string'
)
string
[REQUIRED]
The unique identifier for the registration.
string
[REQUIRED]
The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
dict
Response Syntax
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'RegistrationType': 'string',
'ResourceArn': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'IsoCountryCode': 'string',
'PhoneNumber': 'string'
}
Response Structure
(dict) --
RegistrationArn (string) --
The Amazon Resource Name (ARN) for the registration.
RegistrationId (string) --
The unique identifier for the registration.
RegistrationType (string) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
ResourceId (string) --
The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
ResourceType (string) --
The registration type or origination identity type.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
PhoneNumber (string) --
The phone number associated with the registration in E.164 format.
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)
},
],
'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.
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.
Request a new sender ID that doesn't require registration.
See also: AWS API Documentation
Request Syntax
client.request_sender_id(
SenderId='string',
IsoCountryCode='string',
MessageTypes=[
'TRANSACTIONAL'|'PROMOTIONAL',
],
DeletionProtectionEnabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The sender ID string to request.
string
[REQUIRED]
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
list
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.
(string) --
boolean
By default this is set to false. When set to true the sender ID can't be deleted.
list
An array of tags (key and value pairs) to associate with the sender ID.
(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
{
'SenderIdArn': 'string',
'SenderId': 'string',
'IsoCountryCode': 'string',
'MessageTypes': [
'TRANSACTIONAL'|'PROMOTIONAL',
],
'MonthlyLeasingPrice': 'string',
'DeletionProtectionEnabled': True|False,
'Registered': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
SenderIdArn (string) --
The Amazon Resource Name (ARN) associated with the SenderId.
SenderId (string) --
The sender ID that was requested.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageTypes (list) --
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.
(string) --
MonthlyLeasingPrice (string) --
The monthly price, in US dollars, to lease the sender ID.
DeletionProtectionEnabled (boolean) --
By default this is set to false. When set to true the sender ID can't be deleted.
Registered (boolean) --
True if the sender ID is registered.
Tags (list) --
An array of tags (key and value pairs) to associate with the sender ID.
(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.
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',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The verified destination phone number, in E.164 format.
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',
'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.
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.
Creates a new registration based on the RegistrationType field.
See also: AWS API Documentation
Request Syntax
client.create_registration(
RegistrationType='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
list
An array of tags (key and value pairs) to associate with the registration.
(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
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'RegistrationType': 'string',
'RegistrationStatus': 'CREATED'|'SUBMITTED'|'REVIEWING'|'PROVISIONING'|'COMPLETE'|'REQUIRES_UPDATES'|'CLOSED'|'DELETED',
'CurrentVersionNumber': 123,
'AdditionalAttributes': {
'string': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedTimestamp': 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.
RegistrationType (string) --
The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
RegistrationStatus (string) --
The status of the registration.
CREATED: Your registration is created but not submitted.
SUBMITTED: Your registration has been submitted and is awaiting review.
REVIEWING: Your registration has been accepted and is being reviewed.
PROVISIONING: Your registration has been approved and your origination identity is being created.
COMPLETE: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED: The registration has been deleted.
CurrentVersionNumber (integer) --
The current version number of the registration.
AdditionalAttributes (dict) --
Metadata about a given registration which is specific to that registration type.
(string) --
(string) --
Tags (list) --
An array of tags (key and value pairs) to associate with the registration.
(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 registration was created, in UNIX epoch time format.
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'|'REVIEWING'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED',
'RegistrationVersionStatusHistory': {
'DraftTimestamp': datetime(2015, 1, 1),
'SubmittedTimestamp': datetime(2015, 1, 1),
'ReviewingTimestamp': 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.
DRAFT: The initial status of a registration version after it’s created.
SUBMITTED: Your registration has been submitted.
REVIEWING: Your registration has been accepted and is being reviewed.
APPROVED: Your registration has been approved.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DENIED: You must fix your registration and resubmit it.
REVOKED: Your previously approved registration has been revoked.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
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.
ReviewingTimestamp (datetime) --
The time when the registration was in the reviewing 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.
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'|'REVIEWING'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED',
'RegistrationVersionStatusHistory': {
'DraftTimestamp': datetime(2015, 1, 1),
'SubmittedTimestamp': datetime(2015, 1, 1),
'ReviewingTimestamp': 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'
},
]
},
],
'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.
DRAFT: The initial status of a registration version after it’s created.
SUBMITTED: Your registration has been submitted.
REVIEWING: Your registration has been accepted and is being reviewed.
APPROVED: Your registration has been approved.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DENIED: You must fix your registration and resubmit it.
REVOKED: Your previously approved registration has been revoked.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
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.
ReviewingTimestamp (datetime) --
The time when the registration was in the reviewing 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.
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.
Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
See also: AWS API Documentation
Request Syntax
client.describe_registration_field_definitions(
RegistrationType='string',
SectionPath='string',
FieldPaths=[
'string',
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
string
The path to the section of the registration.
list
An array of paths to the registration form field.
(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
{
'RegistrationType': 'string',
'RegistrationFieldDefinitions': [
{
'SectionPath': 'string',
'FieldPath': 'string',
'FieldType': 'SELECT'|'TEXT'|'ATTACHMENT',
'FieldRequirement': 'REQUIRED'|'CONDITIONAL'|'OPTIONAL',
'SelectValidation': {
'MinChoices': 123,
'MaxChoices': 123,
'Options': [
'string',
]
},
'TextValidation': {
'MinLength': 123,
'MaxLength': 123,
'Pattern': 'string'
},
'DisplayHints': {
'Title': 'string',
'ShortDescription': 'string',
'LongDescription': 'string',
'DocumentationTitle': 'string',
'DocumentationLink': 'string',
'SelectOptionDescriptions': [
{
'Option': 'string',
'Title': 'string',
'Description': 'string'
},
],
'TextValidationDescription': 'string',
'ExampleTextValue': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationType (string) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
RegistrationFieldDefinitions (list) --
An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
(dict) --
Provides a description of the specified field.
SectionPath (string) --
The section path of the field.
FieldPath (string) --
The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
FieldType (string) --
The type of field.
FieldRequirement (string) --
Specifies if the field for the registration form is required, conditional or optional.
SelectValidation (dict) --
The validation rules for a select field.
MinChoices (integer) --
The minimum number of choices for the select.
MaxChoices (integer) --
The maximum number of choices for the select.
Options (list) --
An array of strings for the possible selection options.
(string) --
TextValidation (dict) --
The validation rules for a text field.
MinLength (integer) --
The minimum number of characters for the text field.
MaxLength (integer) --
The maximum number of characters for the text field.
Pattern (string) --
The regular expression used to validate the text field.
DisplayHints (dict) --
An array of RegistrationFieldDisplayHints objects for the field.
Title (string) --
The title of the display hint.
ShortDescription (string) --
A short description of the display hint.
LongDescription (string) --
A full description of the display hint.
DocumentationTitle (string) --
The title of the document the display hint is associated with.
DocumentationLink (string) --
The link to the document the display hint is associated with.
SelectOptionDescriptions (list) --
An array of SelectOptionDescription objects.
(dict) --
A description of each select option.
Option (string) --
The value of the option.
Title (string) --
The title of the select option.
Description (string) --
A description of the option meaning.
TextValidationDescription (string) --
The validation rules for the text field.
ExampleTextValue (string) --
Example text of what the value of a field should contain.
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.
Delete a verified destination phone number.
See also: AWS API Documentation
Request Syntax
client.delete_verified_destination_number(
VerifiedDestinationNumberId='string'
)
string
[REQUIRED]
The unique identifier for the verified destination phone number.
dict
Response Syntax
{
'VerifiedDestinationNumberArn': 'string',
'VerifiedDestinationNumberId': 'string',
'DestinationPhoneNumber': '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.
CreatedTimestamp (datetime) --
The time when the destination phone number was created, in UNIX epoch time format.
Retrieves the specified registrations.
See also: AWS API Documentation
Request Syntax
client.describe_registrations(
RegistrationIds=[
'string',
],
Filters=[
{
'Name': 'registration-type'|'registration-status',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of unique identifiers for each registration.
(string) --
list
An array of RegistrationFilter objects to filter the results.
(dict) --
The filter definition for filtering registrations 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
{
'Registrations': [
{
'RegistrationArn': 'string',
'RegistrationId': 'string',
'RegistrationType': 'string',
'RegistrationStatus': 'CREATED'|'SUBMITTED'|'REVIEWING'|'PROVISIONING'|'COMPLETE'|'REQUIRES_UPDATES'|'CLOSED'|'DELETED',
'CurrentVersionNumber': 123,
'ApprovedVersionNumber': 123,
'LatestDeniedVersionNumber': 123,
'AdditionalAttributes': {
'string': 'string'
},
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Registrations (list) --
An array of RegistrationInformation objects.
(dict) --
Provides information about the requested registration.
RegistrationArn (string) --
The Amazon Resource Name (ARN) for the registration.
RegistrationId (string) --
The unique identifier for the registration.
RegistrationType (string) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
RegistrationStatus (string) --
The status of the registration.
CREATED: Your registration is created but not submitted.
SUBMITTED: Your registration has been submitted and is awaiting review.
REVIEWING: Your registration has been accepted and is being reviewed.
PROVISIONING: Your registration has been approved and your origination identity is being created.
COMPLETE: Your registration has been approved and and your origination identity has been created.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
DELETED: The registration has been deleted.
CurrentVersionNumber (integer) --
The current version number of the registration.
ApprovedVersionNumber (integer) --
The version number of the registration that was approved.
LatestDeniedVersionNumber (integer) --
The latest version number of the registration that was denied.
AdditionalAttributes (dict) --
Metadata about a given registration which is specific to that registration type.
(string) --
(string) --
CreatedTimestamp (datetime) --
The time when the registration 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.
Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.
See also: AWS API Documentation
Request Syntax
client.create_registration_attachment(
AttachmentBody=b'bytes',
AttachmentUrl='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
bytes
The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.
string
A URL to the required registration file. For example, you can provide the S3 object URL.
list
An array of tags (key and value pairs) to associate with the registration attachment.
(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
{
'RegistrationAttachmentArn': 'string',
'RegistrationAttachmentId': 'string',
'AttachmentStatus': 'UPLOAD_IN_PROGRESS'|'UPLOAD_COMPLETE'|'UPLOAD_FAILED'|'DELETED',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
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..
Tags (list) --
An array of tags (key and value pairs) to associate with the registration attachment.
(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 registration attachment was created, in UNIX epoch time format.
{'TwoWayChannelRole': 'string'}
Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
See also: AWS API Documentation
Request Syntax
client.create_pool(
OriginationIdentity='string',
IsoCountryCode='string',
MessageType='TRANSACTIONAL'|'PROMOTIONAL',
DeletionProtectionEnabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
string
[REQUIRED]
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
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.
boolean
By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
list
An array of tags (key and value pairs) associated with the pool.
(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
{
'PoolArn': 'string',
'PoolId': 'string',
'Status': 'CREATING'|'ACTIVE'|'DELETING',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'SharedRoutesEnabled': True|False,
'DeletionProtectionEnabled': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
PoolArn (string) --
The Amazon Resource Name (ARN) for the pool.
PoolId (string) --
The unique identifier for the pool.
Status (string) --
The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
MessageType (string) --
The type of message for the pool to use.
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) --
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 associated with the pool.
SharedRoutesEnabled (boolean) --
Indicates whether shared routes are enabled for the pool.
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 pool.
(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 pool was created, in UNIX epoch time format.
{'TwoWayChannelRole': 'string'}
Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.delete_pool(
PoolId='string'
)
string
[REQUIRED]
The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
dict
Response Syntax
{
'PoolArn': 'string',
'PoolId': 'string',
'Status': 'CREATING'|'ACTIVE'|'DELETING',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'SharedRoutesEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
PoolArn (string) --
The Amazon Resource Name (ARN) of the pool that was deleted.
PoolId (string) --
The PoolId of the pool that was deleted.
Status (string) --
The current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
MessageType (string) --
The message type that was associated with the deleted pool.
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 deleted pool.
SharedRoutesEnabled (boolean) --
Indicates whether shared routes are enabled for the pool.
CreatedTimestamp (datetime) --
The time when the pool was created, in UNIX epoch time format.
{'AccountLimits': {'Name': {'REGISTRATIONS',
'REGISTRATION_ATTACHMENTS',
'SENDER_IDS',
'VERIFIED_DESTINATION_NUMBERS'}}}
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Amazon Pinpoint quotas in the Amazon Pinpoint Developer Guide.
See also: AWS API Documentation
Request Syntax
client.describe_account_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
{
'AccountLimits': [
{
'Name': 'PHONE_NUMBERS'|'POOLS'|'CONFIGURATION_SETS'|'OPT_OUT_LISTS'|'SENDER_IDS'|'REGISTRATIONS'|'REGISTRATION_ATTACHMENTS'|'VERIFIED_DESTINATION_NUMBERS',
'Used': 123,
'Max': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AccountLimits (list) --
An array of AccountLimit objects that show the current spend limits.
(dict) --
The current resource quotas associated with an Amazon Web Services account.
Name (string) --
The name of the attribute to apply the account limit to.
Used (integer) --
The current amount that has been spent, in US dollars.
Max (integer) --
The Amazon Web Services set limit for that resource type, 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': {'two-way-channel-arn'}}}
Response {'PhoneNumbers': {'NumberType': {'SIMULATOR'},
'RegistrationId': 'string',
'TwoWayChannelRole': 'string'}}
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',
],
'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.
{'Filters': {'Name': {'two-way-channel-arn'}}}
Response {'Pools': {'TwoWayChannelRole': 'string'}}
Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.describe_pools(
PoolIds=[
'string',
],
Filters=[
{
'Name': 'status'|'message-type'|'two-way-enabled'|'self-managed-opt-outs-enabled'|'opt-out-list-name'|'shared-routes-enabled'|'deletion-protection-enabled'|'two-way-channel-arn',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
(string) --
list
An array of PoolFilter objects to filter the results.
(dict) --
The information for 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
{
'Pools': [
{
'PoolArn': 'string',
'PoolId': 'string',
'Status': 'CREATING'|'ACTIVE'|'DELETING',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'SharedRoutesEnabled': True|False,
'DeletionProtectionEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Pools (list) --
An array of PoolInformation objects that contain the details for the requested pools.
(dict) --
The information for a pool in an Amazon Web Services account.
PoolArn (string) --
The Amazon Resource Name (ARN) for the pool.
PoolId (string) --
The unique identifier for the pool.
Status (string) --
The current status of the pool.
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.
TwoWayEnabled (boolean) --
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 requests. For more information see Self-managed opt-outs
OptOutListName (string) --
The name of the OptOutList associated with the pool.
SharedRoutesEnabled (boolean) --
Allows you to enable shared routes on your pool.
By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
DeletionProtectionEnabled (boolean) --
When set to true the pool can't be deleted.
CreatedTimestamp (datetime) --
The time when the pool 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.
{'Filters': {'Name': {'registered', 'deletion-protection-enabled'}}}
Response {'SenderIds': {'DeletionProtectionEnabled': 'boolean',
'Registered': 'boolean',
'RegistrationId': 'string'}}
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an error is returned.
See also: AWS API Documentation
Request Syntax
client.describe_sender_ids(
SenderIds=[
{
'SenderId': 'string',
'IsoCountryCode': 'string'
},
],
Filters=[
{
'Name': 'sender-id'|'iso-country-code'|'message-type'|'deletion-protection-enabled'|'registered',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
An array of SenderIdAndCountry objects to search for.
(dict) --
The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.
SenderId (string) -- [REQUIRED]
The unique identifier of the sender.
IsoCountryCode (string) -- [REQUIRED]
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
list
An array of SenderIdFilter objects to filter the results.
(dict) --
The information for a sender ID 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 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
{
'SenderIds': [
{
'SenderIdArn': 'string',
'SenderId': 'string',
'IsoCountryCode': 'string',
'MessageTypes': [
'TRANSACTIONAL'|'PROMOTIONAL',
],
'MonthlyLeasingPrice': 'string',
'DeletionProtectionEnabled': True|False,
'Registered': True|False,
'RegistrationId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SenderIds (list) --
An array of SernderIdInformation objects that contain the details for the requested SenderIds.
(dict) --
The information for all SenderIds in an Amazon Web Services account.
SenderIdArn (string) --
The Amazon Resource Name (ARN) associated with the SenderId.
SenderId (string) --
The alphanumeric sender ID in a specific country that you'd like to describe.
IsoCountryCode (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageTypes (list) --
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.
(string) --
MonthlyLeasingPrice (string) --
The monthly leasing price, in US dollars.
DeletionProtectionEnabled (boolean) --
By default this is set to false. When set to true the sender ID can't be deleted.
Registered (boolean) --
True if the sender ID is registered.
RegistrationId (string) --
The unique identifier for the registration.
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': {'PhoneNumber': 'string'}}
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',
],
'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.
{'NumberType': {'SIMULATOR'},
'RegistrationId': 'string',
'TwoWayChannelRole': 'string'}
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',
],
'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.
{'NumberType': {'SIMULATOR'}}
Response {'NumberType': {'SIMULATOR'},
'RegistrationId': 'string',
'TwoWayChannelRole': 'string'}
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',
],
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',
],
'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.
{'TwoWayChannelRole': 'string'}
Response {'NumberType': {'SIMULATOR'},
'RegistrationId': 'string',
'TwoWayChannelRole': 'string'}
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',
],
'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.
{'TwoWayChannelRole': 'string'}
Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
See also: AWS API Documentation
Request Syntax
client.update_pool(
PoolId='string',
TwoWayEnabled=True|False,
TwoWayChannelArn='string',
TwoWayChannelRole='string',
SelfManagedOptOutsEnabled=True|False,
OptOutListName='string',
SharedRoutesEnabled=True|False,
DeletionProtectionEnabled=True|False
)
string
[REQUIRED]
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
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 associate with the pool. Valid values are either OptOutListName or OptOutListArn.
boolean
Indicates whether shared routes are enabled for the pool.
boolean
When set to true the pool can't be deleted.
dict
Response Syntax
{
'PoolArn': 'string',
'PoolId': 'string',
'Status': 'CREATING'|'ACTIVE'|'DELETING',
'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
'TwoWayEnabled': True|False,
'TwoWayChannelArn': 'string',
'TwoWayChannelRole': 'string',
'SelfManagedOptOutsEnabled': True|False,
'OptOutListName': 'string',
'SharedRoutesEnabled': True|False,
'DeletionProtectionEnabled': True|False,
'CreatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
PoolArn (string) --
The ARN of the pool.
PoolId (string) --
The unique identifier of the pool.
Status (string) --
The current status of the pool update request.
MessageType (string) --
The type of message for the pool to use.
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) --
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 associated with the pool.
SharedRoutesEnabled (boolean) --
Indicates whether shared routes are enabled for the pool.
DeletionProtectionEnabled (boolean) --
When set to true the pool can't be deleted.
CreatedTimestamp (datetime) --
The time when the pool was created, in UNIX epoch time format.