PinpointEmail / Paginator / GetDedicatedIps

GetDedicatedIps

class PinpointEmail.Paginator.GetDedicatedIps

paginator = client.get_paginator('get_dedicated_ips')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointEmail.Client.get_dedicated_ips().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PoolName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• PoolName (string) – The name of the IP pool that the dedicated IP address is associated with.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'DedicatedIps': [
        {
            'Ip': 'string',
            'WarmupStatus': 'IN_PROGRESS'|'DONE',
            'WarmupPercentage': 123,
            'PoolName': 'string'
        },
    ],

}

Response Structure

• (dict) –

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

  • DedicatedIps (list) –

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

    • (dict) –

      Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.

      • Ip (string) –

        An IP address that is reserved for use by your Amazon Pinpoint account.

      • WarmupStatus (string) –

        The warm-up status of a dedicated IP address. The status can have one of the following values:

        • IN_PROGRESS – The IP address isn’t ready to use because the dedicated IP warm-up process is ongoing.

        • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

      • WarmupPercentage (integer) –

        Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

      • PoolName (string) –

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