Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDedicatedIps

List the dedicated IP addresses that are associated with your AWS account.

Request Syntax


GET /v2/email/dedicated-ips?NextToken=NextToken&PageSize=PageSize&PoolName=PoolName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

NextToken: A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.
PageSize: The number of results to show in a single call to GetDedicatedIpsRequest. 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.
PoolName: The name of the IP pool that the dedicated IP address is associated with.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DedicatedIps": [ 
      { 
         "Ip": "string",
         "PoolName": "string",
         "WarmupPercentage": number,
         "WarmupStatus": "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.

DedicatedIps

A list of dedicated IP addresses that are associated with your AWS account.

Type: Array of DedicatedIp objects

NextToken

A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, 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

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429