EC2 / Paginator / DescribeAddressTransfers

DescribeAddressTransfers

class EC2.Paginator.DescribeAddressTransfers

paginator = client.get_paginator('describe_address_transfers')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• AllocationIds (list) –

  The allocation IDs of Elastic IP addresses.

  • (string) –

• 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

{
    'AddressTransfers': [
        {
            'PublicIp': 'string',
            'AllocationId': 'string',
            'TransferAccountId': 'string',
            'TransferOfferExpirationTimestamp': datetime(2015, 1, 1),
            'TransferOfferAcceptedTimestamp': datetime(2015, 1, 1),
            'AddressTransferStatus': 'pending'|'disabled'|'accepted'
        },
    ],

}

Response Structure

• (dict) –

  • AddressTransfers (list) –

    The Elastic IP address transfer.

    • (dict) –

      Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

      • PublicIp (string) –

        The Elastic IP address being transferred.

      • AllocationId (string) –

        The allocation ID of an Elastic IP address.

      • TransferAccountId (string) –

        The ID of the account that you want to transfer the Elastic IP address to.

      • TransferOfferExpirationTimestamp (datetime) –

        The timestamp when the Elastic IP address transfer expired. When the source account starts the transfer, the transfer account has seven hours to allocate the Elastic IP address to complete the transfer, or the Elastic IP address will return to its original owner.

      • TransferOfferAcceptedTimestamp (datetime) –

        The timestamp when the Elastic IP address transfer was accepted.

      • AddressTransferStatus (string) –

        The Elastic IP address transfer status.