Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the <code>TwoWayChannelArn</code>, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

post/#X-Amz-Target=PinpointSMSVoiceV2.UpdatePool

Headers

X-Amz-Target'PinpointSMSVoiceV2.UpdatePool' required

Request body

PoolIdstring required
<p>The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
TwoWayEnabledboolean

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

TwoWayChannelArnstring

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

TwoWayChannelRolestring

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

SelfManagedOptOutsEnabledboolean

By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS 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.

OptOutListNamestring
<p>The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
SharedRoutesEnabledboolean

Indicates whether shared routes are enabled for the pool.

DeletionProtectionEnabledboolean

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

Response

Success

PoolArnstring

The ARN of the pool.

PoolIdstring

The unique identifier of the pool.

Status'CREATING' | 'ACTIVE' | 'DELETING'

The current status of the pool update request.

MessageType'TRANSACTIONAL' | 'PROMOTIONAL'

The type of message for the pool to use.

TwoWayEnabledboolean

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

TwoWayChannelArnstring

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

TwoWayChannelRolestring

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

SelfManagedOptOutsEnabledboolean

When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS 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.

OptOutListNamestring

The name of the OptOutList associated with the pool.

SharedRoutesEnabledboolean

Indicates whether shared routes are enabled for the pool.

DeletionProtectionEnabledboolean

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

CreatedTimestampstring date-time

The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.