2020/08/13 - Amazon Elastic Compute Cloud - 3 updated api methods
Changes Added MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool to ModifySubnetAttribute to allow CoIP auto assign. Fields are returned in DescribeSubnets and DescribeNetworkInterfaces responses.
{'NetworkInterface': {'Association': {'CustomerOwnedIp': 'string'},
'PrivateIpAddresses': {'Association': {'CustomerOwnedIp': 'string'}}}}
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
client.create_network_interface(
Description='string',
DryRun=True|False,
Groups=[
'string',
],
Ipv6AddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string'
},
],
PrivateIpAddress='string',
PrivateIpAddresses=[
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
SecondaryPrivateIpAddressCount=123,
InterfaceType='efa',
SubnetId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
A description for the network interface.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
list
The IDs of one or more security groups.
(string) --
integer
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 use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true , you can specify 0 to override this setting.
list
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
string
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).
list
One or more private IPv4 addresses.
(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 addresses.
integer
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 .
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .
string
Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
string
[REQUIRED]
The ID of the subnet to associate with the network interface.
list
The tags to apply to the new network interface.
(dict) --
The tags to apply to a resource when the resource is being created.
ResourceType (string) --
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
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 255 Unicode characters.
dict
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,
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'Status': 'attaching'|'attached'|'detaching'|'detached'
},
'AvailabilityZone': 'string',
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa',
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'PrivateDnsName': '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'
},
],
'RequesterId': 'string',
'RequesterManaged': True|False,
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'TagSet': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
}
}
Response Structure
(dict) --
Contains the output of CreateNetworkInterface.
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 or Carrier 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.
InstanceId (string) --
The ID of the instance.
InstanceOwnerId (string) --
The AWS account ID of the owner of the instance.
Status (string) --
The attachment state.
AvailabilityZone (string) --
The Availability Zone.
Description (string) --
A description.
Groups (list) --
Any security groups for the network interface.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID 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.
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 AWS account ID of the owner of the network interface.
PrivateDnsName (string) --
The private DNS name.
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 or Carrier 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.
RequesterId (string) --
The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).
RequesterManaged (boolean) --
Indicates whether the network interface is being managed by AWS.
SourceDestCheck (boolean) --
Indicates whether traffic to or from the instance is validated.
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 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
{'NetworkInterfaces': {'Association': {'CustomerOwnedIp': 'string'},
'PrivateIpAddresses': {'Association': {'CustomerOwnedIp': 'string'}}}}
Describes one or more of your network interfaces.
See also: AWS API Documentation
Request Syntax
client.describe_network_interfaces(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NetworkInterfaceIds=[
'string',
],
NextToken='string',
MaxResults=123
)
list
One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address 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.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your 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.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
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.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The AWS account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS 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. The filters supported by a describe operation are documented with the describe operation. For example:
DescribeAvailabilityZones
DescribeImages
DescribeInstances
DescribeKeyPairs
DescribeSecurityGroups
DescribeSnapshots
DescribeSubnets
DescribeTags
DescribeVolumes
DescribeVpcs
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive.
(string) --
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
list
One or more network interface IDs.
Default: Describes all your network interfaces.
(string) --
string
The token to retrieve the next page of results.
integer
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.
dict
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,
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'Status': 'attaching'|'attached'|'detaching'|'detached'
},
'AvailabilityZone': 'string',
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa',
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'PrivateDnsName': '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'
},
],
'RequesterId': 'string',
'RequesterManaged': True|False,
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'TagSet': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeNetworkInterfaces.
NetworkInterfaces (list) --
Information about one or more 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 or Carrier 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.
InstanceId (string) --
The ID of the instance.
InstanceOwnerId (string) --
The AWS account ID of the owner of the instance.
Status (string) --
The attachment state.
AvailabilityZone (string) --
The Availability Zone.
Description (string) --
A description.
Groups (list) --
Any security groups for the network interface.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID 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.
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 AWS account ID of the owner of the network interface.
PrivateDnsName (string) --
The private DNS name.
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 or Carrier 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.
RequesterId (string) --
The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).
RequesterManaged (boolean) --
Indicates whether the network interface is being managed by AWS.
SourceDestCheck (boolean) --
Indicates whether traffic to or from the instance is validated.
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 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'CustomerOwnedIpv4Pool': 'string',
'MapCustomerOwnedIpOnLaunch': {'Value': 'boolean'}}
Modifies a subnet attribute. You can only modify one attribute at a time.
See also: AWS API Documentation
Request Syntax
client.modify_subnet_attribute(
AssignIpv6AddressOnCreation={
'Value': True|False
},
MapPublicIpOnLaunch={
'Value': True|False
},
SubnetId='string',
MapCustomerOwnedIpOnLaunch={
'Value': True|False
},
CustomerOwnedIpv4Pool='string'
)
dict
Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API.
Value (boolean) --
The attribute value. The valid values are true or false .
dict
Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
Value (boolean) --
The attribute value. The valid values are true or false .
string
[REQUIRED]
The ID of the subnet.
dict
Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.
When this value is true , you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool .
Value (boolean) --
The attribute value. The valid values are true or false .
string
The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true for MapCustomerOwnedIpOnLaunch .
None