# DescribePools
Retrieves the specified pools or all pools associated with your AWS 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 AWS account.
## Request Syntax
```
{
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"MaxResults": number,
"NextToken": "string",
"Owner": "string",
"PoolIds": [ "string" ]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Filters](#API_DescribePools_RequestSyntax) **
An array of PoolFilter objects to filter the results.
Type: Array of [PoolFilter](API_PoolFilter.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
** [MaxResults](#API_DescribePools_RequestSyntax) **
The maximum number of results to return per each request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_DescribePools_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `.+`
Required: No
** [Owner](#API_DescribePools_RequestSyntax) **
Use `SELF` to filter the list of Pools to ones your account owns or use `SHARED` to filter on Pools shared with your account. The `Owner` and `PoolIds` parameters can't be used at the same time.
Type: String
Valid Values: `SELF | SHARED`
Required: No
** [PoolIds](#API_DescribePools_RequestSyntax) **
The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: `[A-Za-z0-9_:/-]*`
Required: No
## Response Syntax
```
{
"NextToken": "string",
"Pools": [
{
"CreatedTimestamp": number,
"DeletionProtectionEnabled": boolean,
"MessageType": "string",
"OptOutListName": "string",
"PoolArn": "string",
"PoolId": "string",
"SelfManagedOptOutsEnabled": boolean,
"SharedRoutesEnabled": boolean,
"Status": "string",
"TwoWayChannelArn": "string",
"TwoWayChannelRole": "string",
"TwoWayEnabled": boolean
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_DescribePools_ResponseSyntax) **
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `.+`
** [Pools](#API_DescribePools_ResponseSyntax) **
An array of PoolInformation objects that contain the details for the requested pools.
Type: Array of [PoolInformation](API_PoolInformation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request was denied because you don't have sufficient permissions to access the resource.
** Reason **
The reason for the exception.
HTTP Status Code: 400
** InternalServerException **
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
** RequestId **
The unique identifier of the request.
HTTP Status Code: 500
** ResourceNotFoundException **
A requested resource couldn't be found.
** ResourceId **
The unique identifier of the resource.
** ResourceType **
The type of resource that caused the exception.
HTTP Status Code: 400
** ThrottlingException **
An error that occurred because too many requests were sent during a certain amount of time.
HTTP Status Code: 400
** ValidationException **
A validation exception for a field.
** Fields **
The field that failed validation.
** Reason **
The reason for the exception.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/pinpoint-sms-voice-v2-2022-03-31/DescribePools)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/pinpoint-sms-voice-v2-2022-03-31/DescribePools)