2026/08/07 - Amazon Elastic Compute Cloud - 15 new 13 updated api methods
Changes This release adds support for BGP route protection in Amazon VPC IP Address Manager (IPAM), including route discovery, RPKI route protection findings, and delegated RPKI (Internet Registry Associations, routing policy registrations, and ROA management) for BYOIP prefixes.
Deletes a routing policy registration for a specified CIDR prefix.
See also: AWS API Documentation
Request Syntax
client.delete_ipam_routing_policy_registration(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
Cidr='string',
Force=True|False,
ClientToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
string
[REQUIRED]
The IP address prefix in CIDR notation identifying the routing policy registration to delete.
boolean
Forces the deletion even if it conflicts with an announced route. Default: false.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamRoutingPolicyRegistrationDelta': {
'DeltaId': 'string',
'DeltaJson': 'string',
'State': 'pending'|'published'|'failed',
'StateMessage': 'string'
}
}
Response Structure
(dict) --
IpamRoutingPolicyRegistrationDelta (dict) --
Information about the routing policy registration delta created by this deletion.
DeltaId (string) --
The unique identifier of the delta.
DeltaJson (string) --
The JSON specification describing the changes applied in this delta.
State (string) --
The state of the delta. Valid values: pending | published | failed.
StateMessage (string) --
A message describing the current state, including error information if the delta failed.
Modifies multiple routing policy registrations in a single operation. You can create, update, or delete Route Origin Authorizations (ROAs) in batch.
See also: AWS API Documentation
Request Syntax
client.batch_modify_ipam_routing_policy_registrations(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
DeltaJson='string',
Force=True|False,
ClientToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
string
[REQUIRED]
The batch modifications to apply, in JSON format.
boolean
Forces the batch modification even if individual changes conflict with announced routes. Default: false.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamRoutingPolicyRegistrationDelta': {
'DeltaId': 'string',
'DeltaJson': 'string',
'State': 'pending'|'published'|'failed',
'StateMessage': 'string'
}
}
Response Structure
(dict) --
IpamRoutingPolicyRegistrationDelta (dict) --
Information about the routing policy registration delta created by this batch operation.
DeltaId (string) --
The unique identifier of the delta.
DeltaJson (string) --
The JSON specification describing the changes applied in this delta.
State (string) --
The state of the delta. Valid values: pending | published | failed.
StateMessage (string) --
A message describing the current state, including error information if the delta failed.
Retrieves route protection findings for an IPAM. Route protection findings show the Resource Public Key Infrastructure (RPKI) validation status of your Bring Your Own IP (BYOIP) routes. Findings identify routes that have valid, invalid, or unknown validation states. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.get_ipam_route_protection_findings(
DryRun=True|False,
IpamId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM to retrieve route protection findings for.
list
One or more filters to apply to the results.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
dict
Response Syntax
{
'IpamId': 'string',
'RouteProtectionFindings': [
{
'ResourceOwnerId': 'string',
'ResourceRegion': 'string',
'IpamPoolId': 'string',
'Cidr': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'AdvertisementType': 'regional'|'global',
'NetworkBorderGroup': 'string',
'PoolId': 'string',
'Asn': 'string',
'RpkiStatus': 'valid'|'invalid'|'unknown',
'RpkiStrength': 'strict'|'permissive',
'Roas': [
{
'Asn': 'string',
'Prefix': 'string',
'MaxLength': 123,
'Match': True|False,
'Expiration': datetime(2015, 1, 1)
},
],
'RouteOverlaps': [
{
'Prefix': 'string',
'Asn': 'string',
'DetectedAt': datetime(2015, 1, 1)
},
],
'SampleTime': datetime(2015, 1, 1),
'RoaSampleTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IpamId (string) --
The ID of the IPAM.
RouteProtectionFindings (list) --
The route protection findings.
(dict) --
Contains information about a route protection finding, including the RPKI validation status of a BYOIP route announcement.
ResourceOwnerId (string) --
The ID of the resource owner.
ResourceRegion (string) --
The Amazon Web Services Region of the resource.
IpamPoolId (string) --
The ID of the IPAM pool associated with the finding.
Cidr (string) --
The IP address prefix in CIDR notation.
State (string) --
The state of the BYOIP CIDR. Possible values:
advertised - The CIDR is being advertised.
deprovisioned - The CIDR has been deprovisioned.
failed-deprovision - Deprovisioning failed.
failed-provision - Provisioning failed.
pending-deprovision - Deprovisioning is in progress.
pending-provision - Provisioning is in progress.
provisioned - The CIDR is provisioned.
provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.
AdvertisementType (string) --
The advertisement type. Possible values:
regional - The IP address is advertised from a single location (regional services such as Amazon EC2).
global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).
NetworkBorderGroup (string) --
The network border group.
PoolId (string) --
The ID of the BYOIP pool.
Asn (string) --
The Autonomous System Number (ASN) that originates the route.
RpkiStatus (string) --
The RPKI validation status of the route. Possible values:
valid - The route has a matching ROA that covers the prefix and origin ASN.
invalid - The route has a ROA for the prefix, but the origin ASN or prefix length does not match.
unknown - No ROA exists for the prefix, so RPKI validation cannot be performed.
RpkiStrength (string) --
The RPKI enforcement strength for the route. Possible values:
strict - Invalid routes are rejected.
permissive - Invalid routes are accepted but flagged.
Roas (list) --
The Route Origin Authorizations (ROAs) that cover the prefix.
(dict) --
Contains information about a Route Origin Authorization (ROA) published in the RPKI. A ROA cryptographically attests that a specific ASN is authorized to originate a specific IP address prefix.
Asn (string) --
The Autonomous System Number (ASN) authorized by the ROA.
Prefix (string) --
The IP address prefix authorized by the ROA in CIDR notation.
MaxLength (integer) --
The maximum prefix length that the ASN is authorized to announce.
Match (boolean) --
Specifies whether the ROA matches the route announcement.
Expiration (datetime) --
The expiration date of the ROA.
RouteOverlaps (list) --
The overlapping routes detected for this prefix.
(dict) --
Contains information about an overlapping route detected for a BYOIP prefix.
Prefix (string) --
The overlapping IP address prefix in CIDR notation.
Asn (string) --
The ASN originating the overlapping route.
DetectedAt (datetime) --
The time when the overlap was detected.
SampleTime (datetime) --
The time when the route was last sampled.
RoaSampleTime (datetime) --
The time when the ROA data was last sampled.
NextToken (string) --
The token to use to retrieve the next page of results.
Retrieves the history of routing policy registration changes for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.get_ipam_routing_policy_registration_deltas(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
DeltaId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
ChronologicalOrder='forward'|'reverse',
MaxResults=123,
NextToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
string
Filter results to a specific delta ID.
datetime
The start of the time range to filter deltas by.
datetime
The end of the time range to filter deltas by.
string
The chronological order to return results in. Valid values: forward | reverse.
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'IpamRoutingPolicyRegistrationDeltas': [
{
'DeltaId': 'string',
'DeltaJson': 'string',
'State': 'pending'|'published'|'failed',
'StateMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IpamRoutingPolicyRegistrationDeltas (list) --
The routing policy registration deltas.
(dict) --
Contains information about a routing policy registration change, including the changes applied and their publication state.
DeltaId (string) --
The unique identifier of the delta.
DeltaJson (string) --
The JSON specification describing the changes applied in this delta.
State (string) --
The state of the delta. Valid values: pending | published | failed.
StateMessage (string) --
A message describing the current state, including error information if the delta failed.
NextToken (string) --
The token to use to retrieve the next page of results.
Retrieves routing policy registrations for an IPAM internet registry association. Each registration represents a Route Origin Authorization (ROA) that has been created or is pending publication to the RPKI. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.get_ipam_routing_policy_registrations(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
Cidr='string',
MaxResults=123,
NextToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
string
Filter results to a specific CIDR prefix.
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'IpamRoutingPolicyRegistrations': [
{
'Cidr': 'string',
'Asns': [
'string',
],
'PermitMoreSpecificAnnouncements': True|False,
'MaxLength': 123,
'Description': 'string',
'LatestDeltaId': 'string',
'State': 'pending-activate'|'activate-failed'|'create-in-progress'|'create-complete'|'update-in-progress'|'update-complete'|'delete-in-progress'|'delete-complete'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IpamRoutingPolicyRegistrations (list) --
The routing policy registrations.
(dict) --
Contains information about a routing policy registration that represents a Route Origin Authorization (ROA) managed through IPAM.
Cidr (string) --
The IP address prefix in CIDR notation authorized by the ROA.
Asns (list) --
The Autonomous System Numbers (ASNs) authorized to originate the prefix.
(string) --
PermitMoreSpecificAnnouncements (boolean) --
Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.
MaxLength (integer) --
The maximum prefix length that the ASNs are authorized to announce.
Description (string) --
The description of the routing policy registration.
LatestDeltaId (string) --
The ID of the most recent delta that modified this registration.
State (string) --
The state of the routing policy registration. Valid values: pending-activate | activate-failed | create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | delete-complete.
NextToken (string) --
The token to use to retrieve the next page of results.
Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry.
See also: AWS API Documentation
Request Syntax
client.delete_ipam_internet_registry_association(
DryRun=True|False,
IpamInternetRegistryAssociationId='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association to delete.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the deleted internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
Retrieves IP address CIDRs registered with an internet registry for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.get_ipam_internet_registry_association_cidrs(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
list
One or more filters to apply to the results.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'IpamInternetRegistryAssociationCidrs': [
{
'Cidr': 'string',
'LastObservedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results.
IpamInternetRegistryAssociationCidrs (list) --
The CIDRs registered with the internet registry.
(dict) --
Contains information about an IP address CIDR registered at an internet registry and associated with an IPAM.
Cidr (string) --
The IP address prefix in CIDR notation.
LastObservedAt (datetime) --
The time when the CIDR was last observed at the internet registry.
Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.
See also: AWS API Documentation
Request Syntax
client.create_ipam_routing_policy_registration(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
Cidr='string',
Asns=[
'string',
],
PermitMoreSpecificAnnouncements=True|False,
MaxLength=123,
Description='string',
Force=True|False,
ClientToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
string
[REQUIRED]
The IP address prefix in CIDR notation to authorize in the ROA.
list
[REQUIRED]
The Autonomous System Numbers (ASNs) authorized to originate the prefix.
(string) --
boolean
Specifies whether to permit more specific route announcements than the CIDR prefix. When enabled, ASNs can announce sub-prefixes of the authorized CIDR up to the specified maximum length. Default: false.
integer
The maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR. If not specified, defaults to the prefix length of the CIDR (exact match only).
string
A description for the routing policy registration.
boolean
Forces the creation of the routing policy registration even if it conflicts with an announced route. Default: false.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamRoutingPolicyRegistrationDelta': {
'DeltaId': 'string',
'DeltaJson': 'string',
'State': 'pending'|'published'|'failed',
'StateMessage': 'string'
}
}
Response Structure
(dict) --
IpamRoutingPolicyRegistrationDelta (dict) --
Information about the routing policy registration delta created by this operation.
DeltaId (string) --
The unique identifier of the delta.
DeltaJson (string) --
The JSON specification describing the changes applied in this delta.
State (string) --
The state of the delta. Valid values: pending | published | failed.
StateMessage (string) --
A message describing the current state, including error information if the delta failed.
Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.describe_ipam_internet_registry_associations(
DryRun=True|False,
IpamInternetRegistryAssociationIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
boolean
Checks whether you have the required permissions for the operation, 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.
list
The IDs of the internet registry associations to describe.
(string) --
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
list
One or more filters to apply to the results.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'IpamInternetRegistryAssociations': [
{
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results.
IpamInternetRegistryAssociations (list) --
The internet registry associations.
(dict) --
Contains information about an association between an IPAM and a Regional Internet Registry (RIR) for delegated RPKI management.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.
See also: AWS API Documentation
Request Syntax
client.enable_ipam_internet_registry_association(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
RpkiVersion='string',
ServiceUri='string',
ChildHandle='string',
ParentHandle='string',
ParentBpkiTa='string',
ClientToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association to enable.
string
[REQUIRED]
The RPKI version to use from the Parent Response XML.
string
[REQUIRED]
The RPKI service URI for the publication point from the Parent Response XML.
string
[REQUIRED]
The child handle for the BPKI certificate hierarchy from the Parent Response XML.
string
[REQUIRED]
The parent handle for the BPKI certificate hierarchy from the Parent Response XML.
string
[REQUIRED]
The parent BPKI Trust Anchor certificate in PEM format from the Parent Response XML.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the enabled internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.
See also: AWS API Documentation
Request Syntax
client.create_ipam_internet_registry_association(
DryRun=True|False,
IpamId='string',
Rir='ripe'|'apnic'|'arin'|'lacnic',
OrganizationHandle='string',
Description='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM to associate with the internet registry.
string
[REQUIRED]
The Regional Internet Registry to associate with. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
string
[REQUIRED]
The organization handle at the internet registry (for example, a RIPE NCC organization ID or ARIN Org ID).
string
A description for the internet registry association.
list
The tags to assign to the internet registry association.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamInternetRegistryAssociation': {
'OwnerId': 'string',
'IpamInternetRegistryAssociationId': 'string',
'IpamInternetRegistryAssociationArn': 'string',
'IpamId': 'string',
'IpamRegion': 'string',
'Rir': 'ripe'|'apnic'|'arin'|'lacnic',
'OrganizationHandle': 'string',
'Description': 'string',
'State': 'pending-enable'|'create-in-progress'|'create-failed'|'enable-in-progress'|'enable-complete'|'enable-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'ChildRequestXml': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
IpamInternetRegistryAssociation (dict) --
Information about the internet registry association.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the internet registry association.
IpamInternetRegistryAssociationId (string) --
The ID of the internet registry association.
IpamInternetRegistryAssociationArn (string) --
The Amazon Resource Name (ARN) of the internet registry association.
IpamId (string) --
The ID of the associated IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
Rir (string) --
The Regional Internet Registry. Possible values:
ripe - RIPE NCC (Europe, the Middle East, and Central Asia).
apnic - APNIC (Asia Pacific).
arin - ARIN (North America).
lacnic - LACNIC (Latin America and the Caribbean).
OrganizationHandle (string) --
The organization handle at the internet registry.
Description (string) --
The description of the internet registry association.
State (string) --
The state of the internet registry association. Valid values: pending-activation | pending-enable | create-in-progress | create-failed | enable-in-progress | enable-complete | enable-failed | delete-in-progress | delete-complete | delete-failed.
ChildRequestXml (string) --
The XML content for the child request to be submitted to the internet registry to complete the BPKI setup.
Tags (list) --
The tags assigned to the internet registry association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA).
See also: AWS API Documentation
Request Syntax
client.modify_ipam_routing_policy_registration(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
Cidr='string',
Asns=[
'string',
],
PermitMoreSpecificAnnouncements=True|False,
MaxLength=123,
Description='string',
Force=True|False,
ClientToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
string
[REQUIRED]
The IP address prefix in CIDR notation identifying the routing policy registration to modify.
list
[REQUIRED]
The updated list of Autonomous System Numbers (ASNs) authorized to originate the prefix.
(string) --
boolean
Specifies whether to permit more specific route announcements than the CIDR prefix. Default: false.
integer
The new maximum prefix length that the ASNs are authorized to announce. Must be greater than or equal to the prefix length of the CIDR.
string
A new description for the routing policy registration.
boolean
Forces the modification even if it conflicts with an announced route. Default: false.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'IpamRoutingPolicyRegistrationDelta': {
'DeltaId': 'string',
'DeltaJson': 'string',
'State': 'pending'|'published'|'failed',
'StateMessage': 'string'
}
}
Response Structure
(dict) --
IpamRoutingPolicyRegistrationDelta (dict) --
Information about the routing policy registration delta created by this modification.
DeltaId (string) --
The unique identifier of the delta.
DeltaJson (string) --
The JSON specification describing the changes applied in this delta.
State (string) --
The state of the delta. Valid values: pending | published | failed.
StateMessage (string) --
A message describing the current state, including error information if the delta failed.
Retrieves the current Route Origin Authorizations (ROAs) published to the RPKI for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.get_ipam_route_origin_authorizations(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
Cidr='string',
MaxResults=123,
NextToken='string'
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
string
Filter results to a specific CIDR prefix.
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
dict
Response Syntax
{
'IpamRouteOriginAuthorizations': [
{
'Cidr': 'string',
'Asn': 'string',
'MaxLength': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IpamRouteOriginAuthorizations (list) --
The Route Origin Authorizations published to the RPKI.
(dict) --
Contains information about a Route Origin Authorization (ROA) currently published in the RPKI.
Cidr (string) --
The IP address prefix in CIDR notation authorized by the ROA.
Asn (string) --
The Autonomous System Number (ASN) authorized to originate the prefix.
MaxLength (integer) --
The maximum prefix length that the ASN is authorized to announce.
NextToken (string) --
The token to use to retrieve the next page of results.
Retrieves Autonomous System Numbers (ASNs) registered with an internet registry for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.get_ipam_internet_registry_association_asns(
DryRun=True|False,
IpamInternetRegistryAssociationId='string',
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM internet registry association.
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
list
One or more filters to apply to the results.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'IpamInternetRegistryAssociationAsns': [
{
'Asn': 'string',
'LastObservedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results.
IpamInternetRegistryAssociationAsns (list) --
The ASNs registered with the internet registry.
(dict) --
Contains information about an Autonomous System Number (ASN) registered at an internet registry and associated with an IPAM.
Asn (string) --
The Autonomous System Number.
LastObservedAt (datetime) --
The time when the ASN was last observed at the internet registry.
Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region. Use this operation to view the Bring Your Own IP (BYOIP) address ranges that are currently advertised through BGP. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.get_ipam_discovered_routes(
DryRun=True|False,
IpamResourceDiscoveryId='string',
ResourceRegion='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
boolean
Checks whether you have the required permissions for the operation, 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.
string
[REQUIRED]
The ID of the IPAM resource discovery.
string
[REQUIRED]
The Amazon Web Services Region to retrieve discovered routes for.
list
One or more filters to apply to the results.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
string
The token for the next page of results.
integer
The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
dict
Response Syntax
{
'IpamDiscoveredRoutes': [
{
'IpamResourceDiscoveryId': 'string',
'ResourceRegion': 'string',
'ResourceOwnerId': 'string',
'Cidr': 'string',
'Asn': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'AdvertisementType': 'regional'|'global',
'NetworkBorderGroup': 'string',
'PoolId': 'string',
'IpamPoolId': 'string',
'SampleTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IpamDiscoveredRoutes (list) --
The discovered BGP routes.
(dict) --
Contains information about a BGP route discovered by IPAM resource discovery.
IpamResourceDiscoveryId (string) --
The ID of the IPAM resource discovery that discovered the route.
ResourceRegion (string) --
The Amazon Web Services Region where the route was discovered.
ResourceOwnerId (string) --
The ID of the resource owner.
Cidr (string) --
The IP address prefix of the discovered route in CIDR notation.
Asn (string) --
The Autonomous System Number (ASN) that originates the route.
State (string) --
The state of the BYOIP CIDR. Possible values:
advertised - The CIDR is being advertised.
deprovisioned - The CIDR has been deprovisioned.
failed-deprovision - Deprovisioning failed.
failed-provision - Provisioning failed.
pending-deprovision - Deprovisioning is in progress.
pending-provision - Provisioning is in progress.
provisioned - The CIDR is provisioned.
provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.
AdvertisementType (string) --
The advertisement type of the route. Possible values:
regional - The IP address is advertised from a single location (regional services such as Amazon EC2).
global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).
NetworkBorderGroup (string) --
The network border group for the route.
PoolId (string) --
The ID of the BYOIP pool associated with the route.
IpamPoolId (string) --
The ID of the IPAM pool associated with the route.
SampleTime (datetime) --
The time when the route was last sampled.
NextToken (string) --
The token to use to retrieve the next page of results.
{'ByoipCidr': {'IpamPoolId': 'string', 'PoolId': 'string'}}
Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
See also: AWS API Documentation
Request Syntax
client.advertise_byoip_cidr(
Cidr='string',
Asn='string',
DryRun=True|False,
NetworkBorderGroup='string'
)
string
[REQUIRED]
The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.
string
The public 2-byte or 4-byte ASN that you want to advertise.
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.
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
dict
Response Syntax
{
'ByoipCidr': {
'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-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string',
'AdvertisementType': 'string',
'PoolId': 'string',
'IpamPoolId': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
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
AdvertisementType (string) --
Specifies the advertisement method for the BYOIP CIDR. Valid values are:
unicast: IP is advertised from a single location (regional services like EC2)
anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.
PoolId (string) --
The ID of the address pool associated with the CIDR.
IpamPoolId (string) --
The ID of the IPAM pool associated with the CIDR.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}}}
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}}}
Response {'LaunchTemplateVersion': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}}}}
{'ByoipCidr': {'IpamPoolId': 'string', 'PoolId': 'string'}}
Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it and you must not have any IP addresses allocated from its address range.
See also: AWS API Documentation
Request Syntax
client.deprovision_byoip_cidr(
Cidr='string',
DryRun=True|False
)
string
[REQUIRED]
The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
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.
dict
Response Syntax
{
'ByoipCidr': {
'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-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string',
'AdvertisementType': 'string',
'PoolId': 'string',
'IpamPoolId': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
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
AdvertisementType (string) --
Specifies the advertisement method for the BYOIP CIDR. Valid values are:
unicast: IP is advertised from a single location (regional services like EC2)
anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.
PoolId (string) --
The ID of the address pool associated with the CIDR.
IpamPoolId (string) --
The ID of the IPAM pool associated with the CIDR.
{'ByoipCidrs': {'IpamPoolId': 'string', 'PoolId': 'string'}}
Describes the IP address ranges that were provisioned for use with Amazon Web Services resources through through bring your own IP addresses (BYOIP).
See also: AWS API Documentation
Request Syntax
client.describe_byoip_cidrs(
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
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.
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.
string
The token for the next page of results.
dict
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-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string',
'AdvertisementType': 'string',
'PoolId': 'string',
'IpamPoolId': '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
AdvertisementType (string) --
Specifies the advertisement method for the BYOIP CIDR. Valid values are:
unicast: IP is advertised from a single location (regional services like EC2)
anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.
PoolId (string) --
The ID of the address pool associated with the CIDR.
IpamPoolId (string) --
The ID of the IPAM pool associated with the CIDR.
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.
{'LaunchTemplateVersions': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}}}}
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}},
'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}}}}
{'Tags': {'ResourceType': {'ipam-internet-registry-association'}}}
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_tags(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
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.
list
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'NextToken': 'string',
'Tags': [
{
'Key': 'string',
'ResourceId': 'string',
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Value': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type.
Value (string) --
The tag value.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}}}
{'ByoipCidr': {'IpamPoolId': 'string', 'PoolId': 'string'}}
Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.
If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
See also: AWS API Documentation
Request Syntax
client.move_byoip_cidr_to_ipam(
DryRun=True|False,
Cidr='string',
IpamPoolId='string',
IpamPoolOwner='string'
)
boolean
A check for 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.
string
[REQUIRED]
The BYOIP CIDR.
string
[REQUIRED]
The IPAM pool ID.
string
[REQUIRED]
The Amazon Web Services account ID of the owner of the IPAM pool.
dict
Response Syntax
{
'ByoipCidr': {
'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-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string',
'AdvertisementType': 'string',
'PoolId': 'string',
'IpamPoolId': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
The BYOIP CIDR.
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
AdvertisementType (string) --
Specifies the advertisement method for the BYOIP CIDR. Valid values are:
unicast: IP is advertised from a single location (regional services like EC2)
anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.
PoolId (string) --
The ID of the address pool associated with the CIDR.
IpamPoolId (string) --
The ID of the IPAM pool associated with the CIDR.
{'PoolTagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}}
Response {'ByoipCidr': {'IpamPoolId': 'string', 'PoolId': 'string'}}
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range.
See also: AWS API Documentation
Request Syntax
client.provision_byoip_cidr(
Cidr='string',
CidrAuthorizationContext={
'Message': 'string',
'Signature': 'string'
},
PubliclyAdvertisable=True|False,
Description='string',
DryRun=True|False,
PoolTagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'ipam-internet-registry-association'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiRegion=True|False,
NetworkBorderGroup='string'
)
string
[REQUIRED]
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
dict
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Message (string) -- [REQUIRED]
The plain-text authorization message for the prefix and account.
Signature (string) -- [REQUIRED]
The signed authorization message for the prefix and account.
boolean
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
string
A description for the address range and the address pool.
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.
list
The tags to apply to the address pool.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
boolean
Reserved.
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
dict
Response Syntax
{
'ByoipCidr': {
'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-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string',
'AdvertisementType': 'string',
'PoolId': 'string',
'IpamPoolId': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
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
AdvertisementType (string) --
Specifies the advertisement method for the BYOIP CIDR. Valid values are:
unicast: IP is advertised from a single location (regional services like EC2)
anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.
PoolId (string) --
The ID of the address pool associated with the CIDR.
IpamPoolId (string) --
The ID of the IPAM pool associated with the CIDR.
{'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}},
'TagSpecifications': {'ResourceType': {'ipam-internet-registry-association'}}}}
{'ByoipCidr': {'IpamPoolId': 'string', 'PoolId': 'string'}}
Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.
See also: AWS API Documentation
Request Syntax
client.withdraw_byoip_cidr(
Cidr='string',
DryRun=True|False
)
string
[REQUIRED]
The address range, in CIDR notation.
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.
dict
Response Syntax
{
'ByoipCidr': {
'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-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string',
'AdvertisementType': 'string',
'PoolId': 'string',
'IpamPoolId': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address pool.
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
AdvertisementType (string) --
Specifies the advertisement method for the BYOIP CIDR. Valid values are:
unicast: IP is advertised from a single location (regional services like EC2)
anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.
PoolId (string) --
The ID of the address pool associated with the CIDR.
IpamPoolId (string) --
The ID of the IPAM pool associated with the CIDR.