Documentation

The information for a pool in an Amazon Web Services account.

See: newPoolInformation smart constructor.

Create a value of PoolInformation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:twoWayChannelArn:PoolInformation', poolInformation_twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.

$sel:poolArn:PoolInformation', poolInformation_poolArn - The Amazon Resource Name (ARN) for the pool.

$sel:poolId:PoolInformation', poolInformation_poolId - The unique identifier for the pool.

$sel:status:PoolInformation', poolInformation_status - The current status of the pool.

$sel:messageType:PoolInformation', poolInformation_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.

$sel:twoWayEnabled:PoolInformation', poolInformation_twoWayEnabled - When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

$sel:selfManagedOptOutsEnabled:PoolInformation', poolInformation_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

$sel:optOutListName:PoolInformation', poolInformation_optOutListName - The name of the OptOutList associated with the pool.

$sel:sharedRoutesEnabled:PoolInformation', poolInformation_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.

$sel:deletionProtectionEnabled:PoolInformation', poolInformation_deletionProtectionEnabled - When set to true the pool can't be deleted.

$sel:createdTimestamp:PoolInformation', poolInformation_createdTimestamp - The time when the pool was created, in UNIX epoch time format.

The Amazon Resource Name (ARN) of the two way channel.

The Amazon Resource Name (ARN) for the pool.

The unique identifier for the pool.

The current status of the pool.

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.

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

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

The name of the OptOutList associated with the pool.

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.

When set to true the pool can't be deleted.

The time when the pool was created, in UNIX epoch time format.