AWS API Changes

2025/06/09 - Amazon Elastic Compute Cloud - 7 updated api methods

Changes Release to support Elastic VMware Service (Amazon EVS) Subnet and Amazon EVS Network Interface Types.

CreateDefaultSubnet (updated)

Link ¶
Changes (response)

{'Subnet': {'State': {'failed', 'failed-insufficient-capacity'},
            'Type': 'string'}}

Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Create a default subnet in the Amazon VPC User Guide.

See also: AWS API Documentation

Request Syntax

client.create_default_subnet(
    AvailabilityZone='string',
    DryRun=True|False,
    Ipv6Native=True|False
)

type AvailabilityZone:

string

param AvailabilityZone:

[REQUIRED]

The Availability Zone in which to create the default subnet.

type DryRun:

boolean

param DryRun:

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.

type Ipv6Native:

boolean

param Ipv6Native:

Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.

rtype:

dict

returns:

Response Syntax

{
    'Subnet': {
        'AvailabilityZoneId': 'string',
        'EnableLniAtDeviceIndex': 123,
        'MapCustomerOwnedIpOnLaunch': True|False,
        'CustomerOwnedIpv4Pool': 'string',
        'OwnerId': 'string',
        'AssignIpv6AddressOnCreation': True|False,
        'Ipv6CidrBlockAssociationSet': [
            {
                'AssociationId': 'string',
                'Ipv6CidrBlock': 'string',
                'Ipv6CidrBlockState': {
                    'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
                    'StatusMessage': 'string'
                },
                'Ipv6AddressAttribute': 'public'|'private',
                'IpSource': 'amazon'|'byoip'|'none'
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string',
        'OutpostArn': 'string',
        'EnableDns64': True|False,
        'Ipv6Native': True|False,
        'PrivateDnsNameOptionsOnLaunch': {
            'HostnameType': 'ip-name'|'resource-name',
            'EnableResourceNameDnsARecord': True|False,
            'EnableResourceNameDnsAAAARecord': True|False
        },
        'BlockPublicAccessStates': {
            'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
        },
        'Type': 'string',
        'SubnetId': 'string',
        'State': 'pending'|'available'|'unavailable'|'failed'|'failed-insufficient-capacity',
        'VpcId': 'string',
        'CidrBlock': 'string',
        'AvailableIpAddressCount': 123,
        'AvailabilityZone': 'string',
        'DefaultForAz': True|False,
        'MapPublicIpOnLaunch': True|False
    }
}

Response Structure

(dict) --
- Subnet (dict) --
  
  Information about the subnet.
  - AvailabilityZoneId (string) --
    
    The AZ ID of the subnet.
  - EnableLniAtDeviceIndex (integer) --
    
    Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
  - MapCustomerOwnedIpOnLaunch (boolean) --
    
    Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
  - CustomerOwnedIpv4Pool (string) --
    
    The customer-owned IPv4 address pool associated with the subnet.
  - OwnerId (string) --
    
    The ID of the Amazon Web Services account that owns the subnet.
  - AssignIpv6AddressOnCreation (boolean) --
    
    Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
  - Ipv6CidrBlockAssociationSet (list) --
    
    Information about the IPv6 CIDR blocks associated with the subnet.
    - (dict) --
      
      Describes an association between a subnet and an IPv6 CIDR block.
      - AssociationId (string) --
        
        The ID of the association.
      - Ipv6CidrBlock (string) --
        
        The IPv6 CIDR block.
      - Ipv6CidrBlockState (dict) --
        
        The state of the CIDR block.
        
        State (string) --
        
        The state of a CIDR block.
        
        StatusMessage (string) --
        
        A message about the status of the CIDR block, if applicable.
      - Ipv6AddressAttribute (string) --
        
        Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
      - IpSource (string) --
        
        The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
  - Tags (list) --
    
    Any tags assigned to the 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.
  - SubnetArn (string) --
    
    The Amazon Resource Name (ARN) of the subnet.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost.
  - EnableDns64 (boolean) --
    
    Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
  - Ipv6Native (boolean) --
    
    Indicates whether this is an IPv6 only subnet.
  - PrivateDnsNameOptionsOnLaunch (dict) --
    
    The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
    - HostnameType (string) --
      
      The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
    - EnableResourceNameDnsARecord (boolean) --
      
      Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
    - EnableResourceNameDnsAAAARecord (boolean) --
      
      Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
  - BlockPublicAccessStates (dict) --
    
    The state of VPC Block Public Access (BPA).
    - InternetGatewayBlockMode (string) --
      
      The mode of VPC BPA.
      - off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
      - block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
      - block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
  - Type (string) --
    
    Indicates if this is a subnet used with Amazon Elastic VMware Service (EVS). Possible values are Elastic VMware Service or no value. For more information about Amazon EVS, see Amazon Elastic VMware Service API Reference.
  - SubnetId (string) --
    
    The ID of the subnet.
  - State (string) --
    
    The current state of the subnet.
    - failed: The underlying infrastructure to support the subnet failed to provision as expected.
    - failed-insufficient-capacity: The underlying infrastructure to support the subnet failed to provision due to a shortage of EC2 instance capacity.
  - VpcId (string) --
    
    The ID of the VPC the subnet is in.
  - CidrBlock (string) --
    
    The IPv4 CIDR block assigned to the subnet.
  - AvailableIpAddressCount (integer) --
    
    The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
  - AvailabilityZone (string) --
    
    The Availability Zone of the subnet.
  - DefaultForAz (boolean) --
    
    Indicates whether this is the default subnet for the Availability Zone.
  - MapPublicIpOnLaunch (boolean) --
    
    Indicates whether instances launched in this subnet receive a public IPv4 address.
    
    Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

CreateNetworkInterface (updated)

Link ¶
Changes (response)

{'NetworkInterface': {'AssociatedSubnets': ['string']}}

Creates a network interface in the specified subnet.

The number of IP addresses you can assign to a network interface varies by instance type.

For more information about network interfaces, see Elastic network interfaces in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

client.create_network_interface(
    Ipv4Prefixes=[
        {
            'Ipv4Prefix': 'string'
        },
    ],
    Ipv4PrefixCount=123,
    Ipv6Prefixes=[
        {
            'Ipv6Prefix': 'string'
        },
    ],
    Ipv6PrefixCount=123,
    InterfaceType='efa'|'efa-only'|'branch'|'trunk',
    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'|'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-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'|'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'|'mac-modification-task',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string',
    EnablePrimaryIpv6=True|False,
    ConnectionTrackingSpecification={
        'TcpEstablishedTimeout': 123,
        'UdpStreamTimeout': 123,
        'UdpTimeout': 123
    },
    Operator={
        'Principal': 'string'
    },
    SubnetId='string',
    Description='string',
    PrivateIpAddress='string',
    Groups=[
        'string',
    ],
    PrivateIpAddresses=[
        {
            'Primary': True|False,
            'PrivateIpAddress': 'string'
        },
    ],
    SecondaryPrivateIpAddressCount=123,
    Ipv6Addresses=[
        {
            'Ipv6Address': 'string',
            'IsPrimaryIpv6': True|False
        },
    ],
    Ipv6AddressCount=123,
    DryRun=True|False
)

type Ipv4Prefixes:

list

param Ipv4Prefixes:

The IPv4 prefixes assigned to the network interface.

You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

(dict) --

Describes the IPv4 prefix option for a network interface.
- Ipv4Prefix (string) --
  
  The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.

type Ipv4PrefixCount:

integer

param Ipv4PrefixCount:

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

type Ipv6Prefixes:

list

param Ipv6Prefixes:

The IPv6 prefixes assigned to the network interface.

You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

(dict) --

Describes the IPv6 prefix option for a network interface.
- Ipv6Prefix (string) --
  
  The IPv6 prefix.

type Ipv6PrefixCount:

integer

param Ipv6PrefixCount:

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

type InterfaceType:

string

param InterfaceType:

The type of network interface. The default is interface.

If you specify efa-only, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.

The only supported values are interface, efa, efa-only, and trunk.

type TagSpecifications:

list

param TagSpecifications:

The tags to apply to the new network interface.

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

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- 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.

type ClientToken:

string

param ClientToken:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

type EnablePrimaryIpv6:

boolean

param EnablePrimaryIpv6:

If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

type ConnectionTrackingSpecification:

dict

param ConnectionTrackingSpecification:

A connection tracking specification for the network interface.

TcpEstablishedTimeout (integer) --

Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
UdpStreamTimeout (integer) --

Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
UdpTimeout (integer) --

Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

type Operator:

dict

param Operator:

Reserved for internal use.

Principal (string) --

The service provider that manages the resource.

type SubnetId:

string

param SubnetId:

[REQUIRED]

The ID of the subnet to associate with the network interface.

type Description:

string

param Description:

A description for the network interface.

type PrivateIpAddress:

string

param PrivateIpAddress:

The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

type Groups:

list

param Groups:

The IDs of the security groups.

(string) --

type PrivateIpAddresses:

list

param PrivateIpAddresses:

The private IPv4 addresses.

You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

(dict) --

Describes a secondary private IPv4 address for a network interface.
- Primary (boolean) --
  
  Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
- PrivateIpAddress (string) --
  
  The private IPv4 address.

type SecondaryPrivateIpAddressCount:

integer

param SecondaryPrivateIpAddressCount:

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

type Ipv6Addresses:

list

param Ipv6Addresses:

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

(dict) --

Describes an IPv6 address.
- Ipv6Address (string) --
  
  The IPv6 address.
- IsPrimaryIpv6 (boolean) --
  
  Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.

type Ipv6AddressCount:

integer

param Ipv6AddressCount:

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.

You can't specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.

type DryRun:

boolean

param DryRun:

rtype:

dict

returns:

Response Syntax

{
    'NetworkInterface': {
        'Association': {
            'AllocationId': 'string',
            'AssociationId': 'string',
            'IpOwnerId': 'string',
            'PublicDnsName': 'string',
            'PublicIp': 'string',
            'CustomerOwnedIp': 'string',
            'CarrierIp': 'string'
        },
        'Attachment': {
            'AttachTime': datetime(2015, 1, 1),
            'AttachmentId': 'string',
            'DeleteOnTermination': True|False,
            'DeviceIndex': 123,
            'NetworkCardIndex': 123,
            'InstanceId': 'string',
            'InstanceOwnerId': 'string',
            'Status': 'attaching'|'attached'|'detaching'|'detached',
            'EnaSrdSpecification': {
                'EnaSrdEnabled': True|False,
                'EnaSrdUdpSpecification': {
                    'EnaSrdUdpEnabled': True|False
                }
            },
            'EnaQueueCount': 123
        },
        'AvailabilityZone': 'string',
        'ConnectionTrackingConfiguration': {
            'TcpEstablishedTimeout': 123,
            'UdpStreamTimeout': 123,
            'UdpTimeout': 123
        },
        'Description': 'string',
        'Groups': [
            {
                'GroupId': 'string',
                'GroupName': 'string'
            },
        ],
        'InterfaceType': 'interface'|'natGateway'|'efa'|'efa-only'|'trunk'|'load_balancer'|'network_load_balancer'|'vpc_endpoint'|'branch'|'transit_gateway'|'lambda'|'quicksight'|'global_accelerator_managed'|'api_gateway_managed'|'gateway_load_balancer'|'gateway_load_balancer_endpoint'|'iot_rules_managed'|'aws_codestar_connections_managed',
        'Ipv6Addresses': [
            {
                'Ipv6Address': 'string',
                'PublicIpv6DnsName': 'string',
                'IsPrimaryIpv6': True|False
            },
        ],
        'MacAddress': 'string',
        'NetworkInterfaceId': 'string',
        'OutpostArn': 'string',
        'OwnerId': 'string',
        'PrivateDnsName': 'string',
        'PublicDnsName': 'string',
        'PublicIpDnsNameOptions': {
            'DnsHostnameType': 'string',
            'PublicIpv4DnsName': 'string',
            'PublicIpv6DnsName': 'string',
            'PublicDualStackDnsName': 'string'
        },
        'PrivateIpAddress': 'string',
        'PrivateIpAddresses': [
            {
                'Association': {
                    'AllocationId': 'string',
                    'AssociationId': 'string',
                    'IpOwnerId': 'string',
                    'PublicDnsName': 'string',
                    'PublicIp': 'string',
                    'CustomerOwnedIp': 'string',
                    'CarrierIp': 'string'
                },
                'Primary': True|False,
                'PrivateDnsName': 'string',
                'PrivateIpAddress': 'string'
            },
        ],
        'Ipv4Prefixes': [
            {
                'Ipv4Prefix': 'string'
            },
        ],
        'Ipv6Prefixes': [
            {
                'Ipv6Prefix': 'string'
            },
        ],
        'RequesterId': 'string',
        'RequesterManaged': True|False,
        'SourceDestCheck': True|False,
        'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
        'SubnetId': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'VpcId': 'string',
        'DenyAllIgwTraffic': True|False,
        'Ipv6Native': True|False,
        'Ipv6Address': 'string',
        'Operator': {
            'Managed': True|False,
            'Principal': 'string'
        },
        'AssociatedSubnets': [
            'string',
        ]
    },
    'ClientToken': 'string'
}

Response Structure

(dict) --
- NetworkInterface (dict) --
  
  Information about the network interface.
  - Association (dict) --
    
    The association information for an Elastic IP address (IPv4) associated with the network interface.
    - AllocationId (string) --
      
      The allocation ID.
    - AssociationId (string) --
      
      The association ID.
    - IpOwnerId (string) --
      
      The ID of the Elastic IP address owner.
    - PublicDnsName (string) --
      
      The public DNS name.
    - PublicIp (string) --
      
      The address of the Elastic IP address bound to the network interface.
    - CustomerOwnedIp (string) --
      
      The customer-owned IP address associated with the network interface.
    - CarrierIp (string) --
      
      The carrier IP address associated with the network interface.
      
      This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
  - Attachment (dict) --
    
    The network interface attachment.
    - AttachTime (datetime) --
      
      The timestamp indicating when the attachment initiated.
    - AttachmentId (string) --
      
      The ID of the network interface attachment.
    - DeleteOnTermination (boolean) --
      
      Indicates whether the network interface is deleted when the instance is terminated.
    - DeviceIndex (integer) --
      
      The device index of the network interface attachment on the instance.
    - NetworkCardIndex (integer) --
      
      The index of the network card.
    - InstanceId (string) --
      
      The ID of the instance.
    - InstanceOwnerId (string) --
      
      The Amazon Web Services account ID of the owner of the instance.
    - Status (string) --
      
      The attachment state.
    - EnaSrdSpecification (dict) --
      
      Configures ENA Express for the network interface that this action attaches to the instance.
      - EnaSrdEnabled (boolean) --
        
        Indicates whether ENA Express is enabled for the network interface.
      - EnaSrdUdpSpecification (dict) --
        
        Configures ENA Express for UDP network traffic.
        
        EnaSrdUdpEnabled (boolean) --
        
        Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
    - EnaQueueCount (integer) --
      
      The number of ENA queues created with the instance.
  - AvailabilityZone (string) --
    
    The Availability Zone.
  - ConnectionTrackingConfiguration (dict) --
    
    A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
    - TcpEstablishedTimeout (integer) --
      
      Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
    - UdpStreamTimeout (integer) --
      
      Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
    - UdpTimeout (integer) --
      
      Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
  - Description (string) --
    
    A description.
  - Groups (list) --
    
    Any security groups for the network interface.
    - (dict) --
      
      Describes a security group.
      - GroupId (string) --
        
        The ID of the security group.
      - GroupName (string) --
        
        The name of the security group.
  - InterfaceType (string) --
    
    The type of network interface.
  - Ipv6Addresses (list) --
    
    The IPv6 addresses associated with the network interface.
    - (dict) --
      
      Describes an IPv6 address associated with a network interface.
      - Ipv6Address (string) --
        
        The IPv6 address.
      - PublicIpv6DnsName (string) --
        
        An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
      - IsPrimaryIpv6 (boolean) --
        
        Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
  - MacAddress (string) --
    
    The MAC address.
  - NetworkInterfaceId (string) --
    
    The ID of the network interface.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost.
  - OwnerId (string) --
    
    The Amazon Web Services account ID of the owner of the network interface.
  - PrivateDnsName (string) --
    
    The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
  - PublicDnsName (string) --
    
    A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
  - PublicIpDnsNameOptions (dict) --
    
    Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
    - DnsHostnameType (string) --
      
      The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
    - PublicIpv4DnsName (string) --
      
      An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
    - PublicIpv6DnsName (string) --
      
      An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.
    - PublicDualStackDnsName (string) --
      
      A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
  - PrivateIpAddress (string) --
    
    The IPv4 address of the network interface within the subnet.
  - PrivateIpAddresses (list) --
    
    The private IPv4 addresses associated with the network interface.
    - (dict) --
      
      Describes the private IPv4 address of a network interface.
      - Association (dict) --
        
        The association information for an Elastic IP address (IPv4) associated with the network interface.
        
        AllocationId (string) --
        
        The allocation ID.
        
        AssociationId (string) --
        
        The association ID.
        
        IpOwnerId (string) --
        
        The ID of the Elastic IP address owner.
        
        PublicDnsName (string) --
        
        The public DNS name.
        
        PublicIp (string) --
        
        The address of the Elastic IP address bound to the network interface.
        
        CustomerOwnedIp (string) --
        
        The customer-owned IP address associated with the network interface.
        
        CarrierIp (string) --
        
        The carrier IP address associated with the network interface.
        
        This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
      - Primary (boolean) --
        
        Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
      - PrivateDnsName (string) --
        
        The private DNS name.
      - PrivateIpAddress (string) --
        
        The private IPv4 address.
  - Ipv4Prefixes (list) --
    
    The IPv4 prefixes that are assigned to the network interface.
    - (dict) --
      
      Describes an IPv4 prefix.
      - Ipv4Prefix (string) --
        
        The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
  - Ipv6Prefixes (list) --
    
    The IPv6 prefixes that are assigned to the network interface.
    - (dict) --
      
      Describes the IPv6 prefix.
      - Ipv6Prefix (string) --
        
        The IPv6 prefix.
  - RequesterId (string) --
    
    The alias or Amazon Web Services account ID of the principal or service that created the network interface.
  - RequesterManaged (boolean) --
    
    Indicates whether the network interface is being managed by Amazon Web Services.
  - SourceDestCheck (boolean) --
    
    Indicates whether source/destination checking is enabled.
  - Status (string) --
    
    The status of the network interface.
  - SubnetId (string) --
    
    The ID of the subnet.
  - TagSet (list) --
    
    Any tags assigned to the network 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.
  - VpcId (string) --
    
    The ID of the VPC.
  - DenyAllIgwTraffic (boolean) --
    
    Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.
  - Ipv6Native (boolean) --
    
    Indicates whether this is an IPv6 only network interface.
  - Ipv6Address (string) --
    
    The IPv6 globally unique address associated with the network interface.
  - Operator (dict) --
    
    The service provider that manages the network interface.
    - Managed (boolean) --
      
      If true, the resource is managed by a service provider.
    - Principal (string) --
      
      If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
  - AssociatedSubnets (list) --
    
    The subnets associated with this network interface.
    - (string) --
- ClientToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

CreateSubnet (updated)

Link ¶
Changes (response)

{'Subnet': {'State': {'failed', 'failed-insufficient-capacity'},
            'Type': 'string'}}

Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.

A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block.

The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use.

If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information, see Subnets in the Amazon VPC User Guide.

See also: AWS API Documentation

Request Syntax

client.create_subnet(
    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'|'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-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'|'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'|'mac-modification-task',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    AvailabilityZone='string',
    AvailabilityZoneId='string',
    CidrBlock='string',
    Ipv6CidrBlock='string',
    OutpostArn='string',
    VpcId='string',
    Ipv6Native=True|False,
    Ipv4IpamPoolId='string',
    Ipv4NetmaskLength=123,
    Ipv6IpamPoolId='string',
    Ipv6NetmaskLength=123,
    DryRun=True|False
)

type TagSpecifications:

list

param TagSpecifications:

The tags to assign to the 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.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- 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.

type AvailabilityZone:

string

param AvailabilityZone:

The Availability Zone or Local Zone for the subnet.

Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Local Zones.

To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.

type AvailabilityZoneId:

string

param AvailabilityZoneId:

The AZ ID or the Local Zone ID of the subnet.

type CidrBlock:

string

param CidrBlock:

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

This parameter is not supported for an IPv6 only subnet.

type Ipv6CidrBlock:

string

param Ipv6CidrBlock:

The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet.

type OutpostArn:

string

param OutpostArn:

The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.

type VpcId:

string

param VpcId:

[REQUIRED]

The ID of the VPC.

type Ipv6Native:

boolean

param Ipv6Native:

Indicates whether to create an IPv6 only subnet.

type Ipv4IpamPoolId:

string

param Ipv4IpamPoolId:

An IPv4 IPAM pool ID for the subnet.

type Ipv4NetmaskLength:

integer

param Ipv4NetmaskLength:

An IPv4 netmask length for the subnet.

type Ipv6IpamPoolId:

string

param Ipv6IpamPoolId:

An IPv6 IPAM pool ID for the subnet.

type Ipv6NetmaskLength:

integer

param Ipv6NetmaskLength:

An IPv6 netmask length for the subnet.

type DryRun:

boolean

param DryRun:

rtype:

dict

returns:

Response Syntax

{
    'Subnet': {
        'AvailabilityZoneId': 'string',
        'EnableLniAtDeviceIndex': 123,
        'MapCustomerOwnedIpOnLaunch': True|False,
        'CustomerOwnedIpv4Pool': 'string',
        'OwnerId': 'string',
        'AssignIpv6AddressOnCreation': True|False,
        'Ipv6CidrBlockAssociationSet': [
            {
                'AssociationId': 'string',
                'Ipv6CidrBlock': 'string',
                'Ipv6CidrBlockState': {
                    'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
                    'StatusMessage': 'string'
                },
                'Ipv6AddressAttribute': 'public'|'private',
                'IpSource': 'amazon'|'byoip'|'none'
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string',
        'OutpostArn': 'string',
        'EnableDns64': True|False,
        'Ipv6Native': True|False,
        'PrivateDnsNameOptionsOnLaunch': {
            'HostnameType': 'ip-name'|'resource-name',
            'EnableResourceNameDnsARecord': True|False,
            'EnableResourceNameDnsAAAARecord': True|False
        },
        'BlockPublicAccessStates': {
            'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
        },
        'Type': 'string',
        'SubnetId': 'string',
        'State': 'pending'|'available'|'unavailable'|'failed'|'failed-insufficient-capacity',
        'VpcId': 'string',
        'CidrBlock': 'string',
        'AvailableIpAddressCount': 123,
        'AvailabilityZone': 'string',
        'DefaultForAz': True|False,
        'MapPublicIpOnLaunch': True|False
    }
}

Response Structure

(dict) --
- Subnet (dict) --
  
  Information about the subnet.
  - AvailabilityZoneId (string) --
    
    The AZ ID of the subnet.
  - EnableLniAtDeviceIndex (integer) --
    
    Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
  - MapCustomerOwnedIpOnLaunch (boolean) --
    
    Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
  - CustomerOwnedIpv4Pool (string) --
    
    The customer-owned IPv4 address pool associated with the subnet.
  - OwnerId (string) --
    
    The ID of the Amazon Web Services account that owns the subnet.
  - AssignIpv6AddressOnCreation (boolean) --
    
    Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
  - Ipv6CidrBlockAssociationSet (list) --
    
    Information about the IPv6 CIDR blocks associated with the subnet.
    - (dict) --
      
      Describes an association between a subnet and an IPv6 CIDR block.
      - AssociationId (string) --
        
        The ID of the association.
      - Ipv6CidrBlock (string) --
        
        The IPv6 CIDR block.
      - Ipv6CidrBlockState (dict) --
        
        The state of the CIDR block.
        
        State (string) --
        
        The state of a CIDR block.
        
        StatusMessage (string) --
        
        A message about the status of the CIDR block, if applicable.
      - Ipv6AddressAttribute (string) --
        
        Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
      - IpSource (string) --
        
        The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
  - Tags (list) --
    
    Any tags assigned to the 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.
  - SubnetArn (string) --
    
    The Amazon Resource Name (ARN) of the subnet.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost.
  - EnableDns64 (boolean) --
    
    Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
  - Ipv6Native (boolean) --
    
    Indicates whether this is an IPv6 only subnet.
  - PrivateDnsNameOptionsOnLaunch (dict) --
    
    The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
    - HostnameType (string) --
      
      The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
    - EnableResourceNameDnsARecord (boolean) --
      
      Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
    - EnableResourceNameDnsAAAARecord (boolean) --
      
      Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
  - BlockPublicAccessStates (dict) --
    
    The state of VPC Block Public Access (BPA).
    - InternetGatewayBlockMode (string) --
      
      The mode of VPC BPA.
      - off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
      - block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
      - block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
  - Type (string) --
    
    Indicates if this is a subnet used with Amazon Elastic VMware Service (EVS). Possible values are Elastic VMware Service or no value. For more information about Amazon EVS, see Amazon Elastic VMware Service API Reference.
  - SubnetId (string) --
    
    The ID of the subnet.
  - State (string) --
    
    The current state of the subnet.
    - failed: The underlying infrastructure to support the subnet failed to provision as expected.
    - failed-insufficient-capacity: The underlying infrastructure to support the subnet failed to provision due to a shortage of EC2 instance capacity.
  - VpcId (string) --
    
    The ID of the VPC the subnet is in.
  - CidrBlock (string) --
    
    The IPv4 CIDR block assigned to the subnet.
  - AvailableIpAddressCount (integer) --
    
    The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
  - AvailabilityZone (string) --
    
    The Availability Zone of the subnet.
  - DefaultForAz (boolean) --
    
    Indicates whether this is the default subnet for the Availability Zone.
  - MapPublicIpOnLaunch (boolean) --
    
    Indicates whether instances launched in this subnet receive a public IPv4 address.
    
    Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

DescribeAddresses (updated)

Link ¶
Changes (response)

{'Addresses': {'SubnetId': 'string'}}

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

See also: AWS API Documentation

Request Syntax

client.describe_addresses(
    PublicIps=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    AllocationIds=[
        'string',
    ]
)

type PublicIps:

list

param PublicIps:

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

(string) --

type DryRun:

boolean

param DryRun:

type Filters:

list

param Filters:

One or more filters. Filter names and values are case-sensitive.

allocation-id - The allocation ID for the address.
association-id - The association ID for the address.
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
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) --

type AllocationIds:

list

param AllocationIds:

Information about the allocation IDs.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'Addresses': [
        {
            'AllocationId': 'string',
            'AssociationId': 'string',
            'Domain': 'vpc'|'standard',
            'NetworkInterfaceId': 'string',
            'NetworkInterfaceOwnerId': 'string',
            'PrivateIpAddress': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'PublicIpv4Pool': 'string',
            'NetworkBorderGroup': 'string',
            'CustomerOwnedIp': 'string',
            'CustomerOwnedIpv4Pool': 'string',
            'CarrierIp': 'string',
            'SubnetId': 'string',
            'ServiceManaged': 'alb'|'nlb'|'rnat',
            'InstanceId': 'string',
            'PublicIp': 'string'
        },
    ]
}

Response Structure

(dict) --
- Addresses (list) --
  
  Information about the Elastic IP addresses.
  - (dict) --
    
    Describes an Elastic IP address, or a carrier IP address.
    - AllocationId (string) --
      
      The ID representing the allocation of the address.
    - AssociationId (string) --
      
      The ID representing the association of the address with an instance.
    - Domain (string) --
      
      The network ( vpc).
    - NetworkInterfaceId (string) --
      
      The ID of the network interface.
    - NetworkInterfaceOwnerId (string) --
      
      The ID of the Amazon Web Services account that owns the network interface.
    - PrivateIpAddress (string) --
      
      The private IP address associated with the Elastic IP address.
    - Tags (list) --
      
      Any tags assigned to the Elastic IP address.
      - (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.
    - PublicIpv4Pool (string) --
      
      The ID of an address pool.
    - NetworkBorderGroup (string) --
      
      The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
    - CustomerOwnedIp (string) --
      
      The customer-owned IP address.
    - CustomerOwnedIpv4Pool (string) --
      
      The ID of the customer-owned address pool.
    - CarrierIp (string) --
      
      The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
    - SubnetId (string) --
      
      The ID of the subnet where the IP address is allocated.
    - ServiceManaged (string) --
      
      The service that manages the elastic IP address.
      
      Note
      
      The only option supported today is alb.
    - InstanceId (string) --
      
      The ID of the instance that the address is associated with (if any).
    - PublicIp (string) --
      
      The Elastic IP address.

DescribeNetworkInterfaces (updated)

Link ¶
Changes (response)

{'NetworkInterfaces': {'AssociatedSubnets': ['string']}}

Describes the specified network interfaces or all your network interfaces.

If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, subnet-id, or vpc-id.

See also: AWS API Documentation

Request Syntax

client.describe_network_interfaces(
    NextToken='string',
    MaxResults=123,
    DryRun=True|False,
    NetworkInterfaceIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

type NextToken:

string

param NextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.

type DryRun:

boolean

param DryRun:

type NetworkInterfaceIds:

list

param NetworkInterfaceIds:

The network interface IDs.

Default: Describes all your network interfaces.

(string) --

type Filters:

list

param Filters:

One or more filters.

association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.attachment-id - The ID of the interface attachment.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment ( attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface ( api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efa-only | efs | evs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
operator.managed - A Boolean that indicates whether this is a managed network interface.
operator.principal - The principal that manages the network interface. Only valid for managed network interfaces, where managed is true.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-dns-name - The private DNS name of the network interface (IPv4).
private-ip-address - The private IPv4 address or addresses of the network interface.
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
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.
vpc-id - The ID of the VPC for the network interface.

(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) --

rtype:

dict

returns:

Response Syntax

{
    'NetworkInterfaces': [
        {
            'Association': {
                'AllocationId': 'string',
                'AssociationId': 'string',
                'IpOwnerId': 'string',
                'PublicDnsName': 'string',
                'PublicIp': 'string',
                'CustomerOwnedIp': 'string',
                'CarrierIp': 'string'
            },
            'Attachment': {
                'AttachTime': datetime(2015, 1, 1),
                'AttachmentId': 'string',
                'DeleteOnTermination': True|False,
                'DeviceIndex': 123,
                'NetworkCardIndex': 123,
                'InstanceId': 'string',
                'InstanceOwnerId': 'string',
                'Status': 'attaching'|'attached'|'detaching'|'detached',
                'EnaSrdSpecification': {
                    'EnaSrdEnabled': True|False,
                    'EnaSrdUdpSpecification': {
                        'EnaSrdUdpEnabled': True|False
                    }
                },
                'EnaQueueCount': 123
            },
            'AvailabilityZone': 'string',
            'ConnectionTrackingConfiguration': {
                'TcpEstablishedTimeout': 123,
                'UdpStreamTimeout': 123,
                'UdpTimeout': 123
            },
            'Description': 'string',
            'Groups': [
                {
                    'GroupId': 'string',
                    'GroupName': 'string'
                },
            ],
            'InterfaceType': 'interface'|'natGateway'|'efa'|'efa-only'|'trunk'|'load_balancer'|'network_load_balancer'|'vpc_endpoint'|'branch'|'transit_gateway'|'lambda'|'quicksight'|'global_accelerator_managed'|'api_gateway_managed'|'gateway_load_balancer'|'gateway_load_balancer_endpoint'|'iot_rules_managed'|'aws_codestar_connections_managed',
            'Ipv6Addresses': [
                {
                    'Ipv6Address': 'string',
                    'PublicIpv6DnsName': 'string',
                    'IsPrimaryIpv6': True|False
                },
            ],
            'MacAddress': 'string',
            'NetworkInterfaceId': 'string',
            'OutpostArn': 'string',
            'OwnerId': 'string',
            'PrivateDnsName': 'string',
            'PublicDnsName': 'string',
            'PublicIpDnsNameOptions': {
                'DnsHostnameType': 'string',
                'PublicIpv4DnsName': 'string',
                'PublicIpv6DnsName': 'string',
                'PublicDualStackDnsName': 'string'
            },
            'PrivateIpAddress': 'string',
            'PrivateIpAddresses': [
                {
                    'Association': {
                        'AllocationId': 'string',
                        'AssociationId': 'string',
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'CustomerOwnedIp': 'string',
                        'CarrierIp': 'string'
                    },
                    'Primary': True|False,
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string'
                },
            ],
            'Ipv4Prefixes': [
                {
                    'Ipv4Prefix': 'string'
                },
            ],
            'Ipv6Prefixes': [
                {
                    'Ipv6Prefix': 'string'
                },
            ],
            'RequesterId': 'string',
            'RequesterManaged': True|False,
            'SourceDestCheck': True|False,
            'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
            'SubnetId': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcId': 'string',
            'DenyAllIgwTraffic': True|False,
            'Ipv6Native': True|False,
            'Ipv6Address': 'string',
            'Operator': {
                'Managed': True|False,
                'Principal': 'string'
            },
            'AssociatedSubnets': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NetworkInterfaces (list) --
  
  Information about the network interfaces.
  - (dict) --
    
    Describes a network interface.
    - Association (dict) --
      
      The association information for an Elastic IP address (IPv4) associated with the network interface.
      - AllocationId (string) --
        
        The allocation ID.
      - AssociationId (string) --
        
        The association ID.
      - IpOwnerId (string) --
        
        The ID of the Elastic IP address owner.
      - PublicDnsName (string) --
        
        The public DNS name.
      - PublicIp (string) --
        
        The address of the Elastic IP address bound to the network interface.
      - CustomerOwnedIp (string) --
        
        The customer-owned IP address associated with the network interface.
      - CarrierIp (string) --
        
        The carrier IP address associated with the network interface.
        
        This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
    - Attachment (dict) --
      
      The network interface attachment.
      - AttachTime (datetime) --
        
        The timestamp indicating when the attachment initiated.
      - AttachmentId (string) --
        
        The ID of the network interface attachment.
      - DeleteOnTermination (boolean) --
        
        Indicates whether the network interface is deleted when the instance is terminated.
      - DeviceIndex (integer) --
        
        The device index of the network interface attachment on the instance.
      - NetworkCardIndex (integer) --
        
        The index of the network card.
      - InstanceId (string) --
        
        The ID of the instance.
      - InstanceOwnerId (string) --
        
        The Amazon Web Services account ID of the owner of the instance.
      - Status (string) --
        
        The attachment state.
      - EnaSrdSpecification (dict) --
        
        Configures ENA Express for the network interface that this action attaches to the instance.
        
        EnaSrdEnabled (boolean) --
        
        Indicates whether ENA Express is enabled for the network interface.
        
        EnaSrdUdpSpecification (dict) --
        
        Configures ENA Express for UDP network traffic.
        
        EnaSrdUdpEnabled (boolean) --
        
        Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
      - EnaQueueCount (integer) --
        
        The number of ENA queues created with the instance.
    - AvailabilityZone (string) --
      
      The Availability Zone.
    - ConnectionTrackingConfiguration (dict) --
      
      A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
      - TcpEstablishedTimeout (integer) --
        
        Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
      - UdpStreamTimeout (integer) --
        
        Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
      - UdpTimeout (integer) --
        
        Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
    - Description (string) --
      
      A description.
    - Groups (list) --
      
      Any security groups for the network interface.
      - (dict) --
        
        Describes a security group.
        
        GroupId (string) --
        
        The ID of the security group.
        
        GroupName (string) --
        
        The name of the security group.
    - InterfaceType (string) --
      
      The type of network interface.
    - Ipv6Addresses (list) --
      
      The IPv6 addresses associated with the network interface.
      - (dict) --
        
        Describes an IPv6 address associated with a network interface.
        
        Ipv6Address (string) --
        
        The IPv6 address.
        
        PublicIpv6DnsName (string) --
        
        An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
        
        IsPrimaryIpv6 (boolean) --
        
        Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
    - MacAddress (string) --
      
      The MAC address.
    - NetworkInterfaceId (string) --
      
      The ID of the network interface.
    - OutpostArn (string) --
      
      The Amazon Resource Name (ARN) of the Outpost.
    - OwnerId (string) --
      
      The Amazon Web Services account ID of the owner of the network interface.
    - PrivateDnsName (string) --
      
      The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
    - PublicDnsName (string) --
      
      A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
    - PublicIpDnsNameOptions (dict) --
      
      Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
      - DnsHostnameType (string) --
        
        The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
      - PublicIpv4DnsName (string) --
        
        An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
      - PublicIpv6DnsName (string) --
        
        An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.
      - PublicDualStackDnsName (string) --
        
        A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
    - PrivateIpAddress (string) --
      
      The IPv4 address of the network interface within the subnet.
    - PrivateIpAddresses (list) --
      
      The private IPv4 addresses associated with the network interface.
      - (dict) --
        
        Describes the private IPv4 address of a network interface.
        
        Association (dict) --
        
        The association information for an Elastic IP address (IPv4) associated with the network interface.
        
        AllocationId (string) --
        
        The allocation ID.
        
        AssociationId (string) --
        
        The association ID.
        
        IpOwnerId (string) --
        
        The ID of the Elastic IP address owner.
        
        PublicDnsName (string) --
        
        The public DNS name.
        
        PublicIp (string) --
        
        The address of the Elastic IP address bound to the network interface.
        
        CustomerOwnedIp (string) --
        
        The customer-owned IP address associated with the network interface.
        
        CarrierIp (string) --
        
        The carrier IP address associated with the network interface.
        
        This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
        
        Primary (boolean) --
        
        Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
        
        PrivateDnsName (string) --
        
        The private DNS name.
        
        PrivateIpAddress (string) --
        
        The private IPv4 address.
    - Ipv4Prefixes (list) --
      
      The IPv4 prefixes that are assigned to the network interface.
      - (dict) --
        
        Describes an IPv4 prefix.
        
        Ipv4Prefix (string) --
        
        The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
    - Ipv6Prefixes (list) --
      
      The IPv6 prefixes that are assigned to the network interface.
      - (dict) --
        
        Describes the IPv6 prefix.
        
        Ipv6Prefix (string) --
        
        The IPv6 prefix.
    - RequesterId (string) --
      
      The alias or Amazon Web Services account ID of the principal or service that created the network interface.
    - RequesterManaged (boolean) --
      
      Indicates whether the network interface is being managed by Amazon Web Services.
    - SourceDestCheck (boolean) --
      
      Indicates whether source/destination checking is enabled.
    - Status (string) --
      
      The status of the network interface.
    - SubnetId (string) --
      
      The ID of the subnet.
    - TagSet (list) --
      
      Any tags assigned to the network 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.
    - VpcId (string) --
      
      The ID of the VPC.
    - DenyAllIgwTraffic (boolean) --
      
      Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.
    - Ipv6Native (boolean) --
      
      Indicates whether this is an IPv6 only network interface.
    - Ipv6Address (string) --
      
      The IPv6 globally unique address associated with the network interface.
    - Operator (dict) --
      
      The service provider that manages the network interface.
      - Managed (boolean) --
        
        If true, the resource is managed by a service provider.
      - Principal (string) --
        
        If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
    - AssociatedSubnets (list) --
      
      The subnets associated with this network interface.
      - (string) --
- 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.

DescribeSubnets (updated)

Link ¶
Changes (response)

{'Subnets': {'State': {'failed', 'failed-insufficient-capacity'},
             'Type': 'string'}}

Describes your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria.

For more information, see Subnets in the Amazon VPC User Guide.

See also: AWS API Documentation

Request Syntax

client.describe_subnets(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SubnetIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    DryRun=True|False
)

type Filters:

list

param Filters:

The filters.

availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.
default-for-az - Indicates whether this is the default subnet for the Availability Zone ( true | false). You can also use defaultForAz as the filter name.
enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
ipv6-native - Indicates whether this is an IPv6 only subnet ( true | false).
map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the subnet.
private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).
private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
state - The state of the subnet ( pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag - 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.
vpc-id - The ID of the VPC for the subnet.

(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) --

type SubnetIds:

list

param SubnetIds:

The IDs of the subnets.

Default: Describes all your subnets.

(string) --

type NextToken:

string

param NextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

type DryRun:

boolean

param DryRun:

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Subnets': [
        {
            'AvailabilityZoneId': 'string',
            'EnableLniAtDeviceIndex': 123,
            'MapCustomerOwnedIpOnLaunch': True|False,
            'CustomerOwnedIpv4Pool': 'string',
            'OwnerId': 'string',
            'AssignIpv6AddressOnCreation': True|False,
            'Ipv6CidrBlockAssociationSet': [
                {
                    'AssociationId': 'string',
                    'Ipv6CidrBlock': 'string',
                    'Ipv6CidrBlockState': {
                        'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
                        'StatusMessage': 'string'
                    },
                    'Ipv6AddressAttribute': 'public'|'private',
                    'IpSource': 'amazon'|'byoip'|'none'
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SubnetArn': 'string',
            'OutpostArn': 'string',
            'EnableDns64': True|False,
            'Ipv6Native': True|False,
            'PrivateDnsNameOptionsOnLaunch': {
                'HostnameType': 'ip-name'|'resource-name',
                'EnableResourceNameDnsARecord': True|False,
                'EnableResourceNameDnsAAAARecord': True|False
            },
            'BlockPublicAccessStates': {
                'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
            },
            'Type': 'string',
            'SubnetId': 'string',
            'State': 'pending'|'available'|'unavailable'|'failed'|'failed-insufficient-capacity',
            'VpcId': 'string',
            'CidrBlock': 'string',
            'AvailableIpAddressCount': 123,
            'AvailabilityZone': 'string',
            'DefaultForAz': True|False,
            'MapPublicIpOnLaunch': True|False
        },
    ]
}

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.
- Subnets (list) --
  
  Information about the subnets.
  - (dict) --
    
    Describes a subnet.
    - AvailabilityZoneId (string) --
      
      The AZ ID of the subnet.
    - EnableLniAtDeviceIndex (integer) --
      
      Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
    - MapCustomerOwnedIpOnLaunch (boolean) --
      
      Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
    - CustomerOwnedIpv4Pool (string) --
      
      The customer-owned IPv4 address pool associated with the subnet.
    - OwnerId (string) --
      
      The ID of the Amazon Web Services account that owns the subnet.
    - AssignIpv6AddressOnCreation (boolean) --
      
      Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
    - Ipv6CidrBlockAssociationSet (list) --
      
      Information about the IPv6 CIDR blocks associated with the subnet.
      - (dict) --
        
        Describes an association between a subnet and an IPv6 CIDR block.
        
        AssociationId (string) --
        
        The ID of the association.
        
        Ipv6CidrBlock (string) --
        
        The IPv6 CIDR block.
        
        Ipv6CidrBlockState (dict) --
        
        The state of the CIDR block.
        
        State (string) --
        
        The state of a CIDR block.
        
        StatusMessage (string) --
        
        A message about the status of the CIDR block, if applicable.
        
        Ipv6AddressAttribute (string) --
        
        Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
        
        IpSource (string) --
        
        The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
    - Tags (list) --
      
      Any tags assigned to the 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.
    - SubnetArn (string) --
      
      The Amazon Resource Name (ARN) of the subnet.
    - OutpostArn (string) --
      
      The Amazon Resource Name (ARN) of the Outpost.
    - EnableDns64 (boolean) --
      
      Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
    - Ipv6Native (boolean) --
      
      Indicates whether this is an IPv6 only subnet.
    - PrivateDnsNameOptionsOnLaunch (dict) --
      
      The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
      - HostnameType (string) --
        
        The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
      - EnableResourceNameDnsARecord (boolean) --
        
        Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
      - EnableResourceNameDnsAAAARecord (boolean) --
        
        Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
    - BlockPublicAccessStates (dict) --
      
      The state of VPC Block Public Access (BPA).
      - InternetGatewayBlockMode (string) --
        
        The mode of VPC BPA.
        
        off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
        
        block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
        
        block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
    - Type (string) --
      
      Indicates if this is a subnet used with Amazon Elastic VMware Service (EVS). Possible values are Elastic VMware Service or no value. For more information about Amazon EVS, see Amazon Elastic VMware Service API Reference.
    - SubnetId (string) --
      
      The ID of the subnet.
    - State (string) --
      
      The current state of the subnet.
      - failed: The underlying infrastructure to support the subnet failed to provision as expected.
      - failed-insufficient-capacity: The underlying infrastructure to support the subnet failed to provision due to a shortage of EC2 instance capacity.
    - VpcId (string) --
      
      The ID of the VPC the subnet is in.
    - CidrBlock (string) --
      
      The IPv4 CIDR block assigned to the subnet.
    - AvailableIpAddressCount (integer) --
      
      The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
    - AvailabilityZone (string) --
      
      The Availability Zone of the subnet.
    - DefaultForAz (boolean) --
      
      Indicates whether this is the default subnet for the Availability Zone.
    - MapPublicIpOnLaunch (boolean) --
      
      Indicates whether instances launched in this subnet receive a public IPv4 address.
      
      Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

ModifyNetworkInterfaceAttribute (updated)

Link ¶
Changes (request)

{'AssociatedSubnetIds': ['string']}

Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.

See also: AWS API Documentation

Request Syntax

client.modify_network_interface_attribute(
    EnaSrdSpecification={
        'EnaSrdEnabled': True|False,
        'EnaSrdUdpSpecification': {
            'EnaSrdUdpEnabled': True|False
        }
    },
    EnablePrimaryIpv6=True|False,
    ConnectionTrackingSpecification={
        'TcpEstablishedTimeout': 123,
        'UdpStreamTimeout': 123,
        'UdpTimeout': 123
    },
    AssociatePublicIpAddress=True|False,
    AssociatedSubnetIds=[
        'string',
    ],
    DryRun=True|False,
    NetworkInterfaceId='string',
    Description={
        'Value': 'string'
    },
    SourceDestCheck={
        'Value': True|False
    },
    Groups=[
        'string',
    ],
    Attachment={
        'DefaultEnaQueueCount': True|False,
        'EnaQueueCount': 123,
        'AttachmentId': 'string',
        'DeleteOnTermination': True|False
    }
)

type EnaSrdSpecification:

dict

param EnaSrdSpecification:

Updates the ENA Express configuration for the network interface that’s attached to the instance.

EnaSrdEnabled (boolean) --

Indicates whether ENA Express is enabled for the network interface.
EnaSrdUdpSpecification (dict) --

Configures ENA Express for UDP network traffic.
- EnaSrdUdpEnabled (boolean) --
  
  Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.

type EnablePrimaryIpv6:

boolean

param EnablePrimaryIpv6:

If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

type ConnectionTrackingSpecification:

dict

param ConnectionTrackingSpecification:

A connection tracking specification.

TcpEstablishedTimeout (integer) --

Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
UdpStreamTimeout (integer) --

Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
UdpTimeout (integer) --

Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

type AssociatePublicIpAddress:

boolean

param AssociatePublicIpAddress:

Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).

type AssociatedSubnetIds:

list

param AssociatedSubnetIds:

A list of subnet IDs to associate with the network interface.

(string) --

type DryRun:

boolean

param DryRun:

type NetworkInterfaceId:

string

param NetworkInterfaceId:

[REQUIRED]

The ID of the network interface.

type Description:

dict

param Description:

A description for the network interface.

Value (string) --

The attribute value. The value is case-sensitive.

type SourceDestCheck:

dict

param SourceDestCheck:

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Value (boolean) --

The attribute value. The valid values are true or false.

type Groups:

list

param Groups:

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

(string) --

type Attachment:

dict

param Attachment:

Information about the interface attachment. If modifying the delete on termination attribute, you must specify the ID of the interface attachment.

DefaultEnaQueueCount (boolean) --

The default number of the ENA queues.
EnaQueueCount (integer) --

The number of ENA queues to be created with the instance.
AttachmentId (string) --

The ID of the network interface attachment.
DeleteOnTermination (boolean) --

Indicates whether the network interface is deleted when the instance is terminated.

returns:

None