PutDedicatedIpInPoolCommand

Suggest an Edit

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

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PinpointEmailClient, PutDedicatedIpInPoolCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, PutDedicatedIpInPoolCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // PutDedicatedIpInPoolRequest
  Ip: "STRING_VALUE", // required
  DestinationPoolName: "STRING_VALUE", // required
};
const command = new PutDedicatedIpInPoolCommand(input);
const response = await client.send(command);
// {};

PutDedicatedIpInPoolCommand Input

See PutDedicatedIpInPoolCommandInput for more details

Parameter
Type
Description
DestinationPoolName
Required
string | undefined

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.

Ip
Required
string | undefined

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.

PutDedicatedIpInPoolCommand Output

See PutDedicatedIpInPoolCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

NotFoundException
client

The resource you attempted to access doesn't exist.

TooManyRequestsException
client

Too many requests have been made to the operation.

PinpointEmailServiceException
Base exception class for all service exceptions from PinpointEmail service.