String reason
The reason for the exception.
String poolId
The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
String originationIdentity
The origination identity to use, such as 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 isoCountryCode
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
String clientToken
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.
String poolArn
The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
String poolId
The PoolId of the pool that is now associated with the origination identity.
String originationIdentityArn
The PhoneNumberArn or SenderIdArn of the origination identity.
String originationIdentity
The PhoneNumberId or SenderId of the origination identity.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
String configurationSetArn
The Resource Name (ARN) of the ConfigurationSet.
String configurationSetName
The name of the ConfigurationSet.
List<E> eventDestinations
An array of EventDestination objects that describe any events to log and where to log them.
String defaultMessageType
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 defaultSenderId
The default sender ID used by the ConfigurationSet.
Date createdTimestamp
The time when the ConfigurationSet was created, in UNIX epoch time format.
String configurationSetName
The name to use for the new configuration set.
List<E> tags
An array of key and value pair tags that's associated with the new configuration set.
String clientToken
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.
String configurationSetArn
The Amazon Resource Name (ARN) of the newly created configuration set.
String configurationSetName
The name of the new configuration set.
List<E> tags
An array of key and value pair tags that's associated with the configuration set.
Date createdTimestamp
The time when the configuration set was created, in UNIX epoch time format.
String configurationSetName
Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
String eventDestinationName
The name that identifies the event destination.
List<E> matchingEventTypes
An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.
CloudWatchLogsDestination cloudWatchLogsDestination
An object that contains information about an event destination for logging to Amazon CloudWatch logs.
KinesisFirehoseDestination kinesisFirehoseDestination
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
SnsDestination snsDestination
An object that contains information about an event destination for logging to Amazon SNS.
String clientToken
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.
String configurationSetArn
The ARN of the configuration set.
String configurationSetName
The name of the configuration set.
EventDestination eventDestination
The details of the destination where events are logged.
String optOutListName
The name of the new OptOutList.
List<E> tags
An array of tags (key and value pairs) to associate with the new OptOutList.
String clientToken
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.
String optOutListArn
The Amazon Resource Name (ARN) for the OptOutList.
String optOutListName
The name of the new OptOutList.
List<E> tags
An array of tags (key and value pairs) associated with the new OptOutList.
Date createdTimestamp
The time when the pool was created, in UNIX epoch time format.
String originationIdentity
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 isoCountryCode
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
String messageType
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 deletionProtectionEnabled
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<E> tags
An array of tags (key and value pairs) associated with the pool.
String clientToken
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.
String poolArn
The Amazon Resource Name (ARN) for the pool.
String poolId
The unique identifier for the pool.
String status
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.
String messageType
The type of message for the pool to use.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
Boolean selfManagedOptOutsEnabled
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 optOutListName
The name of the OptOutList associated with the pool.
Boolean sharedRoutesEnabled
Indicates whether shared routes are enabled for the pool.
Boolean deletionProtectionEnabled
When set to true deletion protection is enabled. By default this is set to false.
List<E> tags
An array of tags (key and value pairs) associated with the pool.
Date createdTimestamp
The time when the pool was created, in UNIX epoch time format.
String configurationSetName
The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
String configurationSetArn
The Amazon Resource Name (ARN) of the deleted configuration set.
String configurationSetName
The name of the deleted configuration set.
List<E> eventDestinations
An array of any EventDestination objects that were associated with the deleted configuration set.
String defaultMessageType
The default message type of the configuration set that was deleted.
String defaultSenderId
The default Sender ID of the configuration set that was deleted.
Date createdTimestamp
The time that the deleted configuration set was created in UNIX epoch time format.
String configurationSetName
The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
String configurationSetName
The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
String configurationSetName
The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
String eventDestinationName
The name of the event destination to delete.
String configurationSetArn
The Amazon Resource Name (ARN) of the configuration set.
String configurationSetName
The name of the configuration set the event destination was deleted from.
EventDestination eventDestination
The event destination object that was deleted.
String originationIdentity
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
String keyword
The keyword to delete.
String originationIdentityArn
The PhoneNumberArn or PoolArn that the keyword was associated with.
String originationIdentity
The PhoneNumberId or PoolId that the keyword was associated with.
String keyword
The keyword that was deleted.
String keywordMessage
The message that was associated with the deleted keyword.
String keywordAction
The action that was associated with the deleted keyword.
String optOutListArn
The OptOutListArn that the phone number was removed from.
String optOutListName
The OptOutListName that the phone number was removed from.
String optedOutNumber
The phone number that was removed from the OptOutList.
Date optedOutTimestamp
The time that the number was removed at, in UNIX epoch time format.
Boolean endUserOptedOut
This is true if it was the end user who requested their phone number be removed.
String optOutListName
The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
String optOutListArn
The Amazon Resource Name (ARN) of the OptOutList that was removed.
String optOutListName
The name of the OptOutList that was removed.
Date createdTimestamp
The time when the OptOutList was created, in UNIX epoch time format.
String poolId
The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
String poolArn
The Amazon Resource Name (ARN) of the pool that was deleted.
String poolId
The PoolId of the pool that was deleted.
String status
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.
String messageType
The message type that was associated with the deleted pool.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the TwoWayChannel.
Boolean selfManagedOptOutsEnabled
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 optOutListName
The name of the OptOutList that was associated with the deleted pool.
Boolean sharedRoutesEnabled
Indicates whether shared routes are enabled for the pool.
Date createdTimestamp
The time when the pool was created, in UNIX epoch time format.
Long monthlyLimit
The current monthly limit, in US dollars.
Long monthlyLimit
The current monthly limit, in US dollars.
List<E> configurationSetNames
An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
List<E> filters
An array of filters to apply to the results that are returned.
String nextToken
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 maxResults
The maximum number of results to return per each request.
String originationIdentity
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.
List<E> keywords
An array of keywords to search for.
List<E> filters
An array of keyword filters to filter the results.
String nextToken
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 maxResults
The maximum number of results to return per each request.
String originationIdentityArn
The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
String originationIdentity
The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
List<E> keywords
An array of KeywordInformation objects that contain the results.
String nextToken
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
String optOutListName
The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
List<E> optedOutNumbers
An array of phone numbers to search for in the OptOutList.
List<E> filters
An array of OptedOutFilter objects to filter the results on.
String nextToken
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 maxResults
The maximum number of results to return per each request.
String optOutListArn
The Amazon Resource Name (ARN) of the OptOutList.
String optOutListName
The name of the OptOutList.
List<E> optedOutNumbers
An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
String nextToken
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
List<E> optOutListNames
The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
String nextToken
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 maxResults
The maximum number of results to return per each request.
List<E> phoneNumberIds
The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
List<E> filters
An array of PhoneNumberFilter objects to filter the results.
String nextToken
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 maxResults
The maximum number of results to return per each request.
List<E> poolIds
The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
List<E> filters
An array of PoolFilter objects to filter the results.
String nextToken
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 maxResults
The maximum number of results to return per each request.
List<E> senderIds
An array of SenderIdAndCountry objects to search for.
List<E> filters
An array of SenderIdFilter objects to filter the results.
String nextToken
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 maxResults
The maximum number of results to return per each request.
String poolId
The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
String originationIdentity
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
String clientToken
Unique, case-sensitive identifier 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.
String poolArn
The Amazon Resource Name (ARN) of the pool.
String poolId
The PoolId of the pool no longer associated with the origination identity.
String originationIdentityArn
The PhoneNumberArn or SenderIdArn of the origination identity.
String originationIdentity
The PhoneNumberId or SenderId of the origination identity.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
String eventDestinationName
The name of the EventDestination.
Boolean enabled
When set to true events will be logged.
List<E> matchingEventTypes
An array of event types that determine which events to log.
CloudWatchLogsDestination cloudWatchLogsDestination
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
KinesisFirehoseDestination kinesisFirehoseDestination
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
SnsDestination snsDestination
An object that contains information about an event destination that sends logging events to Amazon SNS.
String requestId
The unique identifier of the request.
String poolId
The unique identifier for the pool. This value can be either the PoolId or PoolArn.
List<E> filters
An array of PoolOriginationIdentitiesFilter objects to filter the results..
String nextToken
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 maxResults
The maximum number of results to return per each request.
String poolArn
The Amazon Resource Name (ARN) for the pool.
String poolId
The unique PoolId of the pool.
List<E> originationIdentities
An array of any OriginationIdentityMetadata objects.
String nextToken
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
String resourceArn
The Amazon Resource Name (ARN) of the resource to query for.
String optedOutNumber
The phone number that is opted out.
Date optedOutTimestamp
The time that the op tout occurred, in UNIX epoch time format.
Boolean endUserOptedOut
This is set to true if it was the end recipient that opted out.
String optOutListArn
The Amazon Resource Name (ARN) of the OptOutList.
String optOutListName
The name of the OptOutList.
Date createdTimestamp
The time when the OutOutList was created, in UNIX epoch time format.
String originationIdentityArn
The Amazon Resource Name (ARN) associated with the origination identity.
String originationIdentity
The unique identifier of the origination identity.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
List<E> numberCapabilities
Describes if the origination identity can be used for text messages, voice calls or both.
String phoneNumberArn
The Amazon Resource Name (ARN) associated with the phone number.
String phoneNumberId
The unique identifier for the phone number.
String phoneNumber
The phone number in E.164 format.
String status
The current status of the phone number.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
String messageType
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<E> numberCapabilities
Describes if the origination identity can be used for text messages, voice calls or both.
String numberType
The type of phone number.
String monthlyLeasingPrice
The price, in US dollars, to lease the phone number.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
Boolean selfManagedOptOutsEnabled
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
String optOutListName
The name of the OptOutList associated with the phone number.
Boolean deletionProtectionEnabled
When set to true the phone number can't be deleted.
String poolId
The unique identifier of the pool associated with the phone number.
Date createdTimestamp
The time when the phone number was created, in UNIX epoch time format.
String poolArn
The Amazon Resource Name (ARN) for the pool.
String poolId
The unique identifier for the pool.
String status
The current status of the pool.
String messageType
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 twoWayEnabled
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
Boolean selfManagedOptOutsEnabled
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
String optOutListName
The name of the OptOutList associated with the pool.
Boolean sharedRoutesEnabled
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.
Boolean deletionProtectionEnabled
When set to true the pool can't be deleted.
Date createdTimestamp
The time when the pool was created, in UNIX epoch time format.
String originationIdentity
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
String keyword
The new keyword to add.
String keywordMessage
The message associated with the keyword.
AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.
String keywordAction
The action to perform for the new keyword when it is received.
String originationIdentityArn
The PhoneNumberArn or PoolArn that the keyword was associated with.
String originationIdentity
The PhoneNumberId or PoolId that the keyword was associated with.
String keyword
The keyword that was added.
String keywordMessage
The message associated with the keyword.
String keywordAction
The action to perform when the keyword is used.
String optOutListArn
The OptOutListArn that the phone number was removed from.
String optOutListName
The OptOutListName that the phone number was removed from.
String optedOutNumber
The phone number that was added to the OptOutList.
Date optedOutTimestamp
The time that the phone number was added to the OptOutList, in UNIX epoch time format.
Boolean endUserOptedOut
This is true if it was the end user who requested their phone number be removed.
String phoneNumberId
The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
String phoneNumberArn
The PhoneNumberArn of the phone number that was released.
String phoneNumberId
The PhoneNumberId of the phone number that was released.
String phoneNumber
The phone number that was released.
String status
The current status of the request.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
String messageType
The message type that was associated with the phone number.
List<E> numberCapabilities
Specifies if the number could be used for text messages, voice, or both.
String numberType
The type of number that was released.
String monthlyLeasingPrice
The monthly price of the phone number, in US dollars.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the TwoWayChannel.
Boolean selfManagedOptOutsEnabled
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 optOutListName
The name of the OptOutList that was associated with the phone number.
Date createdTimestamp
The time when the phone number was created, in UNIX epoch time format.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
String messageType
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<E> numberCapabilities
Indicates if the phone number will be used for text messages, voice messages, or both.
String numberType
The type of phone number to request.
String optOutListName
The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.
String poolId
The pool to associated with the phone number. You can use the PoolId or PoolArn.
String registrationId
Use this field to attach your phone number for an external registration process.
Boolean deletionProtectionEnabled
By default this is set to false. When set to true the phone number can't be deleted.
List<E> tags
An array of tags (key and value pairs) associate with the requested phone number.
String clientToken
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.
String phoneNumberArn
The Amazon Resource Name (ARN) of the requested phone number.
String phoneNumberId
The unique identifier of the new phone number.
String phoneNumber
The new phone number that was requested.
String status
The current status of the request.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
String messageType
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<E> numberCapabilities
Indicates if the phone number will be used for text messages, voice messages or both.
String numberType
The type of number that was released.
String monthlyLeasingPrice
The monthly price, in US dollars, to lease the phone number.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
String twoWayChannelArn
The ARN used to identify the two way channel.
Boolean selfManagedOptOutsEnabled
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 optOutListName
The name of the OptOutList that is associated with the requested phone number.
Boolean deletionProtectionEnabled
By default this is set to false. When set to true the phone number can't be deleted.
String poolId
The unique identifier of the pool associated with the phone number
List<E> tags
An array of key and value pair tags that are associated with the phone number.
Date createdTimestamp
The time when the phone number was created, in UNIX epoch time format.
String senderIdArn
The Amazon Resource Name (ARN) associated with the SenderId.
String senderId
The alphanumeric sender ID in a specific country that you'd like to describe.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
List<E> messageTypes
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
The monthly leasing price, in US dollars.
String destinationPhoneNumber
The destination phone number in E.164 format.
String originationIdentity
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
String messageBody
The body of the text message.
String messageType
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 keyword
When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
String configurationSetName
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
String maxPrice
The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
Integer timeToLive
How long the text message is valid for. By default this is 72 hours.
Map<K,V> context
You can specify custom data in this field. If you do, that data is logged to the event destination.
Map<K,V> destinationCountryParameters
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.
Boolean dryRun
When set to true, the message is checked and validated, but isn't sent to the end recipient.
String messageId
The unique identifier for the message.
String destinationPhoneNumber
The destination phone number in E.164 format.
String originationIdentity
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
String messageBody
The text to convert to a voice message.
String messageBodyTextType
Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
TEXT: This is the default value. When used the maximum character limit is 3000.
SSML: When used the maximum character limit is 6000 including SSML tagging.
String voiceId
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
String configurationSetName
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
String maxPricePerMinute
The maximum amount to spend per voice message, in US dollars.
Integer timeToLive
How long the voice message is valid for. By default this is 72 hours.
Map<K,V> context
You can specify custom data in this field. If you do, that data is logged to the event destination.
Boolean dryRun
When set to true, the message is checked and validated, but isn't sent to the end recipient.
String messageId
The unique identifier for the message.
String reason
The reason for the exception.
String configurationSetName
The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
String messageType
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 configurationSetName
The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
String senderId
The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.
Long monthlyLimit
The new monthly limit to enforce on text messages.
Long monthlyLimit
The current monthly limit to enforce on sending text messages.
Long monthlyLimit
The new monthly limit to enforce on voice messages.
Long monthlyLimit
The current monthly limit to enforce on sending voice messages.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
String name
The name for the SpendLimit.
Long enforcedLimit
The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This
value has to be less than or equal to the amount in MaxLimit. To use this custom limit,
Overridden must be set to true.
Long maxLimit
The maximum amount of money that you are able to spend to send messages each month, in US dollars.
Boolean overridden
When set to True, the value that has been specified in the EnforcedLimit is used to
determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.
String configurationSetName
The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
String eventDestinationName
The name to use for the event destination.
Boolean enabled
When set to true logging is enabled.
List<E> matchingEventTypes
An array of event types that determine which events to log.
CloudWatchLogsDestination cloudWatchLogsDestination
An object that contains information about an event destination that sends data to CloudWatch Logs.
KinesisFirehoseDestination kinesisFirehoseDestination
An object that contains information about an event destination for logging to Kinesis Data Firehose.
SnsDestination snsDestination
An object that contains information about an event destination that sends data to Amazon SNS.
String configurationSetArn
The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
String configurationSetName
The name of the configuration set.
EventDestination eventDestination
An EventDestination object containing the details of where events will be logged.
String phoneNumberId
The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
Boolean selfManagedOptOutsEnabled
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 optOutListName
The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
Boolean deletionProtectionEnabled
By default this is set to false. When set to true the phone number can't be deleted.
String phoneNumberArn
The Amazon Resource Name (ARN) of the updated phone number.
String phoneNumberId
The unique identifier of the phone number.
String phoneNumber
The phone number that was updated.
String status
The current status of the request.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
String messageType
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<E> numberCapabilities
Specifies if the number could be used for text messages, voice or both.
String numberType
The type of number that was requested.
String monthlyLeasingPrice
The monthly leasing price of the phone number, in US dollars.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
Boolean selfManagedOptOutsEnabled
This is true if self managed opt-out are enabled.
String optOutListName
The name of the OptOutList associated with the phone number.
Boolean deletionProtectionEnabled
When set to true the phone number can't be deleted.
Date createdTimestamp
The time when the phone number was created, in UNIX epoch time format.
String poolId
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
Boolean selfManagedOptOutsEnabled
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 optOutListName
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
Boolean sharedRoutesEnabled
Indicates whether shared routes are enabled for the pool.
Boolean deletionProtectionEnabled
When set to true the pool can't be deleted.
String poolArn
The ARN of the pool.
String poolId
The unique identifier of the pool.
String status
The current status of the pool update request.
String messageType
The type of message for the pool to use.
Boolean twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
String twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
Boolean selfManagedOptOutsEnabled
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 optOutListName
The name of the OptOutList associated with the pool.
Boolean sharedRoutesEnabled
Indicates whether shared routes are enabled for the pool.
Boolean deletionProtectionEnabled
When set to true the pool can't be deleted.
Date createdTimestamp
The time when the pool was created, in UNIX epoch time format.
Copyright © 2022. All rights reserved.