EC2 / Paginator / DescribeByoipCidrs

DescribeByoipCidrs

class EC2.Paginator.DescribeByoipCidrs

paginator = client.get_paginator('describe_byoip_cidrs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• 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

{
    'ByoipCidrs': [
        {
            'Cidr': 'string',
            'Description': 'string',
            'StatusMessage': 'string',
            'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
        },
    ],

}

Response Structure

• (dict) –

  • ByoipCidrs (list) –

    Information about your address ranges.

    • (dict) –

      Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

      • Cidr (string) –

        The address range, in CIDR notation.

      • Description (string) –

        The description of the address range.

      • StatusMessage (string) –

        Upon success, contains the ID of the address pool. Otherwise, contains an error message.

      • State (string) –

        The state of the address pool.