Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.

If you specify a pool ID that isn't valid, 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.DescribePools

Headers

X-Amz-Target'PinpointSMSVoiceV2.DescribePools' required

Request body

PoolIdsPoolIdOrArn[]
<p>The unique identifier of pools to find. This is an array of strings that can be 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>
NextTokenstring

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.

MaxResultsinteger

The maximum number of results to return per each request.

Owner'SELF' | 'SHARED'

Use <code>SELF</code> to filter the list of Pools to ones your account owns or use <code>SHARED</code> to filter on Pools shared with your account. The <code>Owner</code> and <code>PoolIds</code> parameters can't be used at the same time.

Response

Success

NextTokenstring

The token to be used for the next set of paginated results. If this field is empty then there are no more results.