2022/11/29 - Amazon Elastic Compute Cloud - 5 new 10 updated api methods
Changes Introduces ENA Express, which uses AWS SRD and dynamic routing to increase throughput and minimize latency, adds support for trust relationships between Reachability Analyzer and AWS Organizations to enable cross-account analysis, and adds support for Infrastructure Performance metric subscriptions.
Describes the curent Infrastructure Performance metric subscriptions.
See also: AWS API Documentation
Request Syntax
client.describe_aws_network_performance_metric_subscriptions(
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
list
One or more filters.
(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.
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) --
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
dict
Response Syntax
{
'NextToken': 'string',
'Subscriptions': [
{
'Source': 'string',
'Destination': 'string',
'Metric': 'aggregate-latency',
'Statistic': 'p50',
'Period': 'five-minutes'|'fifteen-minutes'|'one-hour'|'three-hours'|'one-day'|'one-week'
},
]
}
Response Structure
(dict) --
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.
Subscriptions (list) --
Describes the current Infrastructure Performance subscriptions.
(dict) --
Describes an Infrastructure Performance subscription.
Source (string) --
The Region or Availability Zone that's the source for the subscription. For example, us-east-1 .
Destination (string) --
The Region or Availability Zone that's the target for the subscription. For example, eu-west-1 .
Metric (string) --
The metric used for the subscription.
Statistic (string) --
The statistic used for the subscription.
Period (string) --
The data aggregation time for the subscription.
Enables Infrastructure Performance subscriptions.
See also: AWS API Documentation
Request Syntax
client.enable_aws_network_performance_metric_subscription(
Source='string',
Destination='string',
Metric='aggregate-latency',
Statistic='p50',
DryRun=True|False
)
string
The source Region or Availability Zone that the metric subscription is enabled for. For example, us-east-1 .
string
The target Region or Availability Zone that the metric subscription is enabled for. For example, eu-west-1 .
string
The metric used for the enabled subscription.
string
The statistic used for the enabled subscription.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
dict
Response Syntax
{
'Output': True|False
}
Response Structure
(dict) --
Output (boolean) --
Indicates whether the subscribe action was successful.
Disables Infrastructure Performance metric subscriptions.
See also: AWS API Documentation
Request Syntax
client.disable_aws_network_performance_metric_subscription(
Source='string',
Destination='string',
Metric='aggregate-latency',
Statistic='p50',
DryRun=True|False
)
string
The source Region or Availability Zone that the metric subscription is disabled for. For example, us-east-1 .
string
The target Region or Availability Zone that the metric subscription is disabled for. For example, eu-north-1 .
string
The metric used for the disabled subscription.
string
The statistic used for the disabled subscription.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
dict
Response Syntax
{
'Output': True|False
}
Response Structure
(dict) --
Output (boolean) --
Indicates whether the unsubscribe action was successful.
Gets network performance data.
See also: AWS API Documentation
Request Syntax
client.get_aws_network_performance_data(
DataQueries=[
{
'Id': 'string',
'Source': 'string',
'Destination': 'string',
'Metric': 'aggregate-latency',
'Statistic': 'p50',
'Period': 'five-minutes'|'fifteen-minutes'|'one-hour'|'three-hours'|'one-day'|'one-week'
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
A list of network performance data queries.
(dict) --
A query used for retrieving network health data.
Id (string) --
A user-defined ID associated with a data query that's returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01 in the query, the dataResponse identifies the query as MyQuery01 .
Source (string) --
The Region or Availability Zone that's the source for the data query. For example, us-east-1 .
Destination (string) --
The Region or Availability Zone that's the target for the data query. For example, eu-north-1 .
Metric (string) --
The aggregation metric used for the data query. Currently only aggregation-latency is supported, indicating network latency.
Statistic (string) --
Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:
p50 - The median value of the metric aggregated over a specified start and end time. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes.
Period (string) --
The aggregation period used for the data query.
datetime
The starting time for the performance data request. The starting time must be formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-10T12:00:00.000Z .
datetime
The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-12T12:00:00.000Z .
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The token for the next page of results.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
dict
Response Syntax
{
'DataResponses': [
{
'Id': 'string',
'Source': 'string',
'Destination': 'string',
'Metric': 'aggregate-latency',
'Statistic': 'p50',
'Period': 'five-minutes'|'fifteen-minutes'|'one-hour'|'three-hours'|'one-day'|'one-week',
'MetricPoints': [
{
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'Value': ...,
'Status': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DataResponses (list) --
The list of data responses.
(dict) --
The response to a DataQuery .
Id (string) --
The ID passed in the DataQuery .
Source (string) --
The Region or Availability Zone that's the source for the data query. For example, us-east-1 .
Destination (string) --
The Region or Availability Zone that's the destination for the data query. For example, eu-west-1 .
Metric (string) --
The metric used for the network performance request. Currently only aggregate-latency is supported, showing network latency during a specified period.
Statistic (string) --
The statistic used for the network performance request.
Period (string) --
The period used for the network performance request.
MetricPoints (list) --
A list of MetricPoint objects.
(dict) --
Indicates whether the network was healthy or unhealthy at a particular point. The value is aggregated from the startDate to the endDate . Currently only five_minutes is supported.
StartDate (datetime) --
The start date for the metric point. The starting date for the metric point. The starting time must be formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-10T12:00:00.000Z .
EndDate (datetime) --
The end date for the metric point. The ending time must be formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-12T12:00:00.000Z .
Value (float) --
Status (string) --
The status of the metric point.
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.
See also: AWS API Documentation
Request Syntax
client.enable_reachability_analyzer_organization_sharing(
DryRun=True|False
)
boolean
dict
Response Syntax
{
'ReturnValue': True|False
}
Response Structure
(dict) --
ReturnValue (boolean) --
{'EnaSrdSpecification': {'EnaSrdEnabled': 'boolean',
'EnaSrdUdpSpecification': {'EnaSrdUdpEnabled': 'boolean'}}}
Attaches a network interface to an instance.
See also: AWS API Documentation
Request Syntax
client.attach_network_interface(
DeviceIndex=123,
DryRun=True|False,
InstanceId='string',
NetworkInterfaceId='string',
NetworkCardIndex=123,
EnaSrdSpecification={
'EnaSrdEnabled': True|False,
'EnaSrdUdpSpecification': {
'EnaSrdUdpEnabled': True|False
}
}
)
integer
[REQUIRED]
The index of the device for the network interface attachment.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
string
[REQUIRED]
The ID of the instance.
string
[REQUIRED]
The ID of the network interface.
integer
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
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 uses ENA Express. To specify this setting, you must first enable ENA Express.
dict
Response Syntax
{
'AttachmentId': 'string',
'NetworkCardIndex': 123
}
Response Structure
(dict) --
Contains the output of AttachNetworkInterface.
AttachmentId (string) --
The ID of the network interface attachment.
NetworkCardIndex (integer) --
The index of the network card.
{'NetworkInsightsPath': {'DestinationArn': 'string', 'SourceArn': 'string'}}
Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.
See also: AWS API Documentation
Request Syntax
client.create_network_insights_path(
SourceIp='string',
DestinationIp='string',
Source='string',
Destination='string',
Protocol='tcp'|'udp',
DestinationPort=123,
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'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'|'vpn-connection-device-type',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
ClientToken='string'
)
string
The IP address of the Amazon Web Services resource that is the source of the path.
string
The IP address of the Amazon Web Services resource that is the destination of the path.
string
[REQUIRED]
The Amazon Web Services resource that is the source of the path.
string
[REQUIRED]
The Amazon Web Services resource that is the destination of the path.
string
[REQUIRED]
The protocol.
integer
The destination port.
list
The tags to add to the path.
(dict) --
The tags to apply to a resource when the resource is being created.
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.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
string
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'NetworkInsightsPath': {
'NetworkInsightsPathId': 'string',
'NetworkInsightsPathArn': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Source': 'string',
'Destination': 'string',
'SourceArn': 'string',
'DestinationArn': 'string',
'SourceIp': 'string',
'DestinationIp': 'string',
'Protocol': 'tcp'|'udp',
'DestinationPort': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
NetworkInsightsPath (dict) --
Information about the path.
NetworkInsightsPathId (string) --
The ID of the path.
NetworkInsightsPathArn (string) --
The Amazon Resource Name (ARN) of the path.
CreatedDate (datetime) --
The time stamp when the path was created.
Source (string) --
The Amazon Web Services resource that is the source of the path.
Destination (string) --
The Amazon Web Services resource that is the destination of the path.
SourceArn (string) --
DestinationArn (string) --
SourceIp (string) --
The IP address of the Amazon Web Services resource that is the source of the path.
DestinationIp (string) --
The IP address of the Amazon Web Services resource that is the destination of the path.
Protocol (string) --
The protocol.
DestinationPort (integer) --
The destination port.
Tags (list) --
The tags associated with the path.
(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.
{'NetworkInterface': {'Attachment': {'EnaSrdSpecification': {'EnaSrdEnabled': 'boolean',
'EnaSrdUdpSpecification': {'EnaSrdUdpEnabled': 'boolean'}}}}}
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, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .
For more information about network interfaces, see Elastic network interfaces in the Amazon Elastic Compute 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,
Ipv4Prefixes=[
{
'Ipv4Prefix': 'string'
},
],
Ipv4PrefixCount=123,
Ipv6Prefixes=[
{
'Ipv6Prefix': 'string'
},
],
Ipv6PrefixCount=123,
InterfaceType='efa'|'branch'|'trunk',
SubnetId='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'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'|'vpn-connection-device-type',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='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 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.
list
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.
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
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.
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 .
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.
list
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 Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .
integer
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.
list
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 IPv4 prefix option for a network interface.
Ipv6Prefix (string) --
The IPv6 prefix.
integer
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.
string
The type of network interface. The default is interface .
The only supported values are efa and trunk .
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.
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.
string
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.
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,
'NetworkCardIndex': 123,
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'Status': 'attaching'|'attached'|'detaching'|'detached',
'EnaSrdSpecification': {
'EnaSrdEnabled': True|False,
'EnaSrdUdpSpecification': {
'EnaSrdUdpEnabled': True|False
}
}
},
'AvailabilityZone': 'string',
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa'|'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'
},
],
'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'
},
],
'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'
},
'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 that's attached to the instance.
EnaSrdUdpSpecification (dict) --
ENA Express configuration 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.
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 Amazon Web Services 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 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 Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud 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.
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.
{'InstanceTypes': {'NetworkInfo': {'EnaSrdSupported': 'boolean'}}}
Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.
See also: AWS API Documentation
Request Syntax
client.describe_instance_types(
DryRun=True|False,
InstanceTypes=[
'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
list
The instance types. For more information, see Instance types in the Amazon EC2 User Guide .
(string) --
list
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether auto recovery is supported ( true | false ).
bare-metal - Indicates whether it is a bare metal instance type ( true | false ).
burstable-performance-supported - Indicates whether it is a burstable performance instance type ( true | false ).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family ( true | false ).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized ( supported | unsupported | default ).
ebs-info.encryption-support - Indicates whether EBS encryption is supported ( supported | unsupported ).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes ( required | supported | unsupported ).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier ( true | false ).
hibernation-supported - Indicates whether On-Demand hibernation is supported ( true | false ).
hypervisor - The hypervisor ( nitro | xen ).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks ( hdd | ssd ).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest ( required | supported | unsupported ).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store ( required | supported | unsupported ).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage ( true | false ).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) ( true | false ).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required ( required | supported | unsupported ).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances ( true | false ).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 ( true | false ).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, "25 Gigabit").
processor-info.supported-architecture - The CPU architecture ( arm64 | i386 | x86_64 ).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
supported-boot-mode - The boot mode ( legacy-bios | uefi ).
supported-root-device-type - The root device type ( ebs | instance-store ).
supported-usage-class - The usage class ( on-demand | spot ).
supported-virtualization-type - The virtualization type ( hvm | paravirtual ).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
(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.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value.
string
The token to retrieve the next page of results.
dict
Response Syntax
{
'InstanceTypes': [
{
'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge',
'CurrentGeneration': True|False,
'FreeTierEligible': True|False,
'SupportedUsageClasses': [
'spot'|'on-demand',
],
'SupportedRootDeviceTypes': [
'ebs'|'instance-store',
],
'SupportedVirtualizationTypes': [
'hvm'|'paravirtual',
],
'BareMetal': True|False,
'Hypervisor': 'nitro'|'xen',
'ProcessorInfo': {
'SupportedArchitectures': [
'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac',
],
'SustainedClockSpeedInGhz': 123.0
},
'VCpuInfo': {
'DefaultVCpus': 123,
'DefaultCores': 123,
'DefaultThreadsPerCore': 123,
'ValidCores': [
123,
],
'ValidThreadsPerCore': [
123,
]
},
'MemoryInfo': {
'SizeInMiB': 123
},
'InstanceStorageSupported': True|False,
'InstanceStorageInfo': {
'TotalSizeInGB': 123,
'Disks': [
{
'SizeInGB': 123,
'Count': 123,
'Type': 'hdd'|'ssd'
},
],
'NvmeSupport': 'unsupported'|'supported'|'required',
'EncryptionSupport': 'unsupported'|'required'
},
'EbsInfo': {
'EbsOptimizedSupport': 'unsupported'|'supported'|'default',
'EncryptionSupport': 'unsupported'|'supported',
'EbsOptimizedInfo': {
'BaselineBandwidthInMbps': 123,
'BaselineThroughputInMBps': 123.0,
'BaselineIops': 123,
'MaximumBandwidthInMbps': 123,
'MaximumThroughputInMBps': 123.0,
'MaximumIops': 123
},
'NvmeSupport': 'unsupported'|'supported'|'required'
},
'NetworkInfo': {
'NetworkPerformance': 'string',
'MaximumNetworkInterfaces': 123,
'MaximumNetworkCards': 123,
'DefaultNetworkCardIndex': 123,
'NetworkCards': [
{
'NetworkCardIndex': 123,
'NetworkPerformance': 'string',
'MaximumNetworkInterfaces': 123
},
],
'Ipv4AddressesPerInterface': 123,
'Ipv6AddressesPerInterface': 123,
'Ipv6Supported': True|False,
'EnaSupport': 'unsupported'|'supported'|'required',
'EfaSupported': True|False,
'EfaInfo': {
'MaximumEfaInterfaces': 123
},
'EncryptionInTransitSupported': True|False,
'EnaSrdSupported': True|False
},
'GpuInfo': {
'Gpus': [
{
'Name': 'string',
'Manufacturer': 'string',
'Count': 123,
'MemoryInfo': {
'SizeInMiB': 123
}
},
],
'TotalGpuMemoryInMiB': 123
},
'FpgaInfo': {
'Fpgas': [
{
'Name': 'string',
'Manufacturer': 'string',
'Count': 123,
'MemoryInfo': {
'SizeInMiB': 123
}
},
],
'TotalFpgaMemoryInMiB': 123
},
'PlacementGroupInfo': {
'SupportedStrategies': [
'cluster'|'partition'|'spread',
]
},
'InferenceAcceleratorInfo': {
'Accelerators': [
{
'Count': 123,
'Name': 'string',
'Manufacturer': 'string'
},
]
},
'HibernationSupported': True|False,
'BurstablePerformanceSupported': True|False,
'DedicatedHostsSupported': True|False,
'AutoRecoverySupported': True|False,
'SupportedBootModes': [
'legacy-bios'|'uefi',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceTypes (list) --
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .
(dict) --
Describes the instance type.
InstanceType (string) --
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .
CurrentGeneration (boolean) --
Indicates whether the instance type is current generation.
FreeTierEligible (boolean) --
Indicates whether the instance type is eligible for the free tier.
SupportedUsageClasses (list) --
Indicates whether the instance type is offered for spot or On-Demand.
(string) --
SupportedRootDeviceTypes (list) --
The supported root device types.
(string) --
SupportedVirtualizationTypes (list) --
The supported virtualization types.
(string) --
BareMetal (boolean) --
Indicates whether the instance is a bare metal instance type.
Hypervisor (string) --
The hypervisor for the instance type.
ProcessorInfo (dict) --
Describes the processor.
SupportedArchitectures (list) --
The architectures supported by the instance type.
(string) --
SustainedClockSpeedInGhz (float) --
The speed of the processor, in GHz.
VCpuInfo (dict) --
Describes the vCPU configurations for the instance type.
DefaultVCpus (integer) --
The default number of vCPUs for the instance type.
DefaultCores (integer) --
The default number of cores for the instance type.
DefaultThreadsPerCore (integer) --
The default number of threads per core for the instance type.
ValidCores (list) --
The valid number of cores that can be configured for the instance type.
(integer) --
ValidThreadsPerCore (list) --
The valid number of threads per core that can be configured for the instance type.
(integer) --
MemoryInfo (dict) --
Describes the memory for the instance type.
SizeInMiB (integer) --
The size of the memory, in MiB.
InstanceStorageSupported (boolean) --
Indicates whether instance storage is supported.
InstanceStorageInfo (dict) --
Describes the instance storage for the instance type.
TotalSizeInGB (integer) --
The total size of the disks, in GB.
Disks (list) --
Describes the disks that are available for the instance type.
(dict) --
Describes a disk.
SizeInGB (integer) --
The size of the disk in GB.
Count (integer) --
The number of disks with this configuration.
Type (string) --
The type of disk.
NvmeSupport (string) --
Indicates whether non-volatile memory express (NVMe) is supported.
EncryptionSupport (string) --
Indicates whether data is encrypted at rest.
EbsInfo (dict) --
Describes the Amazon EBS settings for the instance type.
EbsOptimizedSupport (string) --
Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide .
EncryptionSupport (string) --
Indicates whether Amazon EBS encryption is supported.
EbsOptimizedInfo (dict) --
Describes the optimized EBS performance for the instance type.
BaselineBandwidthInMbps (integer) --
The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
BaselineThroughputInMBps (float) --
The baseline throughput performance for an EBS-optimized instance type, in MB/s.
BaselineIops (integer) --
The baseline input/output storage operations per seconds for an EBS-optimized instance type.
MaximumBandwidthInMbps (integer) --
The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
MaximumThroughputInMBps (float) --
The maximum throughput performance for an EBS-optimized instance type, in MB/s.
MaximumIops (integer) --
The maximum input/output storage operations per second for an EBS-optimized instance type.
NvmeSupport (string) --
Indicates whether non-volatile memory express (NVMe) is supported.
NetworkInfo (dict) --
Describes the network settings for the instance type.
NetworkPerformance (string) --
The network performance.
MaximumNetworkInterfaces (integer) --
The maximum number of network interfaces for the instance type.
MaximumNetworkCards (integer) --
The maximum number of physical network cards that can be allocated to the instance.
DefaultNetworkCardIndex (integer) --
The index of the default network card, starting at 0.
NetworkCards (list) --
Describes the network cards for the instance type.
(dict) --
Describes the network card support of the instance type.
NetworkCardIndex (integer) --
The index of the network card.
NetworkPerformance (string) --
The network performance of the network card.
MaximumNetworkInterfaces (integer) --
The maximum number of network interfaces for the network card.
Ipv4AddressesPerInterface (integer) --
The maximum number of IPv4 addresses per network interface.
Ipv6AddressesPerInterface (integer) --
The maximum number of IPv6 addresses per network interface.
Ipv6Supported (boolean) --
Indicates whether IPv6 is supported.
EnaSupport (string) --
Indicates whether Elastic Network Adapter (ENA) is supported.
EfaSupported (boolean) --
Indicates whether Elastic Fabric Adapter (EFA) is supported.
EfaInfo (dict) --
Describes the Elastic Fabric Adapters for the instance type.
MaximumEfaInterfaces (integer) --
The maximum number of Elastic Fabric Adapters for the instance type.
EncryptionInTransitSupported (boolean) --
Indicates whether the instance type automatically encrypts in-transit traffic between instances.
EnaSrdSupported (boolean) --
Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.
GpuInfo (dict) --
Describes the GPU accelerator settings for the instance type.
Gpus (list) --
Describes the GPU accelerators for the instance type.
(dict) --
Describes the GPU accelerators for the instance type.
Name (string) --
The name of the GPU accelerator.
Manufacturer (string) --
The manufacturer of the GPU accelerator.
Count (integer) --
The number of GPUs for the instance type.
MemoryInfo (dict) --
Describes the memory available to the GPU accelerator.
SizeInMiB (integer) --
The size of the memory available to the GPU accelerator, in MiB.
TotalGpuMemoryInMiB (integer) --
The total size of the memory for the GPU accelerators for the instance type, in MiB.
FpgaInfo (dict) --
Describes the FPGA accelerator settings for the instance type.
Fpgas (list) --
Describes the FPGAs for the instance type.
(dict) --
Describes the FPGA accelerator for the instance type.
Name (string) --
The name of the FPGA accelerator.
Manufacturer (string) --
The manufacturer of the FPGA accelerator.
Count (integer) --
The count of FPGA accelerators for the instance type.
MemoryInfo (dict) --
Describes the memory for the FPGA accelerator for the instance type.
SizeInMiB (integer) --
The size of the memory available to the FPGA accelerator, in MiB.
TotalFpgaMemoryInMiB (integer) --
The total memory of all FPGA accelerators for the instance type.
PlacementGroupInfo (dict) --
Describes the placement group settings for the instance type.
SupportedStrategies (list) --
The supported placement group types.
(string) --
InferenceAcceleratorInfo (dict) --
Describes the Inference accelerator settings for the instance type.
Accelerators (list) --
Describes the Inference accelerators for the instance type.
(dict) --
Describes the Inference accelerators for the instance type.
Count (integer) --
The number of Inference accelerators for the instance type.
Name (string) --
The name of the Inference accelerator.
Manufacturer (string) --
The manufacturer of the Inference accelerator.
HibernationSupported (boolean) --
Indicates whether On-Demand hibernation is supported.
BurstablePerformanceSupported (boolean) --
Indicates whether the instance type is a burstable performance instance type.
DedicatedHostsSupported (boolean) --
Indicates whether Dedicated Hosts are supported on the instance type.
AutoRecoverySupported (boolean) --
Indicates whether auto recovery is supported.
SupportedBootModes (list) --
The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide .
(string) --
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.
{'NetworkInsightsAnalyses': {'AdditionalAccounts': ['string'],
'SuggestedAccounts': ['string']}}
Describes one or more of your network insights analyses.
See also: AWS API Documentation
Request Syntax
client.describe_network_insights_analyses(
NetworkInsightsAnalysisIds=[
'string',
],
NetworkInsightsPathId='string',
AnalysisStartTime=datetime(2015, 1, 1),
AnalysisEndTime=datetime(2015, 1, 1),
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
DryRun=True|False,
NextToken='string'
)
list
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
(string) --
string
The ID of the path. You must specify either a path ID or analysis IDs.
datetime
The time when the network insights analyses started.
datetime
The time when the network insights analyses ended.
list
The filters. The following are the possible values:
path-found - A Boolean value that indicates whether a feasible path is found.
status - The status of the analysis (running | succeeded | failed).
(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.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
string
The token for the next page of results.
dict
Response Syntax
{
'NetworkInsightsAnalyses': [
{
'NetworkInsightsAnalysisId': 'string',
'NetworkInsightsAnalysisArn': 'string',
'NetworkInsightsPathId': 'string',
'AdditionalAccounts': [
'string',
],
'FilterInArns': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'Status': 'running'|'succeeded'|'failed',
'StatusMessage': 'string',
'WarningMessage': 'string',
'NetworkPathFound': True|False,
'ForwardPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'ReturnPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'AlternatePathHints': [
{
'ComponentId': 'string',
'ComponentArn': 'string'
},
],
'SuggestedAccounts': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
**Response Structure**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeNetworkInsightsAnalyses>`_
{'NetworkInsightsPaths': {'DestinationArn': 'string', 'SourceArn': 'string'}}
Describes one or more of your paths.
See also: AWS API Documentation
Request Syntax
client.describe_network_insights_paths(
NetworkInsightsPathIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
DryRun=True|False,
NextToken='string'
)
list
The IDs of the paths.
(string) --
list
The filters. The following are the possible values:
destination - The ID of the resource.
destination-port - The destination port.
protocol - The protocol.
source - The ID of the resource.
(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.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
string
The token for the next page of results.
dict
Response Syntax
{
'NetworkInsightsPaths': [
{
'NetworkInsightsPathId': 'string',
'NetworkInsightsPathArn': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Source': 'string',
'Destination': 'string',
'SourceArn': 'string',
'DestinationArn': 'string',
'SourceIp': 'string',
'DestinationIp': 'string',
'Protocol': 'tcp'|'udp',
'DestinationPort': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkInsightsPaths (list) --
Information about the paths.
(dict) --
Describes a path.
NetworkInsightsPathId (string) --
The ID of the path.
NetworkInsightsPathArn (string) --
The Amazon Resource Name (ARN) of the path.
CreatedDate (datetime) --
The time stamp when the path was created.
Source (string) --
The Amazon Web Services resource that is the source of the path.
Destination (string) --
The Amazon Web Services resource that is the destination of the path.
SourceArn (string) --
DestinationArn (string) --
SourceIp (string) --
The IP address of the Amazon Web Services resource that is the source of the path.
DestinationIp (string) --
The IP address of the Amazon Web Services resource that is the destination of the path.
Protocol (string) --
The protocol.
DestinationPort (integer) --
The destination port.
Tags (list) --
The tags associated with the path.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
{'Attachment': {'EnaSrdSpecification': {'EnaSrdEnabled': 'boolean',
'EnaSrdUdpSpecification': {'EnaSrdUdpEnabled': 'boolean'}}}}
Describes a network interface attribute. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
client.describe_network_interface_attribute(
Attribute='description'|'groupSet'|'sourceDestCheck'|'attachment',
DryRun=True|False,
NetworkInterfaceId='string'
)
string
The attribute of the network interface. This parameter is required.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
string
[REQUIRED]
The ID of the network interface.
dict
Response Syntax
{
'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
}
}
},
'Description': {
'Value': 'string'
},
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'NetworkInterfaceId': 'string',
'SourceDestCheck': {
'Value': True|False
}
}
Response Structure
(dict) --
Contains the output of DescribeNetworkInterfaceAttribute.
Attachment (dict) --
The attachment (if any) of the network interface.
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 that's attached to the instance.
EnaSrdUdpSpecification (dict) --
ENA Express configuration 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.
Description (dict) --
The description of the network interface.
Value (string) --
The attribute value. The value is case-sensitive.
Groups (list) --
The security groups associated with the network interface.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
NetworkInterfaceId (string) --
The ID of the network interface.
SourceDestCheck (dict) --
Indicates whether source/destination checking is enabled.
Value (boolean) --
The attribute value. The valid values are true or false .
{'NetworkInterfaces': {'Attachment': {'EnaSrdSpecification': {'EnaSrdEnabled': 'boolean',
'EnaSrdUdpSpecification': {'EnaSrdUdpEnabled': 'boolean'}}}}}
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.
interface-type - The type of network interface ( api_gateway_managed | aws_codestar_connections_managed | branch | efa | 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.
owner-id - The Amazon Web Services 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 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 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.
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) --
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 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,
'NetworkCardIndex': 123,
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'Status': 'attaching'|'attached'|'detaching'|'detached',
'EnaSrdSpecification': {
'EnaSrdEnabled': True|False,
'EnaSrdUdpSpecification': {
'EnaSrdUdpEnabled': True|False
}
}
},
'AvailabilityZone': 'string',
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa'|'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'
},
],
'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'
},
],
'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'
},
],
'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 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 that's attached to the instance.
EnaSrdUdpSpecification (dict) --
ENA Express configuration 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.
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 Amazon Web Services 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 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 Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud 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.
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.
{'EnaSrdSpecification': {'EnaSrdEnabled': 'boolean',
'EnaSrdUdpSpecification': {'EnaSrdUdpEnabled': 'boolean'}}}
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(
Attachment={
'AttachmentId': 'string',
'DeleteOnTermination': True|False
},
Description={
'Value': 'string'
},
DryRun=True|False,
Groups=[
'string',
],
NetworkInterfaceId='string',
SourceDestCheck={
'Value': True|False
},
EnaSrdSpecification={
'EnaSrdEnabled': True|False,
'EnaSrdUdpSpecification': {
'EnaSrdUdpEnabled': True|False
}
}
)
dict
Information about the interface attachment. If modifying the delete on termination attribute, you must specify the ID of the interface attachment.
AttachmentId (string) --
The ID of the network interface attachment.
DeleteOnTermination (boolean) --
Indicates whether the network interface is deleted when the instance is terminated.
dict
A description for the network interface.
Value (string) --
The attribute value. The value is case-sensitive.
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
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) --
string
[REQUIRED]
The ID of the network interface.
dict
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 .
dict
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 uses ENA Express. To specify this setting, you must first enable ENA Express.
None
{'AdditionalAccounts': ['string']}
Response {'NetworkInsightsAnalysis': {'AdditionalAccounts': ['string'],
'SuggestedAccounts': ['string']}}
Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
See also: AWS API Documentation
Request Syntax
client.start_network_insights_analysis(
NetworkInsightsPathId='string',
AdditionalAccounts=[
'string',
],
FilterInArns=[
'string',
],
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'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'|'vpn-connection-device-type',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of the path.
list
(string) --
list
The Amazon Resource Names (ARN) of the resources that the path must traverse.
(string) --
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .
list
The tags to apply.
(dict) --
The tags to apply to a resource when the resource is being created.
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.
string
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'NetworkInsightsAnalysis': {
'NetworkInsightsAnalysisId': 'string',
'NetworkInsightsAnalysisArn': 'string',
'NetworkInsightsPathId': 'string',
'AdditionalAccounts': [
'string',
],
'FilterInArns': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'Status': 'running'|'succeeded'|'failed',
'StatusMessage': 'string',
'WarningMessage': 'string',
'NetworkPathFound': True|False,
'ForwardPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'ReturnPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'OutboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'InboundHeader': {
'DestinationAddresses': [
'string',
],
'DestinationPortRanges': [
{
'From': 123,
'To': 123
},
],
'Protocol': 'string',
'SourceAddresses': [
'string',
],
'SourcePortRanges': [
{
'From': 123,
'To': 123
},
]
},
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AdditionalDetails': [
{
'AdditionalDetailType': 'string',
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
],
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Address': 'string',
'Addresses': [
'string',
],
'AttachedTo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string',
'State': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGateway': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTable': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'TransitGatewayRouteTableRoute': {
'DestinationCidr': 'string',
'State': 'string',
'RouteOrigin': 'string',
'PrefixListId': 'string',
'AttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'string'
},
'TransitGatewayAttachment': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'ComponentAccount': 'string',
'ComponentRegion': 'string'
},
],
'AlternatePathHints': [
{
'ComponentId': 'string',
'ComponentArn': 'string'
},
],
'SuggestedAccounts': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
**Response Structure**
::
# This section is too large to render.
# Please see the AWS API Documentation linked below.
`AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/StartNetworkInsightsAnalysis>`_