2026/10/01 - AWS End User Messaging - 27 new api methods
Changes AWS End User Messaging now supports Brand profiles and Notify code configurations. Brand profiles capture your sender details once to reuse across phone number registrations. Notify code configurations let you define your OTP policy and delivery settings to send passcodes in minutes.
Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
maxResults=123,
nextToken='string',
status='SUCCESS'|'PROCESSING'|'FAILED',
brandProfileId='string',
operationType='string'
)
integer
The maximum number of results to return per page.
string
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
string
Filters the results to jobs that have the specified status.
string
Filters the results to jobs for the specified brand profile.
string
Filters the results to jobs of the specified operation type.
dict
Response Syntax
{
'jobs': [
{
'jobId': 'string',
'status': 'SUCCESS'|'PROCESSING'|'FAILED',
'operationType': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'brandProfileId': 'string',
'errorCode': 'string',
'errorMessage': 'string',
'resources': [
{
'resourceType': 'REGISTRATION'|'BRAND_PROFILE',
'resourceId': 'string',
'resourceArn': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobs (list) --
The list of asynchronous jobs.
(dict) --
Contains summary information about an asynchronous job in a list response.
jobId (string) --
The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
status (string) --
The current lifecycle status of the job.
operationType (string) --
The type of mutating operation that created the job.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
brandProfileId (string) --
The brand profile that the job operates on. This value is absent for operations that create a brand profile.
errorCode (string) --
A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.
errorMessage (string) --
A human-readable description of why the job failed. This value is present only when the job status is FAILED.
resources (list) --
The resources that were created or updated by the job.
(dict) --
Contains information about a resource that was created or updated by an asynchronous job.
resourceType (string) --
The type of the resource that the job created or updated.
resourceId (string) --
The identifier of the resource that the job created or updated.
resourceArn (string) --
The Amazon Resource Name (ARN) of the resource.
nextToken (string) --
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
Retrieves the tags that are associated with a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
tags (list) --
An array of key and value pair tags that are associated with the resource.
(dict) --
Describes a tag as a key and value pair that you can associate with a resource.
key (string) --
The key of the tag.
value (string) --
The value of the tag.
Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.
See also: AWS API Documentation
Request Syntax
client.update_brand_profile(
brandProfileId='string',
brandProfileName='string',
deletionProtectionEnabled=True|False
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
string
The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
boolean
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
dict
Response Syntax
{
'brandProfileId': 'string',
'brandProfileArn': 'string',
'brandProfileName': 'string',
'status': 'ACTIVE'|'BLOCKED'|'PAUSED'|'CANCELLED'|'FAILED',
'deletionProtectionEnabled': True|False,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
brandProfileId (string) --
The unique identifier of the brand profile.
brandProfileArn (string) --
The Amazon Resource Name (ARN) of the brand profile.
brandProfileName (string) --
The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
status (string) --
The current lifecycle status of the brand profile.
deletionProtectionEnabled (boolean) --
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
Retrieves a single brand profile attribute.
See also: AWS API Documentation
Request Syntax
client.get_brand_profile_attribute(
brandProfileId='string',
attributeName='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
string
[REQUIRED]
The name of the brand profile attribute. The name is unique within a brand profile.
dict
Response Syntax
{
'attributeName': 'string',
'attributeType': 'TEXT'|'IMAGE'|'DOCUMENT',
'attributeValue': 'string',
'description': 'string',
'category': 'string',
'mediaContentType': 'string',
'mediaSizeBytes': 123,
'mediaDownloadUrl': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
attributeName (string) --
The name of the brand profile attribute. The name is unique within a brand profile.
attributeType (string) --
The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
attributeValue (string) --
The text value of the attribute. This value applies to attributes of type TEXT.
description (string) --
A description of the attribute.
category (string) --
The category of the attribute.
mediaContentType (string) --
The MIME content type of the attribute media.
mediaSizeBytes (integer) --
The size of the attribute media, in bytes.
mediaDownloadUrl (string) --
A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.
See also: AWS API Documentation
Request Syntax
client.create_brand_profile(
brandProfileName='string',
clientToken='string',
deletionProtectionEnabled=True|False,
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
This field is autopopulated if not provided.
boolean
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
list
An array of key and value pair tags that are associated with the resource.
(dict) --
Describes a tag as a key and value pair that you can associate with a resource.
key (string) -- [REQUIRED]
The key of the tag.
value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'brandProfileId': 'string',
'brandProfileArn': 'string',
'brandProfileName': 'string',
'status': 'ACTIVE'|'BLOCKED'|'PAUSED'|'CANCELLED'|'FAILED',
'deletionProtectionEnabled': True|False,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'attributesCreated': 123
}
Response Structure
(dict) --
brandProfileId (string) --
The unique identifier of the brand profile.
brandProfileArn (string) --
The Amazon Resource Name (ARN) of the brand profile.
brandProfileName (string) --
The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
status (string) --
The current lifecycle status of the brand profile.
deletionProtectionEnabled (boolean) --
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
attributesCreated (integer) --
The number of default attributes that were created for the brand profile.
Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.
See also: AWS API Documentation
Request Syntax
client.list_brand_profiles(
nextToken='string',
maxResults=123
)
string
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
integer
The maximum number of results to return per page.
dict
Response Syntax
{
'brandProfiles': [
{
'brandProfileId': 'string',
'brandProfileArn': 'string',
'brandProfileName': 'string',
'status': 'ACTIVE'|'BLOCKED'|'PAUSED'|'CANCELLED'|'FAILED',
'deletionProtectionEnabled': True|False,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
brandProfiles (list) --
The list of brand profiles.
(dict) --
Contains information about a brand profile.
brandProfileId (string) --
The unique identifier of the brand profile.
brandProfileArn (string) --
The Amazon Resource Name (ARN) of the brand profile.
brandProfileName (string) --
The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
status (string) --
The current lifecycle status of the brand profile.
deletionProtectionEnabled (boolean) --
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
nextToken (string) --
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.
See also: AWS API Documentation
Request Syntax
client.update_notify_code_configuration(
notifyCodeConfigurationId='string',
notifyCodeConfigurationName='string',
codeConfigurationParameters={
'codeType': 'NUMERIC'|'ALPHA'|'ALPHANUMERIC',
'codeLength': 123,
'validityPeriodMinutes': 123,
'maxAttempts': 123
},
channelParameters={
'text': {
'inlineTemplateBody': 'string',
'destinationCountryParameters': {
'string': 'string'
}
},
'voice': {
'inlineTemplateBody': 'string',
'languageCode': 'string',
'voiceId': 'string',
'voiceMessageBodyTextType': 'TEXT'|'SSML'
},
'notify': {
'notifyTemplateId': 'string',
'voiceId': 'string'
},
'whatsApp': {
'whatsAppTemplateName': 'string',
'languageCode': 'string'
}
},
deletionProtectionEnabled=True|False
)
string
[REQUIRED]
The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).
string
The name of the notify code configuration.
dict
The updated passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. When you omit a member, its current value is preserved.
codeType (string) --
The updated character set used to generate the one-time passcode. Omit this member to preserve the current value.
codeLength (integer) --
The updated number of characters in the one-time passcode. Valid values range from 4 through 8. Omit this member to preserve the current value.
validityPeriodMinutes (integer) --
The updated length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. Omit this member to preserve the current value.
maxAttempts (integer) --
The updated maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. Omit this member to preserve the current value.
dict
The updated channel-specific parameters used to render and deliver the one-time passcode. This is a loose, nested update: when you omit a channel, that channel's parameters remain unchanged. Within a supplied channel, an empty string on a string member, or an empty map on the destination-country parameters, clears the currently stored value, and absent members preserve the current value.
text (dict) --
The text-channel parameters to update. Omit this member to leave the text-channel parameters unchanged.
inlineTemplateBody (string) --
The updated freeform SMS or RCS template body. An empty string clears the previously stored value.
destinationCountryParameters (dict) --
The updated map of country-specific parameters that control one-time passcode delivery. An empty map clears the previously stored value.
(string) --
Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
(string) --
Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
voice (dict) --
The voice-channel parameters to update. Omit this member to leave the voice-channel parameters unchanged.
inlineTemplateBody (string) --
The updated freeform voice template body. An empty string clears the previously stored value.
languageCode (string) --
The updated BCP 47 language code. An empty string clears the previously stored value.
voiceId (string) --
The updated Amazon Polly voice ID. An empty string clears the previously stored value.
voiceMessageBodyTextType (string) --
The updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.
notify (dict) --
The notify-template-route parameters to update. Omit this member to leave them unchanged.
notifyTemplateId (string) --
The updated identifier of a preapproved notify template for the SMS or voice channels. An empty string clears the previously stored value.
voiceId (string) --
The updated Amazon Polly voice ID. An empty string clears the previously stored value.
whatsApp (dict) --
The WhatsApp-channel parameters to update. Omit this member to leave the WhatsApp-channel parameters unchanged.
whatsAppTemplateName (string) --
The updated name of the Meta-approved WhatsApp authentication template. An empty string clears the previously stored value.
languageCode (string) --
The updated BCP 47 language code. An empty string clears the previously stored value.
boolean
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
dict
Response Syntax
{
'notifyCodeConfiguration': {
'notifyCodeConfigurationId': 'string',
'notifyCodeConfigurationArn': 'string',
'notifyCodeConfigurationName': 'string',
'codeConfigurationParameters': {
'codeType': 'NUMERIC'|'ALPHA'|'ALPHANUMERIC',
'codeLength': 123,
'validityPeriodMinutes': 123,
'maxAttempts': 123
},
'channelParameters': {
'text': {
'inlineTemplateBody': 'string',
'destinationCountryParameters': {
'string': 'string'
}
},
'voice': {
'inlineTemplateBody': 'string',
'languageCode': 'string',
'voiceId': 'string',
'voiceMessageBodyTextType': 'TEXT'|'SSML'
},
'notify': {
'notifyTemplateId': 'string',
'voiceId': 'string'
},
'whatsApp': {
'whatsAppTemplateName': 'string',
'languageCode': 'string'
}
},
'deletionProtectionEnabled': True|False,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
notifyCodeConfiguration (dict) --
The notify code configuration resource.
notifyCodeConfigurationId (string) --
The unique identifier of the notify code configuration.
notifyCodeConfigurationArn (string) --
The Amazon Resource Name (ARN) of the notify code configuration.
notifyCodeConfigurationName (string) --
The name of the notify code configuration.
codeConfigurationParameters (dict) --
The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.
codeType (string) --
The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
codeLength (integer) --
The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
validityPeriodMinutes (integer) --
The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
maxAttempts (integer) --
The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
channelParameters (dict) --
The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.
text (dict) --
The parameters for the text channel, which delivers over SMS or RCS.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.
destinationCountryParameters (dict) --
A map of country-specific parameters that control one-time passcode delivery.
(string) --
Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
(string) --
Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
voice (dict) --
The parameters for the voice channel.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.
languageCode (string) --
The BCP 47 language code used to render the voice message.
voiceId (string) --
The Amazon Polly voice ID used for the voice channel.
voiceMessageBodyTextType (string) --
The format of the voice message body. Valid values are TEXT and SSML.
notify (dict) --
The parameters for the preapproved notify-template route over the SMS or voice channels.
notifyTemplateId (string) --
The identifier of a preapproved notify template for the SMS or voice channels.
voiceId (string) --
The Amazon Polly voice ID used when the notify template is delivered over the voice channel.
whatsApp (dict) --
The parameters for the WhatsApp channel.
whatsAppTemplateName (string) --
The name of the Meta-approved WhatsApp authentication template.
languageCode (string) --
The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.
deletionProtectionEnabled (boolean) --
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.
See also: AWS API Documentation
Request Syntax
client.validate_notify_code_verification(
destinationIdentity='string',
referenceId='string',
code='string'
)
string
[REQUIRED]
The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
string
The caller-supplied reference identifier used to locate the verification. This value must match the value that you supplied to the SendNotifyCodeVerification operation.
string
[REQUIRED]
The one-time passcode that the recipient submitted for validation.
dict
Response Syntax
{
'status': 'VALID'|'INVALID'
}
Response Structure
(dict) --
status (string) --
The outcome of the validation attempt. VALID indicates that the submitted passcode matched an active verification. INVALID indicates that the passcode did not match, expired, or exceeded its attempt limit.
Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.
See also: AWS API Documentation
Request Syntax
client.delete_brand_profile_attribute(
brandProfileId='string',
attributeName='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
string
[REQUIRED]
The name of the brand profile attribute. The name is unique within a brand profile.
dict
Response Syntax
{
'brandProfileId': 'string',
'attributeName': 'string'
}
Response Structure
(dict) --
brandProfileId (string) --
The unique identifier of the brand profile.
attributeName (string) --
The name of the brand profile attribute. The name is unique within a brand profile.
Retrieves a paginated list of the notify code configurations in your account.
See also: AWS API Documentation
Request Syntax
client.list_notify_code_configurations(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return per page.
string
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
dict
Response Syntax
{
'notifyCodeConfigurations': [
{
'notifyCodeConfigurationId': 'string',
'notifyCodeConfigurationArn': 'string',
'notifyCodeConfigurationName': 'string',
'codeConfigurationParameters': {
'codeType': 'NUMERIC'|'ALPHA'|'ALPHANUMERIC',
'codeLength': 123,
'validityPeriodMinutes': 123,
'maxAttempts': 123
},
'channelParameters': {
'text': {
'inlineTemplateBody': 'string',
'destinationCountryParameters': {
'string': 'string'
}
},
'voice': {
'inlineTemplateBody': 'string',
'languageCode': 'string',
'voiceId': 'string',
'voiceMessageBodyTextType': 'TEXT'|'SSML'
},
'notify': {
'notifyTemplateId': 'string',
'voiceId': 'string'
},
'whatsApp': {
'whatsAppTemplateName': 'string',
'languageCode': 'string'
}
},
'deletionProtectionEnabled': True|False,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
notifyCodeConfigurations (list) --
The list of notify code configurations.
(dict) --
Contains the settings of a notify code configuration, which is a reusable one-time passcode policy.
notifyCodeConfigurationId (string) --
The unique identifier of the notify code configuration.
notifyCodeConfigurationArn (string) --
The Amazon Resource Name (ARN) of the notify code configuration.
notifyCodeConfigurationName (string) --
The name of the notify code configuration.
codeConfigurationParameters (dict) --
The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.
codeType (string) --
The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
codeLength (integer) --
The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
validityPeriodMinutes (integer) --
The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
maxAttempts (integer) --
The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
channelParameters (dict) --
The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.
text (dict) --
The parameters for the text channel, which delivers over SMS or RCS.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.
destinationCountryParameters (dict) --
A map of country-specific parameters that control one-time passcode delivery.
(string) --
Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
(string) --
Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
voice (dict) --
The parameters for the voice channel.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.
languageCode (string) --
The BCP 47 language code used to render the voice message.
voiceId (string) --
The Amazon Polly voice ID used for the voice channel.
voiceMessageBodyTextType (string) --
The format of the voice message body. Valid values are TEXT and SSML.
notify (dict) --
The parameters for the preapproved notify-template route over the SMS or voice channels.
notifyTemplateId (string) --
The identifier of a preapproved notify template for the SMS or voice channels.
voiceId (string) --
The Amazon Polly voice ID used when the notify template is delivered over the voice channel.
whatsApp (dict) --
The parameters for the WhatsApp channel.
whatsAppTemplateName (string) --
The name of the Meta-approved WhatsApp authentication template.
languageCode (string) --
The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.
deletionProtectionEnabled (boolean) --
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
nextToken (string) --
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.
See also: AWS API Documentation
Request Syntax
client.create_brand_profile_attributes(
brandProfileId='string',
attributes=[
{
'attributeName': 'string',
'attributeType': 'TEXT'|'IMAGE'|'DOCUMENT',
'attributeValue': 'string',
'attachmentBody': b'bytes',
'description': 'string',
'category': 'string'
},
],
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
list
[REQUIRED]
The brand profile attributes.
(dict) --
Specifies an attribute to create for a brand profile.
attributeName (string) -- [REQUIRED]
The name of the brand profile attribute. The name is unique within a brand profile.
attributeType (string) -- [REQUIRED]
The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
attributeValue (string) --
The text value for the attribute. This value applies to attributes of type TEXT. For attributes of type IMAGE or DOCUMENT, provide the media through the attachment body instead.
attachmentBody (bytes) --
The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.
description (string) --
A description of the attribute.
category (string) --
The category of the attribute.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
This field is autopopulated if not provided.
dict
Response Syntax
{
'attributes': [
{
'attributeName': 'string',
'attributeType': 'TEXT'|'IMAGE'|'DOCUMENT',
'mediaDownloadUrl': 'string'
},
]
}
Response Structure
(dict) --
attributes (list) --
The brand profile attributes.
(dict) --
Contains information about an attribute that was created for a brand profile.
attributeName (string) --
The name of the brand profile attribute. The name is unique within a brand profile.
attributeType (string) --
The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
mediaDownloadUrl (string) --
A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.
Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.
See also: AWS API Documentation
Request Syntax
client.get_job(
jobId='string'
)
string
[REQUIRED]
The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
dict
Response Syntax
{
'jobId': 'string',
'status': 'SUCCESS'|'PROCESSING'|'FAILED',
'operationType': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'brandProfileId': 'string',
'errorCode': 'string',
'errorMessage': 'string',
'resources': [
{
'resourceType': 'REGISTRATION'|'BRAND_PROFILE',
'resourceId': 'string',
'resourceArn': 'string'
},
]
}
Response Structure
(dict) --
Information about an async job tracked by the service. GetJob returns the full Job, which may grow detail-only fields that are not part of the JobSummary list view.
jobId (string) --
The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
status (string) --
The current lifecycle status of the job.
operationType (string) --
The type of mutating operation that created the job.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
brandProfileId (string) --
The brand profile that the job operates on. This value is absent for operations that create a brand profile.
errorCode (string) --
A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.
errorMessage (string) --
A human-readable description of why the job failed. This value is present only when the job status is FAILED.
resources (list) --
The resources that were created or updated by the job.
(dict) --
Contains information about a resource that was created or updated by an asynchronous job.
resourceType (string) --
The type of the resource that the job created or updated.
resourceId (string) --
The identifier of the resource that the job created or updated.
resourceArn (string) --
The Amazon Resource Name (ARN) of the resource.
Adds or overwrites the tags on a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
list
[REQUIRED]
An array of key and value pair tags that are associated with the resource.
(dict) --
Describes a tag as a key and value pair that you can associate with a resource.
key (string) -- [REQUIRED]
The key of the tag.
value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the value, description, or category of an existing brand profile attribute.
See also: AWS API Documentation
Request Syntax
client.update_brand_profile_attribute(
brandProfileId='string',
attributeName='string',
attributeValue='string',
attachmentBody=b'bytes',
description='string',
category='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
string
[REQUIRED]
The name of the brand profile attribute. The name is unique within a brand profile.
string
The text value of the attribute. This value applies to attributes of type TEXT.
bytes
The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.
string
A description of the attribute.
string
The category of the attribute.
dict
Response Syntax
{
'attributeName': 'string',
'attributeType': 'TEXT'|'IMAGE'|'DOCUMENT',
'attributeValue': 'string',
'description': 'string',
'category': 'string',
'mediaContentType': 'string',
'mediaSizeBytes': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
attributeName (string) --
The name of the brand profile attribute. The name is unique within a brand profile.
attributeType (string) --
The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
attributeValue (string) --
The text value of the attribute. This value applies to attributes of type TEXT.
description (string) --
A description of the attribute.
category (string) --
The category of the attribute.
mediaContentType (string) --
The MIME content type of the attribute media.
mediaSizeBytes (integer) --
The size of the attribute media, in bytes.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.
See also: AWS API Documentation
Request Syntax
client.create_brand_profile_from_registration(
registrationId='string',
brandProfileName='string',
smartMatch=True|False,
tags=[
{
'key': 'string',
'value': 'string'
},
],
clientToken='string'
)
string
[REQUIRED]
The identifier or Amazon Resource Name (ARN) of the registration to populate the brand profile from.
string
[REQUIRED]
The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
boolean
Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
list
An array of key and value pair tags that are associated with the resource.
(dict) --
Describes a tag as a key and value pair that you can associate with a resource.
key (string) -- [REQUIRED]
The key of the tag.
value (string) -- [REQUIRED]
The value of the tag.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
This field is autopopulated if not provided.
dict
Response Syntax
{
'results': [
{
'jobId': 'string',
'resourceIdentifier': 'string'
},
]
}
Response Structure
(dict) --
results (list) --
The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
(dict) --
Pairs an asynchronous job with the resource identifier from your request that the job processes.
jobId (string) --
The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
resourceIdentifier (string) --
The identifier from your request that this job is processing.
Retrieves a notify code configuration.
See also: AWS API Documentation
Request Syntax
client.get_notify_code_configuration(
notifyCodeConfigurationId='string'
)
string
[REQUIRED]
The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).
dict
Response Syntax
{
'notifyCodeConfiguration': {
'notifyCodeConfigurationId': 'string',
'notifyCodeConfigurationArn': 'string',
'notifyCodeConfigurationName': 'string',
'codeConfigurationParameters': {
'codeType': 'NUMERIC'|'ALPHA'|'ALPHANUMERIC',
'codeLength': 123,
'validityPeriodMinutes': 123,
'maxAttempts': 123
},
'channelParameters': {
'text': {
'inlineTemplateBody': 'string',
'destinationCountryParameters': {
'string': 'string'
}
},
'voice': {
'inlineTemplateBody': 'string',
'languageCode': 'string',
'voiceId': 'string',
'voiceMessageBodyTextType': 'TEXT'|'SSML'
},
'notify': {
'notifyTemplateId': 'string',
'voiceId': 'string'
},
'whatsApp': {
'whatsAppTemplateName': 'string',
'languageCode': 'string'
}
},
'deletionProtectionEnabled': True|False,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
notifyCodeConfiguration (dict) --
The notify code configuration resource.
notifyCodeConfigurationId (string) --
The unique identifier of the notify code configuration.
notifyCodeConfigurationArn (string) --
The Amazon Resource Name (ARN) of the notify code configuration.
notifyCodeConfigurationName (string) --
The name of the notify code configuration.
codeConfigurationParameters (dict) --
The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.
codeType (string) --
The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
codeLength (integer) --
The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
validityPeriodMinutes (integer) --
The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
maxAttempts (integer) --
The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
channelParameters (dict) --
The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.
text (dict) --
The parameters for the text channel, which delivers over SMS or RCS.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.
destinationCountryParameters (dict) --
A map of country-specific parameters that control one-time passcode delivery.
(string) --
Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
(string) --
Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
voice (dict) --
The parameters for the voice channel.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.
languageCode (string) --
The BCP 47 language code used to render the voice message.
voiceId (string) --
The Amazon Polly voice ID used for the voice channel.
voiceMessageBodyTextType (string) --
The format of the voice message body. Valid values are TEXT and SSML.
notify (dict) --
The parameters for the preapproved notify-template route over the SMS or voice channels.
notifyTemplateId (string) --
The identifier of a preapproved notify template for the SMS or voice channels.
voiceId (string) --
The Amazon Polly voice ID used when the notify template is delivered over the voice channel.
whatsApp (dict) --
The parameters for the WhatsApp channel.
whatsAppTemplateName (string) --
The name of the Meta-approved WhatsApp authentication template.
languageCode (string) --
The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.
deletionProtectionEnabled (boolean) --
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
Creates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered, including the code type, length, validity period, maximum number of attempts, and channel templates.
See also: AWS API Documentation
Request Syntax
client.create_notify_code_configuration(
notifyCodeConfigurationName='string',
codeConfigurationParameters={
'codeType': 'NUMERIC'|'ALPHA'|'ALPHANUMERIC',
'codeLength': 123,
'validityPeriodMinutes': 123,
'maxAttempts': 123
},
channelParameters={
'text': {
'inlineTemplateBody': 'string',
'destinationCountryParameters': {
'string': 'string'
}
},
'voice': {
'inlineTemplateBody': 'string',
'languageCode': 'string',
'voiceId': 'string',
'voiceMessageBodyTextType': 'TEXT'|'SSML'
},
'notify': {
'notifyTemplateId': 'string',
'voiceId': 'string'
},
'whatsApp': {
'whatsAppTemplateName': 'string',
'languageCode': 'string'
}
},
deletionProtectionEnabled=True|False,
clientToken='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The name of the notify code configuration.
dict
The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. Each member is optional. When you omit a member, no value is applied at create time and the default is applied when a passcode is sent.
codeType (string) --
The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
codeLength (integer) --
The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
validityPeriodMinutes (integer) --
The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
maxAttempts (integer) --
The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
dict
The channel-specific parameters used to render and deliver the one-time passcode. Provide parameters for any subset of channels. Each member configures one delivery route, and the route that is selected at send time uses the matching channel.
text (dict) --
The parameters for the text channel, which delivers over SMS or RCS.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.
destinationCountryParameters (dict) --
A map of country-specific parameters that control one-time passcode delivery.
(string) --
Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
(string) --
Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
voice (dict) --
The parameters for the voice channel.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.
languageCode (string) --
The BCP 47 language code used to render the voice message.
voiceId (string) --
The Amazon Polly voice ID used for the voice channel.
voiceMessageBodyTextType (string) --
The format of the voice message body. Valid values are TEXT and SSML.
notify (dict) --
The parameters for the preapproved notify-template route over the SMS or voice channels.
notifyTemplateId (string) --
The identifier of a preapproved notify template for the SMS or voice channels.
voiceId (string) --
The Amazon Polly voice ID used when the notify template is delivered over the voice channel.
whatsApp (dict) --
The parameters for the WhatsApp channel.
whatsAppTemplateName (string) --
The name of the Meta-approved WhatsApp authentication template.
languageCode (string) --
The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.
boolean
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
This field is autopopulated if not provided.
list
An array of key and value pair tags that are associated with the resource.
(dict) --
Describes a tag as a key and value pair that you can associate with a resource.
key (string) -- [REQUIRED]
The key of the tag.
value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'notifyCodeConfiguration': {
'notifyCodeConfigurationId': 'string',
'notifyCodeConfigurationArn': 'string',
'notifyCodeConfigurationName': 'string',
'codeConfigurationParameters': {
'codeType': 'NUMERIC'|'ALPHA'|'ALPHANUMERIC',
'codeLength': 123,
'validityPeriodMinutes': 123,
'maxAttempts': 123
},
'channelParameters': {
'text': {
'inlineTemplateBody': 'string',
'destinationCountryParameters': {
'string': 'string'
}
},
'voice': {
'inlineTemplateBody': 'string',
'languageCode': 'string',
'voiceId': 'string',
'voiceMessageBodyTextType': 'TEXT'|'SSML'
},
'notify': {
'notifyTemplateId': 'string',
'voiceId': 'string'
},
'whatsApp': {
'whatsAppTemplateName': 'string',
'languageCode': 'string'
}
},
'deletionProtectionEnabled': True|False,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
notifyCodeConfiguration (dict) --
The notify code configuration resource.
notifyCodeConfigurationId (string) --
The unique identifier of the notify code configuration.
notifyCodeConfigurationArn (string) --
The Amazon Resource Name (ARN) of the notify code configuration.
notifyCodeConfigurationName (string) --
The name of the notify code configuration.
codeConfigurationParameters (dict) --
The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.
codeType (string) --
The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
codeLength (integer) --
The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
validityPeriodMinutes (integer) --
The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
maxAttempts (integer) --
The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
channelParameters (dict) --
The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.
text (dict) --
The parameters for the text channel, which delivers over SMS or RCS.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.
destinationCountryParameters (dict) --
A map of country-specific parameters that control one-time passcode delivery.
(string) --
Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
(string) --
Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
voice (dict) --
The parameters for the voice channel.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.
languageCode (string) --
The BCP 47 language code used to render the voice message.
voiceId (string) --
The Amazon Polly voice ID used for the voice channel.
voiceMessageBodyTextType (string) --
The format of the voice message body. Valid values are TEXT and SSML.
notify (dict) --
The parameters for the preapproved notify-template route over the SMS or voice channels.
notifyTemplateId (string) --
The identifier of a preapproved notify template for the SMS or voice channels.
voiceId (string) --
The Amazon Polly voice ID used when the notify template is delivered over the voice channel.
whatsApp (dict) --
The parameters for the WhatsApp channel.
whatsAppTemplateName (string) --
The name of the Meta-approved WhatsApp authentication template.
languageCode (string) --
The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.
deletionProtectionEnabled (boolean) --
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.
See also: AWS API Documentation
Request Syntax
client.get_brand_profile(
brandProfileId='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
dict
Response Syntax
{
'brandProfileId': 'string',
'brandProfileArn': 'string',
'brandProfileName': 'string',
'status': 'ACTIVE'|'BLOCKED'|'PAUSED'|'CANCELLED'|'FAILED',
'deletionProtectionEnabled': True|False,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
brandProfileId (string) --
The unique identifier of the brand profile.
brandProfileArn (string) --
The Amazon Resource Name (ARN) of the brand profile.
brandProfileName (string) --
The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.
status (string) --
The current lifecycle status of the brand profile.
deletionProtectionEnabled (boolean) --
Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.
See also: AWS API Documentation
Request Syntax
client.delete_notify_code_configuration(
notifyCodeConfigurationId='string'
)
string
[REQUIRED]
The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is enabled for the profile.
See also: AWS API Documentation
Request Syntax
client.delete_brand_profile(
brandProfileId='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
dict
Response Syntax
{
'brandProfileId': 'string',
'brandProfileArn': 'string'
}
Response Structure
(dict) --
brandProfileId (string) --
The unique identifier of the brand profile.
brandProfileArn (string) --
The Amazon Resource Name (ARN) of the brand profile.
Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.
See also: AWS API Documentation
Request Syntax
client.update_registrations_from_brand_profile(
brandProfileId='string',
registrationIds=[
'string',
],
smartMatch=True|False,
onAttributeConflict='REPLACE'|'PRESERVE',
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
list
[REQUIRED]
The identifiers of the registrations.
(string) --
Registration identifier or ARN.
boolean
Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
string
Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
This field is autopopulated if not provided.
dict
Response Syntax
{
'results': [
{
'jobId': 'string',
'resourceIdentifier': 'string'
},
]
}
Response Structure
(dict) --
results (list) --
The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
(dict) --
Pairs an asynchronous job with the resource identifier from your request that the job processes.
jobId (string) --
The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
resourceIdentifier (string) --
The identifier from your request that this job is processing.
Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.
See also: AWS API Documentation
Request Syntax
client.list_registrations_from_brand_profile(
brandProfileId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
integer
The maximum number of results to return per page.
string
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
dict
Response Syntax
{
'registrationAssociations': [
{
'registrationId': 'string',
'registrationType': 'string',
'createdAt': datetime(2015, 1, 1),
'smartMatchUsed': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
registrationAssociations (list) --
The list of registrations that are associated with the brand profile.
(dict) --
Contains summary information about a registration that is associated with a brand profile.
registrationId (string) --
The identifier of the registration.
registrationType (string) --
The type of the registration, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
smartMatchUsed (boolean) --
Specifies whether smart matching was used to create the association.
nextToken (string) --
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.
See also: AWS API Documentation
Request Syntax
client.create_registrations_from_brand_profile(
brandProfileId='string',
registrationTypes=[
'string',
],
smartMatch=True|False,
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
list
[REQUIRED]
The registration types to create, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.
(string) --
Registration type identifier (e.g., US_TOLL_FREE_REGISTRATION, SENDER_ID).
boolean
Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
This field is autopopulated if not provided.
dict
Response Syntax
{
'results': [
{
'jobId': 'string',
'resourceIdentifier': 'string'
},
]
}
Response Structure
(dict) --
results (list) --
The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
(dict) --
Pairs an asynchronous job with the resource identifier from your request that the job processes.
jobId (string) --
The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
resourceIdentifier (string) --
The identifier from your request that this job is processing.
Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.
See also: AWS API Documentation
Request Syntax
client.send_notify_code_verification(
channel='TEXT'|'VOICE'|'WHATSAPP',
destinationIdentity='string',
originationIdentity='string',
notifyCodeConfiguration='string',
overrideChannelParameters={
'text': {
'inlineTemplateBody': 'string',
'destinationCountryParameters': {
'string': 'string'
}
},
'voice': {
'inlineTemplateBody': 'string',
'languageCode': 'string',
'voiceId': 'string',
'voiceMessageBodyTextType': 'TEXT'|'SSML'
},
'notify': {
'notifyTemplateId': 'string',
'voiceId': 'string'
},
'whatsApp': {
'whatsAppTemplateName': 'string',
'languageCode': 'string'
}
},
overrideCodeConfigurationParameters={
'codeType': 'NUMERIC'|'ALPHA'|'ALPHANUMERIC',
'codeLength': 123,
'validityPeriodMinutes': 123,
'maxAttempts': 123
},
configurationSetName='string',
context={
'string': 'string'
},
referenceId='string'
)
string
[REQUIRED]
The channel used to deliver the one-time passcode to the recipient.
string
[REQUIRED]
The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
string
[REQUIRED]
The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.
string
The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.
dict
The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.
text (dict) --
The parameters for the text channel, which delivers over SMS or RCS.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.
destinationCountryParameters (dict) --
A map of country-specific parameters that control one-time passcode delivery.
(string) --
Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
(string) --
Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.
voice (dict) --
The parameters for the voice channel.
inlineTemplateBody (string) --
The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.
languageCode (string) --
The BCP 47 language code used to render the voice message.
voiceId (string) --
The Amazon Polly voice ID used for the voice channel.
voiceMessageBodyTextType (string) --
The format of the voice message body. Valid values are TEXT and SSML.
notify (dict) --
The parameters for the preapproved notify-template route over the SMS or voice channels.
notifyTemplateId (string) --
The identifier of a preapproved notify template for the SMS or voice channels.
voiceId (string) --
The Amazon Polly voice ID used when the notify template is delivered over the voice channel.
whatsApp (dict) --
The parameters for the WhatsApp channel.
whatsAppTemplateName (string) --
The name of the Meta-approved WhatsApp authentication template.
languageCode (string) --
The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.
dict
The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.
codeType (string) --
The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
codeLength (integer) --
The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.
validityPeriodMinutes (integer) --
The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.
maxAttempts (integer) --
The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.
string
The name of the configuration set used to control how delivery events for the message are handled.
dict
A map of custom key and value pairs that are propagated to the delivery events for this verification.
(string) --
Caller-supplied context propagated to delivery events for this verification.
(string) --
Caller-supplied context value. Blank space is not allowed at the front or end.
string
A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.
dict
Response Syntax
{
'verificationId': 'string',
'messageId': 'string'
}
Response Structure
(dict) --
verificationId (string) --
The service-generated identifier for the verification.
messageId (string) --
The service-generated identifier for the message that delivers the one-time passcode.
Imports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.
See also: AWS API Documentation
Request Syntax
client.update_brand_profile_from_registration(
brandProfileId='string',
registrationId='string',
smartMatch=True|False,
onAttributeConflict='REPLACE'|'PRESERVE',
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
string
[REQUIRED]
The identifier or Amazon Resource Name (ARN) of the registration to import attributes from.
boolean
Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
string
Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.
This field is autopopulated if not provided.
dict
Response Syntax
{
'results': [
{
'jobId': 'string',
'resourceIdentifier': 'string'
},
]
}
Response Structure
(dict) --
results (list) --
The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
(dict) --
Pairs an asynchronous job with the resource identifier from your request that the job processes.
jobId (string) --
The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
resourceIdentifier (string) --
The identifier from your request that this job is processing.
Removes the specified tags from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
list
[REQUIRED]
The list of tag keys to remove from the resource.
(string) --
The key of the tag. Tag keys are case-sensitive and must be unique per resource.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a paginated list of the attributes for a brand profile.
See also: AWS API Documentation
Request Syntax
client.list_brand_profile_attributes(
brandProfileId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
string
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.
integer
The maximum number of results to return per page.
dict
Response Syntax
{
'brandProfileAttributes': [
{
'attributeName': 'string',
'attributeType': 'TEXT'|'IMAGE'|'DOCUMENT',
'description': 'string',
'category': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
brandProfileAttributes (list) --
The list of brand profile attributes.
(dict) --
Contains summary information about a brand profile attribute in a list response.
attributeName (string) --
The name of the brand profile attribute. The name is unique within a brand profile.
attributeType (string) --
The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
description (string) --
A description of the attribute.
category (string) --
The category of the attribute.
createdAt (datetime) --
The time when the resource was created, in Unix epoch time.
updatedAt (datetime) --
The time when the resource was last updated, in Unix epoch time.
nextToken (string) --
The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.