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.

PutDedicatedIpInPool

Move a dedicated IP address to an existing dedicated IP pool.

Note

The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.

The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

Request Syntax

PUT /v1/email/dedicated-ips/IP/pool HTTP/1.1 Content-type: application/json { "DestinationPoolName": "string" }

URI Request Parameters

The request requires the following URI parameters.

IP

The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Pinpoint account.

Request Body

The request accepts the following data in JSON format.

DestinationPoolName

The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: