CloudFront / Client / list_anycast_ip_lists

list_anycast_ip_lists

CloudFront.Client.list_anycast_ip_lists(**kwargs)

Lists your Anycast static IP lists.

See also: AWS API Documentation

Request Syntax

response = client.list_anycast_ip_lists(
    Marker='string',
    MaxItems=123
)
Parameters:

  • Marker (string) – Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

  • MaxItems (integer) – The maximum number of Anycast static IP lists that you want returned in the response.

Return type:

dict

Returns:

Response Syntax

{
    'AnycastIpLists': {
        'Items': [
            {
                'Id': 'string',
                'Name': 'string',
                'Status': 'string',
                'Arn': 'string',
                'IpCount': 123,
                'LastModifiedTime': datetime(2015, 1, 1),
                'IpAddressType': 'ipv4'|'ipv6'|'dualstack',
                'ETag': 'string',
                'IpamConfig': {
                    'Quantity': 123,
                    'IpamCidrConfigs': [
                        {
                            'Cidr': 'string',
                            'IpamPoolArn': 'string',
                            'AnycastIp': 'string',
                            'Status': 'provisioned'|'failed-provision'|'provisioning'|'deprovisioned'|'failed-deprovision'|'deprovisioning'|'advertised'|'failed-advertise'|'advertising'|'withdrawn'|'failed-withdraw'|'withdrawing'
                        },
                    ]
                }
            },
        ],
        'Marker': 'string',
        'NextMarker': 'string',
        'MaxItems': 123,
        'IsTruncated': True|False,
        'Quantity': 123
    }
}

Response Structure

  • (dict) –

    • AnycastIpLists (dict) –

      Root level tag for the AnycastIpLists parameters.

      • Items (list) –

        Items in the Anycast static IP list collection. Each item is of the AnycastIpListSummary structure type.

        • (dict) –

          An abbreviated version of the AnycastIpList structure. Omits the allocated static IP addresses ( AnycastIpList$AnycastIps).

          • Id (string) –

            The ID of the Anycast static IP list.

          • Name (string) –

            The name of the Anycast static IP list.

          • Status (string) –

            The deployment status of the Anycast static IP list. Valid values: Deployed, Deploying, or Failed.

          • Arn (string) –

            The Amazon Resource Name (ARN) of the Anycast static IP list.

          • IpCount (integer) –

            The number of IP addresses in the Anycast static IP list.

          • LastModifiedTime (datetime) –

            The last time the Anycast static IP list was modified.

          • IpAddressType (string) –

            The IP address type for the Anycast static IP list.

          • ETag (string) –

            The current version (ETag value) of the Anycast static IP list.

          • IpamConfig (dict) –

            The IPAM configuration for the Anycast static IP list, that contains the quantity and list of IPAM CIDR configurations.

            • Quantity (integer) –

              The number of IPAM CIDR configurations in the IpamCidrConfigs list.

            • IpamCidrConfigs (list) –

              A list of IPAM CIDR configurations that define the IP address ranges, IPAM pools, and associated Anycast IP addresses.

              • (dict) –

                Configuration for an IPAM CIDR that defines a specific IP address range, IPAM pool, and associated Anycast IP address.

                • Cidr (string) –

                  The CIDR that specifies the IP address range for this IPAM configuration.

                • IpamPoolArn (string) –

                  The Amazon Resource Name (ARN) of the IPAM pool that the CIDR block is assigned to.

                • AnycastIp (string) –

                  The specified Anycast IP address allocated from the IPAM pool for this CIDR configuration.

                • Status (string) –

                  The current status of the IPAM CIDR configuration.

      • Marker (string) –

        Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

      • NextMarker (string) –

        Indicates the next page of the Anycast static IP list collection. To get the next page of the list, use this value in the Marker field of your request.

      • MaxItems (integer) –

        The maximum number of Anycast static IP list collections that you want returned in the response.

      • IsTruncated (boolean) –

        If there are more items in the list collection than are in this response, this value is true.

      • Quantity (integer) –

        The quantity of Anycast static IP lists in the collection.

Exceptions