ListDedicatedIpPools
List all of the dedicated IP pools that exist in your AWS account in the current Region.
Request Syntax
GET /v2/email/dedicated-ip-pools?NextToken=NextToken&PageSize=PageSize HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- NextToken
-
A token returned from a previous call to
ListDedicatedIpPoolsto indicate the position in the list of dedicated IP pools. - PageSize
-
The number of results to show in a single call to
ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes aNextTokenelement, which you can use to obtain additional results.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DedicatedIpPools": [ "string" ],
"NextToken": "string"
}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.
- DedicatedIpPools
-
A list of all of the dedicated IP pools that are associated with your AWS account in the current Region.
Type: Array of strings
- NextToken
-
A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to
ListDedicatedIpPools, passing this token in theNextTokenparameter.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- TooManyRequestsException
-
Too many requests have been made to the operation.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
