2025/11/20 - Amazon CloudFront - 4 updated api methods
Changes This release adds support for bring your own IP (BYOIP) to CloudFront's CreateAnycastIpList API through an optional IpamCidrConfigs field.
{'IpamCidrConfigs': [{'AnycastIp': 'string',
'Cidr': 'string',
'IpamPoolArn': 'string',
'Status': 'provisioned | failed-provision | provisioning '
'| deprovisioned | failed-deprovision | '
'deprovisioning | advertised | '
'failed-advertise | advertising | withdrawn | '
'failed-withdraw | withdrawing'}]}
Response {'AnycastIpList': {'IpamConfig': {'IpamCidrConfigs': [{'AnycastIp': 'string',
'Cidr': 'string',
'IpamPoolArn': 'string',
'Status': 'provisioned '
'| '
'failed-provision '
'| '
'provisioning '
'| '
'deprovisioned '
'| '
'failed-deprovision '
'| '
'deprovisioning '
'| advertised '
'| '
'failed-advertise '
'| '
'advertising '
'| withdrawn '
'| '
'failed-withdraw '
'| '
'withdrawing'}],
'Quantity': 'integer'}}}
Creates an Anycast static IP list.
See also: AWS API Documentation
Request Syntax
client.create_anycast_ip_list(
Name='string',
IpCount=123,
Tags={
'Items': [
{
'Key': 'string',
'Value': 'string'
},
]
},
IpAddressType='ipv4'|'ipv6'|'dualstack',
IpamCidrConfigs=[
{
'Cidr': 'string',
'IpamPoolArn': 'string',
'AnycastIp': 'string',
'Status': 'provisioned'|'failed-provision'|'provisioning'|'deprovisioned'|'failed-deprovision'|'deprovisioning'|'advertised'|'failed-advertise'|'advertising'|'withdrawn'|'failed-withdraw'|'withdrawing'
},
]
)
string
[REQUIRED]
Name of the Anycast static IP list.
integer
[REQUIRED]
The number of static IP addresses that are allocated to the Anycast static IP list. Valid values: 21 or 3.
dict
A complex type that contains zero or more Tag elements.
Items (list) --
A complex type that contains Tag elements.
(dict) --
A complex type that contains Tag key and Tag value.
Key (string) -- [REQUIRED]
A string that contains Tag key.
The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
Value (string) --
A string that contains an optional Tag value.
The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
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
list
A list of IPAM CIDR configurations that specify the IP address ranges and IPAM pool settings for creating the Anycast static IP list.
(dict) --
Configuration for an IPAM CIDR that defines a specific IP address range, IPAM pool, and associated Anycast IP address.
Cidr (string) -- [REQUIRED]
The CIDR that specifies the IP address range for this IPAM configuration.
IpamPoolArn (string) -- [REQUIRED]
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.
dict
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) --
A response structure that includes the version identifier (ETag) and the created AnycastIpList structure.
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 version identifier for the current version of the Anycast static IP list.
{'AnycastIpList': {'IpamConfig': {'IpamCidrConfigs': [{'AnycastIp': 'string',
'Cidr': 'string',
'IpamPoolArn': 'string',
'Status': 'provisioned '
'| '
'failed-provision '
'| '
'provisioning '
'| '
'deprovisioned '
'| '
'failed-deprovision '
'| '
'deprovisioning '
'| advertised '
'| '
'failed-advertise '
'| '
'advertising '
'| withdrawn '
'| '
'failed-withdraw '
'| '
'withdrawing'}],
'Quantity': 'integer'}}}
Gets an Anycast static IP list.
See also: AWS API Documentation
Request Syntax
client.get_anycast_ip_list(
Id='string'
)
string
[REQUIRED]
The ID of the Anycast static IP list.
dict
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) --
The Anycast static IP list details.
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 version identifier for the current version of the Anycast static IP list.
{'AnycastIpLists': {'Items': {'IpamConfig': {'IpamCidrConfigs': [{'AnycastIp': 'string',
'Cidr': 'string',
'IpamPoolArn': 'string',
'Status': 'provisioned '
'| '
'failed-provision '
'| '
'provisioning '
'| '
'deprovisioned '
'| '
'failed-deprovision '
'| '
'deprovisioning '
'| '
'advertised '
'| '
'failed-advertise '
'| '
'advertising '
'| '
'withdrawn '
'| '
'failed-withdraw '
'| '
'withdrawing'}],
'Quantity': 'integer'}}}}
Lists your Anycast static IP lists.
See also: AWS API Documentation
Request Syntax
client.list_anycast_ip_lists(
Marker='string',
MaxItems=123
)
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.
integer
The maximum number of Anycast static IP lists that you want returned in the response.
dict
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.
{'AnycastIpList': {'IpamConfig': {'IpamCidrConfigs': [{'AnycastIp': 'string',
'Cidr': 'string',
'IpamPoolArn': 'string',
'Status': 'provisioned '
'| '
'failed-provision '
'| '
'provisioning '
'| '
'deprovisioned '
'| '
'failed-deprovision '
'| '
'deprovisioning '
'| advertised '
'| '
'failed-advertise '
'| '
'advertising '
'| withdrawn '
'| '
'failed-withdraw '
'| '
'withdrawing'}],
'Quantity': 'integer'}}}
Updates an Anycast static IP list.
See also: AWS API Documentation
Request Syntax
client.update_anycast_ip_list(
Id='string',
IpAddressType='ipv4'|'ipv6'|'dualstack',
IfMatch='string'
)
string
[REQUIRED]
The ID of the Anycast static IP list.
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
string
[REQUIRED]
The current version (ETag value) of the Anycast static IP list that you are updating.
dict
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.