2026/02/09 - Amazon Elastic Compute Cloud - 7 new11 updated api methods
Changes Amazon Secondary Networks is a networking feature that provides high-performance, low-latency connectivity for specialized workloads.
Describes one or more secondary networks.
See also: AWS API Documentation
Request Syntax
client.describe_secondary_networks(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
SecondaryNetworkIds=[
'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. The following are the possible values:
ipv4-cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the secondary network.
ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary network.
ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary network.
owner-id - The ID of the Amazon Web Services account that owns the secondary network.
secondary-network-id - The ID of the secondary network.
secondary-network-arn - The ARN of the secondary network.
state - The state of the secondary network ( create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of the secondary network ( rdma).
(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 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.
list
The IDs of the secondary networks.
(string) --
dict
Response Syntax
{
'SecondaryNetworks': [
{
'SecondaryNetworkId': 'string',
'SecondaryNetworkArn': 'string',
'OwnerId': 'string',
'Type': 'rdma',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateReason': 'string',
'Ipv4CidrBlockAssociations': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
'StateReason': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecondaryNetworks (list) --
Information about the secondary networks.
(dict) --
Describes a secondary network.
SecondaryNetworkId (string) --
The ID of the secondary network.
SecondaryNetworkArn (string) --
The Amazon Resource Name (ARN) of the secondary network.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the secondary network.
Type (string) --
The type of the secondary network.
State (string) --
The state of the secondary network.
StateReason (string) --
The reason for the current state of the secondary network.
Ipv4CidrBlockAssociations (list) --
Information about the IPv4 CIDR blocks associated with the secondary network.
(dict) --
Describes an IPv4 CIDR block associated with a secondary network.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
State (string) --
The state of the CIDR block association.
StateReason (string) --
The reason for the current state of the CIDR block association.
Tags (list) --
The tags assigned to the secondary network.
(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.
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.
Deletes a secondary network. You must delete all secondary subnets in the secondary network before you can delete the secondary network.
See also: AWS API Documentation
Request Syntax
client.delete_secondary_network(
ClientToken='string',
DryRun=True|False,
SecondaryNetworkId='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
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
[REQUIRED]
The ID of the secondary network.
dict
Response Syntax
{
'SecondaryNetwork': {
'SecondaryNetworkId': 'string',
'SecondaryNetworkArn': 'string',
'OwnerId': 'string',
'Type': 'rdma',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateReason': 'string',
'Ipv4CidrBlockAssociations': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
'StateReason': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
SecondaryNetwork (dict) --
Information about the secondary network.
SecondaryNetworkId (string) --
The ID of the secondary network.
SecondaryNetworkArn (string) --
The Amazon Resource Name (ARN) of the secondary network.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the secondary network.
Type (string) --
The type of the secondary network.
State (string) --
The state of the secondary network.
StateReason (string) --
The reason for the current state of the secondary network.
Ipv4CidrBlockAssociations (list) --
Information about the IPv4 CIDR blocks associated with the secondary network.
(dict) --
Describes an IPv4 CIDR block associated with a secondary network.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
State (string) --
The state of the CIDR block association.
StateReason (string) --
The reason for the current state of the CIDR block association.
Tags (list) --
The tags assigned to the secondary network.
(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.
ClientToken (string) --
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
Creates an Amazon secondary network.
The allowed size for a secondary network CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses).
See also: AWS API Documentation
Request Syntax
client.create_secondary_network(
ClientToken='string',
DryRun=True|False,
Ipv4CidrBlock='string',
NetworkType='rdma',
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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
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
[REQUIRED]
The IPv4 CIDR block for the secondary network. The CIDR block size must be between /12 and /28.
string
[REQUIRED]
The type of secondary network.
list
The tags to assign to the secondary network.
(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.
dict
Response Syntax
{
'SecondaryNetwork': {
'SecondaryNetworkId': 'string',
'SecondaryNetworkArn': 'string',
'OwnerId': 'string',
'Type': 'rdma',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateReason': 'string',
'Ipv4CidrBlockAssociations': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
'StateReason': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
SecondaryNetwork (dict) --
Information about the secondary network.
SecondaryNetworkId (string) --
The ID of the secondary network.
SecondaryNetworkArn (string) --
The Amazon Resource Name (ARN) of the secondary network.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the secondary network.
Type (string) --
The type of the secondary network.
State (string) --
The state of the secondary network.
StateReason (string) --
The reason for the current state of the secondary network.
Ipv4CidrBlockAssociations (list) --
Information about the IPv4 CIDR blocks associated with the secondary network.
(dict) --
Describes an IPv4 CIDR block associated with a secondary network.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
State (string) --
The state of the CIDR block association.
StateReason (string) --
The reason for the current state of the CIDR block association.
Tags (list) --
The tags assigned to the secondary network.
(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.
ClientToken (string) --
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
Describes one or more of your secondary subnets.
See also: AWS API Documentation
Request Syntax
client.describe_secondary_subnets(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
SecondarySubnetIds=[
'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.
ipv4-cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the secondary subnet.
ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary subnet.
ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary subnet.
owner-id - The ID of the Amazon Web Services account that owns the secondary subnet.
secondary-network-id - The ID of the secondary network.
secondary-network-type - The type of the secondary network ( rdma).
secondary-subnet-id - The ID of the secondary subnet.
secondary-subnet-arn - The ARN of the secondary subnet.
state - The state of the secondary subnet ( create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of 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 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.
list
The IDs of the secondary subnets.
(string) --
dict
Response Syntax
{
'SecondarySubnets': [
{
'SecondarySubnetId': 'string',
'SecondarySubnetArn': 'string',
'SecondaryNetworkId': 'string',
'SecondaryNetworkType': 'rdma',
'OwnerId': 'string',
'AvailabilityZoneId': 'string',
'AvailabilityZone': 'string',
'Ipv4CidrBlockAssociations': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
'StateReason': 'string'
},
],
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateReason': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecondarySubnets (list) --
Information about the secondary subnets.
(dict) --
Describes a secondary subnet.
SecondarySubnetId (string) --
The ID of the secondary subnet.
SecondarySubnetArn (string) --
The Amazon Resource Name (ARN) of the secondary subnet.
SecondaryNetworkId (string) --
The ID of the secondary network.
SecondaryNetworkType (string) --
The type of the secondary network.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the secondary subnet.
AvailabilityZoneId (string) --
The ID of the Availability Zone of the secondary subnet.
AvailabilityZone (string) --
The Availability Zone of the secondary subnet.
Ipv4CidrBlockAssociations (list) --
Information about the IPv4 CIDR blocks associated with the secondary subnet.
(dict) --
Describes an IPv4 CIDR block associated with a secondary subnet.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
State (string) --
The state of the CIDR block association.
StateReason (string) --
The reason for the current state of the CIDR block association.
State (string) --
The state of the secondary subnet.
StateReason (string) --
The reason for the current state of the secondary subnet.
Tags (list) --
The tags assigned to the secondary subnet.
(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.
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.
Deletes a secondary subnet. A secondary subnet must not contain any secondary interfaces prior to deletion.
See also: AWS API Documentation
Request Syntax
client.delete_secondary_subnet(
ClientToken='string',
DryRun=True|False,
SecondarySubnetId='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
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
[REQUIRED]
The ID of the secondary subnet to delete.
dict
Response Syntax
{
'SecondarySubnet': {
'SecondarySubnetId': 'string',
'SecondarySubnetArn': 'string',
'SecondaryNetworkId': 'string',
'SecondaryNetworkType': 'rdma',
'OwnerId': 'string',
'AvailabilityZoneId': 'string',
'AvailabilityZone': 'string',
'Ipv4CidrBlockAssociations': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
'StateReason': 'string'
},
],
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateReason': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
SecondarySubnet (dict) --
Information about the secondary subnet being deleted.
SecondarySubnetId (string) --
The ID of the secondary subnet.
SecondarySubnetArn (string) --
The Amazon Resource Name (ARN) of the secondary subnet.
SecondaryNetworkId (string) --
The ID of the secondary network.
SecondaryNetworkType (string) --
The type of the secondary network.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the secondary subnet.
AvailabilityZoneId (string) --
The ID of the Availability Zone of the secondary subnet.
AvailabilityZone (string) --
The Availability Zone of the secondary subnet.
Ipv4CidrBlockAssociations (list) --
Information about the IPv4 CIDR blocks associated with the secondary subnet.
(dict) --
Describes an IPv4 CIDR block associated with a secondary subnet.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
State (string) --
The state of the CIDR block association.
StateReason (string) --
The reason for the current state of the CIDR block association.
State (string) --
The state of the secondary subnet.
StateReason (string) --
The reason for the current state of the secondary subnet.
Tags (list) --
The tags assigned to the secondary subnet.
(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.
ClientToken (string) --
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
Describes one or more of your secondary interfaces.
See also: AWS API Documentation
Request Syntax
client.describe_secondary_interfaces(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
SecondaryInterfaceIds=[
'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.
attachment.attachment-id - The ID of the secondary interface attachment.
attachment.instance-id - The ID of the instance to which the secondary interface is attached.
attachment.instance-owner-id - The ID of the Amazon Web Services account that owns the instance to which the secondary interface is attached.
attachment.status - The attachment status ( attaching | attached | detaching | detached).
private-ipv4-addresses.private-ip-address - The private IPv4 address associated with the secondary interface.
owner-id - The ID of the Amazon Web Services account that owns the secondary interface.
secondary-interface-arn - The ARN of the secondary interface.
secondary-interface-id - The ID of the secondary interface.
secondary-interface-type - The type of secondary interface ( secondary).
secondary-network-id - The ID of the secondary network.
secondary-network-type - The type of the secondary network ( rdma).
secondary-subnet-id - The ID of the secondary subnet.
status - The status of the secondary interface ( available | in-use).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of 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 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.
list
The IDs of the secondary interfaces.
(string) --
dict
Response Syntax
{
'SecondaryInterfaces': [
{
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'Attachment': {
'AttachmentId': 'string',
'AttachTime': datetime(2015, 1, 1),
'DeleteOnTermination': True|False,
'DeviceIndex': 123,
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'NetworkCardIndex': 123,
'Status': 'attaching'|'attached'|'detaching'|'detached'
},
'MacAddress': 'string',
'OwnerId': 'string',
'PrivateIpv4Addresses': [
{
'PrivateIpAddress': 'string'
},
],
'SecondaryInterfaceId': 'string',
'SecondaryInterfaceArn': 'string',
'SecondaryInterfaceType': 'secondary',
'SecondarySubnetId': 'string',
'SecondaryNetworkId': 'string',
'SecondaryNetworkType': 'rdma',
'SourceDestCheck': True|False,
'Status': 'available'|'in-use',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecondaryInterfaces (list) --
Information about the secondary interfaces.
(dict) --
Describes a secondary interface.
AvailabilityZone (string) --
The Availability Zone of the secondary interface.
AvailabilityZoneId (string) --
The ID of the Availability Zone of the secondary interface.
Attachment (dict) --
The attachment information for the secondary interface.
AttachmentId (string) --
The ID of the attachment.
AttachTime (datetime) --
The timestamp when the attachment was created.
DeleteOnTermination (boolean) --
Indicates whether the secondary interface is deleted when the instance is terminated.
The only supported value for this field is true.
DeviceIndex (integer) --
The device index of the secondary interface.
InstanceId (string) --
The ID of the instance to which the secondary interface is attached.
InstanceOwnerId (string) --
The Amazon Web Services account ID of the owner of the instance.
NetworkCardIndex (integer) --
The index of the network card.
Status (string) --
The attachment state.
MacAddress (string) --
The MAC address of the secondary interface.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the secondary interface.
PrivateIpv4Addresses (list) --
The private IPv4 addresses associated with the secondary interface.
(dict) --
Describes a private IPv4 address for a secondary interface.
PrivateIpAddress (string) --
The private IPv4 address.
SecondaryInterfaceId (string) --
The ID of the secondary interface.
SecondaryInterfaceArn (string) --
The Amazon Resource Name (ARN) of the secondary interface.
SecondaryInterfaceType (string) --
The type of secondary interface.
SecondarySubnetId (string) --
The ID of the secondary subnet.
SecondaryNetworkId (string) --
The ID of the secondary network.
SecondaryNetworkType (string) --
The type of the secondary network.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
Status (string) --
The status of the secondary interface.
Tags (list) --
The tags assigned to the secondary interface.
(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.
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.
Creates a secondary subnet in a secondary network.
A secondary subnet CIDR block must not overlap with the CIDR block of an existing secondary subnet in the secondary network. After you create a secondary subnet, you can't change its CIDR block.
The allowed size for a secondary subnet CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses). Amazon reserves the first four IP addresses and the last IP address in each secondary subnet for internal use.
See also: AWS API Documentation
Request Syntax
client.create_secondary_subnet(
ClientToken='string',
AvailabilityZone='string',
AvailabilityZoneId='string',
DryRun=True|False,
Ipv4CidrBlock='string',
SecondaryNetworkId='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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
string
The Availability Zone for the secondary subnet. You cannot specify both AvailabilityZone and AvailabilityZoneId in the same request.
string
The ID of the Availability Zone for the secondary subnet. This option is preferred over AvailabilityZone as it provides a consistent identifier across Amazon Web Services accounts. You cannot specify both AvailabilityZone and AvailabilityZoneId in the same request.
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
[REQUIRED]
The IPv4 CIDR block for the secondary subnet. The CIDR block size must be between /12 and /28.
string
[REQUIRED]
The ID of the secondary network in which to create the secondary subnet.
list
The tags to assign to the secondary subnet.
(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.
dict
Response Syntax
{
'SecondarySubnet': {
'SecondarySubnetId': 'string',
'SecondarySubnetArn': 'string',
'SecondaryNetworkId': 'string',
'SecondaryNetworkType': 'rdma',
'OwnerId': 'string',
'AvailabilityZoneId': 'string',
'AvailabilityZone': 'string',
'Ipv4CidrBlockAssociations': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
'StateReason': 'string'
},
],
'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateReason': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
SecondarySubnet (dict) --
Information about the secondary subnet.
SecondarySubnetId (string) --
The ID of the secondary subnet.
SecondarySubnetArn (string) --
The Amazon Resource Name (ARN) of the secondary subnet.
SecondaryNetworkId (string) --
The ID of the secondary network.
SecondaryNetworkType (string) --
The type of the secondary network.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the secondary subnet.
AvailabilityZoneId (string) --
The ID of the Availability Zone of the secondary subnet.
AvailabilityZone (string) --
The Availability Zone of the secondary subnet.
Ipv4CidrBlockAssociations (list) --
Information about the IPv4 CIDR blocks associated with the secondary subnet.
(dict) --
Describes an IPv4 CIDR block associated with a secondary subnet.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
State (string) --
The state of the CIDR block association.
StateReason (string) --
The reason for the current state of the CIDR block association.
State (string) --
The state of the secondary subnet.
StateReason (string) --
The reason for the current state of the secondary subnet.
Tags (list) --
The tags assigned to the secondary subnet.
(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.
ClientToken (string) --
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
{'LaunchTemplateData': {'SecondaryInterfaces': [{'DeleteOnTermination': 'boolean',
'DeviceIndex': 'integer',
'InterfaceType': 'secondary',
'NetworkCardIndex': 'integer',
'PrivateIpAddressCount': 'integer',
'PrivateIpAddresses': [{'PrivateIpAddress': 'string'}],
'SecondarySubnetId': 'string'}],
'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}}
{'LaunchTemplateData': {'SecondaryInterfaces': [{'DeleteOnTermination': 'boolean',
'DeviceIndex': 'integer',
'InterfaceType': 'secondary',
'NetworkCardIndex': 'integer',
'PrivateIpAddressCount': 'integer',
'PrivateIpAddresses': [{'PrivateIpAddress': 'string'}],
'SecondarySubnetId': 'string'}],
'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}}
Response {'LaunchTemplateVersion': {'LaunchTemplateData': {'SecondaryInterfaces': [{'DeleteOnTermination': 'boolean',
'DeviceIndex': 'integer',
'InterfaceType': 'secondary',
'NetworkCardIndex': 'integer',
'PrivateIpAddressCount': 'integer',
'PrivateIpAddresses': [{'PrivateIpAddress': 'string'}],
'SecondarySubnetId': 'string'}],
'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}}}
{'InstanceTypes': {'NetworkInfo': {'Ipv4AddressesPerSecondaryInterface': 'integer',
'MaximumSecondaryNetworkInterfaces': 'integer',
'SecondaryNetworkSupported': 'boolean'}}}
{'Reservations': {'Instances': {'SecondaryInterfaces': [{'Attachment': {'AttachTime': 'timestamp',
'AttachmentId': 'string',
'DeleteOnTermination': 'boolean',
'DeviceIndex': 'integer',
'NetworkCardIndex': 'integer',
'Status': 'attaching '
'| '
'attached '
'| '
'detaching '
'| '
'detached'},
'InterfaceType': 'secondary',
'MacAddress': 'string',
'OwnerId': 'string',
'PrivateIpAddresses': [{'PrivateIpAddress': 'string'}],
'SecondaryInterfaceId': 'string',
'SecondaryNetworkId': 'string',
'SecondarySubnetId': 'string',
'SourceDestCheck': 'boolean',
'Status': 'available '
'| '
'in-use'}]}}}
{'LaunchTemplateVersions': {'LaunchTemplateData': {'SecondaryInterfaces': [{'DeleteOnTermination': 'boolean',
'DeviceIndex': 'integer',
'InterfaceType': 'secondary',
'NetworkCardIndex': 'integer',
'PrivateIpAddressCount': 'integer',
'PrivateIpAddresses': [{'PrivateIpAddress': 'string'}],
'SecondarySubnetId': 'string'}],
'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}}}
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}},
'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}}}
{'Tags': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}
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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'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': {'SecondaryInterfaces': [{'DeleteOnTermination': 'boolean',
'DeviceIndex': 'integer',
'InterfaceType': 'secondary',
'NetworkCardIndex': 'integer',
'PrivateIpAddressCount': 'integer',
'PrivateIpAddresses': [{'PrivateIpAddress': 'string'}],
'SecondarySubnetId': 'string'}],
'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}}
{'PoolTagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}
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 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'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'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'
}
}
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.
{'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}},
'TagSpecifications': {'ResourceType': {'secondary-interface',
'secondary-network',
'secondary-subnet'}}}}
{'SecondaryInterfaces': [{'DeleteOnTermination': 'boolean',
'DeviceIndex': 'integer',
'InterfaceType': 'secondary',
'NetworkCardIndex': 'integer',
'PrivateIpAddressCount': 'integer',
'PrivateIpAddresses': [{'PrivateIpAddress': 'string'}],
'SecondarySubnetId': 'string'}]}
Response {'Instances': {'SecondaryInterfaces': [{'Attachment': {'AttachTime': 'timestamp',
'AttachmentId': 'string',
'DeleteOnTermination': 'boolean',
'DeviceIndex': 'integer',
'NetworkCardIndex': 'integer',
'Status': 'attaching | '
'attached | '
'detaching | '
'detached'},
'InterfaceType': 'secondary',
'MacAddress': 'string',
'OwnerId': 'string',
'PrivateIpAddresses': [{'PrivateIpAddress': 'string'}],
'SecondaryInterfaceId': 'string',
'SecondaryNetworkId': 'string',
'SecondarySubnetId': 'string',
'SourceDestCheck': 'boolean',
'Status': 'available | in-use'}]}}