Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ListDedicatedIpPools

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

Request Syntax

GET /v1/email/dedicated-ip-pools?NextToken=NextToken&PageSize=PageSize HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

NextToken

A token returned from a previous call to ListDedicatedIpPools to 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 a NextToken element, 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 Amazon Pinpoint account.

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 the NextToken parameter.

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: