EC2 / Client / describe_byoip_cidrs

describe_byoip_cidrs

EC2.Client.describe_byoip_cidrs(**kwargs)

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

See also: AWS API Documentation

Request Syntax

response = client.describe_byoip_cidrs(
    DryRun=True|False,
    MaxResults=123,
    NextToken='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.

• MaxResults (integer) –

  [REQUIRED]

  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'ByoipCidrs': [
        {
            'Cidr': 'string',
            'Description': 'string',
            'AsnAssociations': [
                {
                    'Asn': 'string',
                    'Cidr': 'string',
                    'StatusMessage': 'string',
                    'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
                },
            ],
            'StatusMessage': 'string',
            'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable',
            'NetworkBorderGroup': 'string'
        },
    ],
    'NextToken': 'string'
}

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.

      • AsnAssociations (list) –

        The BYOIP CIDR associations with ASNs.

        • (dict) –

          An Autonomous System Number (ASN) and BYOIP CIDR association.

          • Asn (string) –

            The association’s ASN.

          • Cidr (string) –

            The association’s CIDR.

          • StatusMessage (string) –

            The association’s status message.

          • State (string) –

            The association’s state.

      • StatusMessage (string) –

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

      • State (string) –

        The state of the address range.

        • advertised: The address range is being advertised to the internet by Amazon Web Services.

        • deprovisioned: The address range is deprovisioned.

        • failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

        • failed-provision: The request to provision the address range was unsuccessful.

        • pending-deprovision: You’ve submitted a request to deprovision an address range and it’s pending.

        • pending-provision: You’ve submitted a request to provision an address range and it’s pending.

        • provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

        • provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

      • NetworkBorderGroup (string) –

        If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

        You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

        • us-east-1-dfw-2

        • us-west-2-lax-1

        • us-west-2-phx-2

        Note

        You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.