PoolInformation
The information for a pool in an AWS account.
Contents
- CreatedTimestamp
-
The time when the pool was created, in UNIX epoch time
format. Type: Timestamp
Required: Yes
- DeletionProtectionEnabled
-
When set to true the pool can't be deleted.
Type: Boolean
Required: Yes
- 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.
Type: String
Valid Values:
TRANSACTIONAL | PROMOTIONALRequired: Yes
- OptOutListName
-
The name of the OptOutList associated with the pool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9_-]+Required: Yes
- PoolArn
-
The Amazon Resource Name (ARN) for the pool.
Type: String
Required: Yes
- PoolId
-
The unique identifier for the pool.
Type: String
Required: Yes
- SelfManagedOptOutsEnabled
-
When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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
Type: Boolean
Required: Yes
-
Allows you to enable shared routes on your pool.
By default, this is set to
False. If you set this value toTrue, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other 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.Type: Boolean
Required: Yes
- Status
-
The current status of the pool.
Type: String
Valid Values:
CREATING | ACTIVE | DELETINGRequired: Yes
- TwoWayEnabled
-
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
Type: Boolean
Required: Yes
- TwoWayChannelArn
-
The Amazon Resource Name (ARN) of the two way channel.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
\S+Required: No
- TwoWayChannelRole
-
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:\S+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
