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

GetDedicatedIp

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

Request Syntax


GET /v1/email/dedicated-ips/IP HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

IP

The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

DedicatedIp

An object that contains information about a dedicated IP address.

Type: DedicatedIp object

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