CloudFront / Client / update_anycast_ip_list

update_anycast_ip_list

CloudFront.Client.update_anycast_ip_list(**kwargs)

Updates an Anycast static IP list.

See also: AWS API Documentation

Request Syntax

response = client.update_anycast_ip_list(
    Id='string',
    IpAddressType='ipv4'|'ipv6'|'dualstack',
    IfMatch='string'
)
Parameters:

  • Id (string) –

    [REQUIRED]

    The ID of the Anycast static IP list.

  • IpAddressType (string) –

    The IP address type for the Anycast static IP list. You can specify one of the following options:

    • ipv4 only

    • ipv6 only

    • dualstack - Allocate a list of both IPv4 and IPv6 addresses

  • IfMatch (string) –

    [REQUIRED]

    The current version (ETag value) of the Anycast static IP list that you are updating.

Return type:

dict

Returns:

Response Syntax

{
    'AnycastIpList': {
        'Id': 'string',
        'Name': 'string',
        'Status': 'string',
        'Arn': 'string',
        'IpAddressType': 'ipv4'|'ipv6'|'dualstack',
        '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'
                },
            ]
        },
        'AnycastIps': [
            'string',
        ],
        'IpCount': 123,
        'LastModifiedTime': datetime(2015, 1, 1)
    },
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • AnycastIpList (dict) –

      An Anycast static IP list. For more information, see Request Anycast static IPs to use for allowlisting in the Amazon CloudFront Developer Guide.

      • Id (string) –

        The ID of the Anycast static IP list.

      • Name (string) –

        The name of the Anycast static IP list.

      • Status (string) –

        The 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.

      • IpAddressType (string) –

        The IP address type for 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.

      • AnycastIps (list) –

        The static IP addresses that are allocated to the Anycast static IP list.

        • (string) –

      • 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.

    • ETag (string) –

      The current version of the Anycast static IP list.

Exceptions