GetDedicatedIpsCommand

Suggest an Edit

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

Example Syntax

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

import { PinpointEmailClient, GetDedicatedIpsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, GetDedicatedIpsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // GetDedicatedIpsRequest
  PoolName: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  PageSize: Number("int"),
};
const command = new GetDedicatedIpsCommand(input);
const response = await client.send(command);
// { // GetDedicatedIpsResponse
//   DedicatedIps: [ // DedicatedIpList
//     { // DedicatedIp
//       Ip: "STRING_VALUE", // required
//       WarmupStatus: "IN_PROGRESS" || "DONE", // required
//       WarmupPercentage: Number("int"), // required
//       PoolName: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

GetDedicatedIpsCommand Input

See GetDedicatedIpsCommandInput for more details

Parameter
Type
Description
NextToken
string | undefined

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
number | undefined

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
string | undefined

The name of the IP pool that the dedicated IP address is associated with.

GetDedicatedIpsCommand Output

See GetDedicatedIpsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DedicatedIps
DedicatedIp[] | undefined

A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.

NextToken
string | undefined

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.

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.