EC2 / Paginator / DescribeAddressesAttribute

DescribeAddressesAttribute

class EC2.Paginator.DescribeAddressesAttribute

paginator = client.get_paginator('describe_addresses_attribute')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_addresses_attribute().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AllocationIds=[
        'string',
    ],
    Attribute='domain-name',
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AllocationIds (list) –

  [EC2-VPC] The allocation IDs.

  • (string) –

• Attribute (string) – The attribute of the IP address.

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

• 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

{
    'Addresses': [
        {
            'PublicIp': 'string',
            'AllocationId': 'string',
            'PtrRecord': 'string',
            'PtrRecordUpdate': {
                'Value': 'string',
                'Status': 'string',
                'Reason': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • Addresses (list) –

    Information about the IP addresses.

    • (dict) –

      The attributes associated with an Elastic IP address.

      • PublicIp (string) –

        The public IP address.

      • AllocationId (string) –

        [EC2-VPC] The allocation ID.

      • PtrRecord (string) –

        The pointer (PTR) record for the IP address.

      • PtrRecordUpdate (dict) –

        The updated PTR record for the IP address.

        • Value (string) –

          The value for the PTR record update.

        • Status (string) –

          The status of the PTR record update.

        • Reason (string) –

          The reason for the PTR record update.