put_dedicated_ip_in_pool

put_dedicated_ip_in_pool(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_dedicated_ip_in_pool(
    Ip='string',
    DestinationPoolName='string'
)

Parameters

• Ip (string) --

  [REQUIRED]

  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.

• DestinationPoolName (string) --

  [REQUIRED]

  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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

  An HTTP 200 response if the request succeeds, or an error message if the request fails.

Exceptions

• PinpointEmail.Client.exceptions.NotFoundException
• PinpointEmail.Client.exceptions.TooManyRequestsException
• PinpointEmail.Client.exceptions.BadRequestException