Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn't active or if deletion protection is enabled, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.DeletePool' required

Request body

PoolIdstring required
<p>The PoolId or PoolArn of the pool to delete. You can use <a>DescribePools</a> to find the values for PoolId and 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>

Response

Success

PoolArnstring

The Amazon Resource Name (ARN) of the pool that was deleted.

PoolIdstring

The PoolId of the pool that was deleted.

Status'CREATING' | 'ACTIVE' | 'DELETING'
<p>The current status of the pool.</p> <ul> <li> <p>CREATING: The pool is currently being created and isn't yet available for use.</p> </li> <li> <p>ACTIVE: The pool is active and available for use.</p> </li> <li> <p>DELETING: The pool is being deleted.</p> </li> </ul>
MessageType'TRANSACTIONAL' | 'PROMOTIONAL'

The message type that was associated with the deleted pool.

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 TwoWayChannel.

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

The name of the OptOutList that was associated with the deleted pool.

SharedRoutesEnabledboolean

Indicates whether shared routes are enabled for the pool.

CreatedTimestampstring date-time

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