Skip to main content

ISESV2GetDedicatedIpsRequest

Interface in AWS.SESV2

Interface for GetDedicatedIps requests.

Ancestors

Properties

NextToken

property NextToken: string

A token returned from a previous call to indicate the position in the list of dedicated IPs for pagination.

This parameter is used for pagination when the total number of dedicated IP addresses exceeds the page size limit. When provided, the API returns the next page of results starting from the position indicated by this token. This field should be empty for the first request and populated with the NextToken value returned from previous API calls when retrieving additional pages of results.

PageSize

property PageSize: TOptional<Integer>

The maximum number of dedicated IP addresses to return in a single API call.

This parameter controls the size of each page in paginated results. If the total number of dedicated IP addresses exceeds this value, the response will include a NextToken that can be used to retrieve additional results in subsequent API calls. When not specified, the API uses a default page size. Setting an appropriate page size helps balance between reducing the number of API calls and managing memory usage for large result sets.

PoolName

property PoolName: string

The name of the dedicated IP pool to filter results by.

When specified, only dedicated IP addresses that belong to the specified pool will be returned. This allows you to retrieve dedicated IPs for a specific use case or campaign without having to filter through all dedicated IPs in your account. When this parameter is empty, the API returns all dedicated IP addresses associated with your AWS account, regardless of their pool assignment. Some dedicated IPs may not be assigned to any pool.