paws.customer.engagement (version 0.1.12)

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

Description

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

Usage

pinpointemail_get_dedicated_ips(PoolName, NextToken, PageSize)

Value

A list with the following syntax:

list(
  DedicatedIps = list(
    list(
      Ip = "string",
      WarmupStatus = "IN_PROGRESS"|"DONE",
      WarmupPercentage = 123,
      PoolName = "string"
    )
  ),
  NextToken = "string"
)

Arguments

PoolName

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

NextToken

A token returned from a previous call to get_dedicated_ips to indicate the position of the dedicated IP pool in the list of IP pools.

PageSize

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.

Request syntax

svc$get_dedicated_ips(
  PoolName = "string",
  NextToken = "string",
  PageSize = 123
)