Table of Contents
A low-level client representing Amazon Elastic Compute Cloud (EC2)
Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS Cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the AWS Cloud where you can launch AWS resources in a virtual network that you've defined. Amazon Elastic Block Store (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available and reliable storage volumes that can be attached to any running instance and used like a hard drive.
To learn more, see the following resources:
import boto3
client = boto3.client('ec2')
These are the available methods:
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
See also: AWS API Documentation
Request Syntax
response = client.accept_reserved_instances_exchange_quote(
DryRun=True|False,
ReservedInstanceIds=[
'string',
],
TargetConfigurations=[
{
'InstanceCount': 123,
'OfferingId': 'string'
},
]
)
[REQUIRED]
The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
Details about the target configuration.
The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
The Convertible Reserved Instance offering ID.
dict
Response Syntax
{
'ExchangeId': 'string'
}
Response Structure
(dict) --
The result of the exchange and whether it was successful .
ExchangeId (string) --
The ID of the successful exchange.
Accepts a request to associate subnets with a transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
response = client.accept_transit_gateway_multicast_domain_associations(
TransitGatewayMulticastDomainId='string',
TransitGatewayAttachmentId='string',
SubnetIds=[
'string',
],
DryRun=True|False
)
The IDs of the subnets to associate with the transit gateway multicast domain.
dict
Response Syntax
{
'Associations': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceOwnerId': 'string',
'Subnets': [
{
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
},
]
}
}
Response Structure
(dict) --
Associations (dict) --
Describes the multicast domain associations.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the AWS account that owns the resource.
Subnets (list) --
The subnets associated with the multicast domain.
(dict) --
Describes the subnet association with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
See also: AWS API Documentation
Request Syntax
response = client.accept_transit_gateway_peering_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway attachment.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
The transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
See also: AWS API Documentation
Request Syntax
response = client.accept_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'TransitGatewayVpcAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'VpcId': 'string',
'VpcOwnerId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'SubnetIds': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Options': {
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayVpcAttachment (dict) --
The VPC attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
VpcId (string) --
The ID of the VPC.
VpcOwnerId (string) --
The ID of the AWS account that owns the VPC.
State (string) --
The state of the VPC attachment. Note that the initiating state has been deprecated.
SubnetIds (list) --
The IDs of the subnets.
CreationTime (datetime) --
The creation time.
Options (dict) --
The VPC attachment options.
DnsSupport (string) --
Indicates whether DNS support is enabled.
Ipv6Support (string) --
Indicates whether IPv6 support is disabled.
ApplianceModeSupport (string) --
Indicates whether appliance mode support is enabled.
Tags (list) --
The tags for the VPC attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
See also: AWS API Documentation
Request Syntax
response = client.accept_vpc_endpoint_connections(
DryRun=True|False,
ServiceId='string',
VpcEndpointIds=[
'string',
]
)
[REQUIRED]
The ID of the VPC endpoint service.
[REQUIRED]
The IDs of one or more interface VPC endpoints.
dict
Response Syntax
{
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Unsuccessful (list) --
Information about the interface endpoints that were not accepted, if applicable.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
See also: AWS API Documentation
Request Syntax
response = client.accept_vpc_peering_connection(
DryRun=True|False,
VpcPeeringConnectionId='string'
)
dict
Response Syntax
{
'VpcPeeringConnection': {
'AccepterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'ExpirationTime': datetime(2015, 1, 1),
'RequesterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcPeeringConnectionId': 'string'
}
}
Response Structure
(dict) --
VpcPeeringConnection (dict) --
Information about the VPC peering connection.
AccepterVpcInfo (dict) --
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
ExpirationTime (datetime) --
The time that an unaccepted VPC peering connection will expire.
RequesterVpcInfo (dict) --
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
Status (dict) --
The status of the VPC peering connection.
Code (string) --
The status of the VPC peering connection.
Message (string) --
A message that provides more information about the status, if applicable.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr .
See also: AWS API Documentation
Request Syntax
response = client.advertise_byoip_cidr(
Cidr='string',
DryRun=True|False
)
[REQUIRED]
The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'Description': 'string',
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address pool.
Allocates an Elastic IP address to your account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide .
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
See also: AWS API Documentation
Request Syntax
response = client.allocate_address(
Domain='vpc'|'standard',
Address='string',
PublicIpv4Pool='string',
NetworkBorderGroup='string',
CustomerOwnedIpv4Pool='string',
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
Default: If the Region supports EC2-Classic, the default is standard . Otherwise, the default is vpc .
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
Note
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes .
The tags to assign to the Elastic IP address.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'PublicIp': 'string',
'AllocationId': 'string',
'PublicIpv4Pool': 'string',
'NetworkBorderGroup': 'string',
'Domain': 'vpc'|'standard',
'CustomerOwnedIp': 'string',
'CustomerOwnedIpv4Pool': 'string',
'CarrierIp': 'string'
}
Response Structure
(dict) --
PublicIp (string) --
The Elastic IP address.
AllocationId (string) --
[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
PublicIpv4Pool (string) --
The ID of an address pool.
NetworkBorderGroup (string) --
The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
Domain (string) --
Indicates whether the Elastic IP address is for use with instances in a VPC (vpc ) or instances in EC2-Classic (standard ).
CustomerOwnedIp (string) --
The customer-owned IP address.
CustomerOwnedIpv4Pool (string) --
The ID of the customer-owned address pool.
CarrierIp (string) --
The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
Examples
This example allocates an Elastic IP address to use with an instance in a VPC.
response = client.allocate_address(
Domain='vpc',
)
print(response)
Expected Output:
{
'AllocationId': 'eipalloc-64d5890a',
'Domain': 'vpc',
'PublicIp': '203.0.113.0',
'ResponseMetadata': {
'...': '...',
},
}
This example allocates an Elastic IP address to use with an instance in EC2-Classic.
response = client.allocate_address(
)
print(response)
Expected Output:
{
'Domain': 'standard',
'PublicIp': '198.51.100.0',
'ResponseMetadata': {
'...': '...',
},
}
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
See also: AWS API Documentation
Request Syntax
response = client.allocate_hosts(
AutoPlacement='on'|'off',
AvailabilityZone='string',
ClientToken='string',
InstanceType='string',
InstanceFamily='string',
Quantity=123,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
HostRecovery='on'|'off'
)
Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide .
Default: on
[REQUIRED]
The Availability Zone in which to allocate the Dedicated Host.
Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
[REQUIRED]
The number of Dedicated Hosts to allocate to your account with these parameters.
The tags to apply to the Dedicated Host during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide .
Default: off
dict
Response Syntax
{
'HostIds': [
'string',
]
}
Response Structure
(dict) --
Contains the output of AllocateHosts.
HostIds (list) --
The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
See also: AWS API Documentation
Request Syntax
response = client.apply_security_groups_to_client_vpn_target_network(
ClientVpnEndpointId='string',
VpcId='string',
SecurityGroupIds=[
'string',
],
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint.
[REQUIRED]
The ID of the VPC in which the associated target network is located.
[REQUIRED]
The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.
dict
Response Syntax
{
'SecurityGroupIds': [
'string',
]
}
Response Structure
(dict) --
SecurityGroupIds (list) --
The IDs of the applied security groups.
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide .
You must specify either the IPv6 addresses or the IPv6 address count in the request.
See also: AWS API Documentation
Request Syntax
response = client.assign_ipv6_addresses(
Ipv6AddressCount=123,
Ipv6Addresses=[
'string',
],
NetworkInterfaceId='string'
)
One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
[REQUIRED]
The ID of the network interface.
dict
Response Syntax
{
'AssignedIpv6Addresses': [
'string',
],
'NetworkInterfaceId': 'string'
}
Response Structure
(dict) --
AssignedIpv6Addresses (list) --
The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that were assigned to the network interface before the request are not included.
NetworkInterfaceId (string) --
The ID of the network interface.
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide . For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
See also: AWS API Documentation
Request Syntax
response = client.assign_private_ip_addresses(
AllowReassignment=True|False,
NetworkInterfaceId='string',
PrivateIpAddresses=[
'string',
],
SecondaryPrivateIpAddressCount=123
)
[REQUIRED]
The ID of the network interface.
One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
dict
Response Syntax
{
'NetworkInterfaceId': 'string',
'AssignedPrivateIpAddresses': [
{
'PrivateIpAddress': 'string'
},
]
}
Response Structure
(dict) --
NetworkInterfaceId (string) --
The ID of the network interface.
AssignedPrivateIpAddresses (list) --
The private IP addresses assigned to the network interface.
(dict) --
Describes the private IP addresses assigned to a network interface.
PrivateIpAddress (string) --
The private IP address assigned to the network interface.
Examples
This example assigns the specified secondary private IP address to the specified network interface.
response = client.assign_private_ip_addresses(
NetworkInterfaceId='eni-e5aa89a3',
PrivateIpAddresses=[
'10.0.0.82',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.
response = client.assign_private_ip_addresses(
NetworkInterfaceId='eni-e5aa89a3',
SecondaryPrivateIpAddressCount=2,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
Warning
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing .
See also: AWS API Documentation
Request Syntax
response = client.associate_address(
AllocationId='string',
InstanceId='string',
PublicIp='string',
AllowReassociation=True|False,
DryRun=True|False,
NetworkInterfaceId='string',
PrivateIpAddress='string'
)
[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
dict
Response Syntax
{
'AssociationId': 'string'
}
Response Structure
(dict) --
AssociationId (string) --
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
Examples
This example associates the specified Elastic IP address with the specified instance in a VPC.
response = client.associate_address(
AllocationId='eipalloc-64d5890a',
InstanceId='i-0b263919b6498b123',
)
print(response)
Expected Output:
{
'AssociationId': 'eipassoc-2bebb745',
'ResponseMetadata': {
'...': '...',
},
}
This example associates the specified Elastic IP address with the specified network interface.
response = client.associate_address(
AllocationId='eipalloc-64d5890a',
NetworkInterfaceId='eni-1a2b3c4d',
)
print(response)
Expected Output:
{
'AssociationId': 'eipassoc-2bebb745',
'ResponseMetadata': {
'...': '...',
},
}
This example associates an Elastic IP address with an instance in EC2-Classic.
response = client.associate_address(
InstanceId='i-07ffe74c7330ebf53',
PublicIp='198.51.100.0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint ( ModifyClientVpnEndpoint ) and change the VPC that's associated with it.
See also: AWS API Documentation
Request Syntax
response = client.associate_client_vpn_target_network(
ClientVpnEndpointId='string',
SubnetId='string',
ClientToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint.
[REQUIRED]
The ID of the subnet to associate with the Client VPN endpoint.
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
{
'AssociationId': 'string',
'Status': {
'Code': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated',
'Message': 'string'
}
}
Response Structure
(dict) --
AssociationId (string) --
The unique ID of the target network association.
Status (dict) --
The current state of the target network association.
Code (string) --
The state of the target network association.
Message (string) --
A message about the status of the target network association, if applicable.
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_dhcp_options(
DhcpOptionsId='string',
VpcId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
[REQUIRED]
The ID of the VPC.
None
Examples
This example associates the specified DHCP options set with the specified VPC.
response = client.associate_dhcp_options(
DhcpOptionsId='dopt-d9070ebb',
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example associates the default DHCP options set with the specified VPC.
response = client.associate_dhcp_options(
DhcpOptionsId='default',
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide .
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_enclave_certificate_iam_role(
CertificateArn='string',
RoleArn='string',
DryRun=True|False
)
dict
Response Syntax
{
'CertificateS3BucketName': 'string',
'CertificateS3ObjectKey': 'string',
'EncryptionKmsKeyId': 'string'
}
Response Structure
(dict) --
CertificateS3BucketName (string) --
The name of the Amazon S3 bucket to which the certificate was uploaded.
CertificateS3ObjectKey (string) --
The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn /certificate_arn .
EncryptionKmsKeyId (string) --
The ID of the KMS key used to encrypt the private key of the certificate.
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
See also: AWS API Documentation
Request Syntax
response = client.associate_iam_instance_profile(
IamInstanceProfile={
'Arn': 'string',
'Name': 'string'
},
InstanceId='string'
)
[REQUIRED]
The IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
[REQUIRED]
The ID of the instance.
dict
Response Syntax
{
'IamInstanceProfileAssociation': {
'AssociationId': 'string',
'InstanceId': 'string',
'IamInstanceProfile': {
'Arn': 'string',
'Id': 'string'
},
'State': 'associating'|'associated'|'disassociating'|'disassociated',
'Timestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
IamInstanceProfileAssociation (dict) --
Information about the IAM instance profile association.
AssociationId (string) --
The ID of the association.
InstanceId (string) --
The ID of the instance.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Id (string) --
The ID of the instance profile.
State (string) --
The state of the association.
Timestamp (datetime) --
The time the IAM instance profile was associated with the instance.
Examples
This example associates an IAM instance profile named admin-role with the specified instance.
response = client.associate_iam_instance_profile(
IamInstanceProfile={
'Name': 'admin-role',
},
InstanceId='i-123456789abcde123',
)
print(response)
Expected Output:
{
'IamInstanceProfileAssociation': {
'AssociationId': 'iip-assoc-0e7736511a163c209',
'IamInstanceProfile': {
'Arn': 'arn:aws:iam::123456789012:instance-profile/admin-role',
'Id': 'AIPAJBLK7RKJKWDXVHIEC',
},
'InstanceId': 'i-123456789abcde123',
'State': 'associating',
},
'ResponseMetadata': {
'...': '...',
},
}
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_route_table(
DryRun=True|False,
RouteTableId='string',
SubnetId='string',
GatewayId='string'
)
[REQUIRED]
The ID of the route table.
dict
Response Syntax
{
'AssociationId': 'string',
'AssociationState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failed',
'StatusMessage': 'string'
}
}
Response Structure
(dict) --
AssociationId (string) --
The route table association ID. This ID is required for disassociating the route table.
AssociationState (dict) --
The state of the association.
State (string) --
The state of the association.
StatusMessage (string) --
The status message, if applicable.
Examples
This example associates the specified route table with the specified subnet.
response = client.associate_route_table(
RouteTableId='rtb-22574640',
SubnetId='subnet-9d4a7b6',
)
print(response)
Expected Output:
{
'AssociationId': 'rtbassoc-781d0d1a',
'ResponseMetadata': {
'...': '...',
},
}
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.
See also: AWS API Documentation
Request Syntax
response = client.associate_subnet_cidr_block(
Ipv6CidrBlock='string',
SubnetId='string'
)
[REQUIRED]
The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.
[REQUIRED]
The ID of your subnet.
dict
Response Syntax
{
'Ipv6CidrBlockAssociation': {
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
'SubnetId': 'string'
}
Response Structure
(dict) --
Ipv6CidrBlockAssociation (dict) --
Information about the IPv6 CIDR block association.
AssociationId (string) --
The association ID for the CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of a CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
SubnetId (string) --
The ID of the subnet.
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
See also: AWS API Documentation
Request Syntax
response = client.associate_transit_gateway_multicast_domain(
TransitGatewayMulticastDomainId='string',
TransitGatewayAttachmentId='string',
SubnetIds=[
'string',
],
DryRun=True|False
)
The IDs of the subnets to associate with the transit gateway multicast domain.
dict
Response Syntax
{
'Associations': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceOwnerId': 'string',
'Subnets': [
{
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
},
]
}
}
Response Structure
(dict) --
Associations (dict) --
Information about the transit gateway multicast domain associations.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the AWS account that owns the resource.
Subnets (list) --
The subnets associated with the multicast domain.
(dict) --
Describes the subnet association with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
See also: AWS API Documentation
Request Syntax
response = client.associate_transit_gateway_route_table(
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'Association': {
'TransitGatewayRouteTableId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
}
}
Response Structure
(dict) --
Association (dict) --
The ID of the association.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the association.
Associates a branch network interface with a trunk network interface.
Before you create the association, run the create-network-interface command and set --interface-type to trunk . You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
For more information, see Network interface trunking in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_trunk_interface(
BranchInterfaceId='string',
TrunkInterfaceId='string',
VlanId=123,
GreKey=123,
ClientToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the branch network interface.
[REQUIRED]
The ID of the trunk network interface.
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
{
'InterfaceAssociation': {
'AssociationId': 'string',
'BranchInterfaceId': 'string',
'TrunkInterfaceId': 'string',
'InterfaceProtocol': 'VLAN'|'GRE',
'VlanId': 123,
'GreKey': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
InterfaceAssociation (dict) --
Information about the association between the trunk network interface and branch network interface.
AssociationId (string) --
The ID of the association.
BranchInterfaceId (string) --
The ID of the branch network interface.
TrunkInterfaceId (string) --
The ID of the trunk network interface.
InterfaceProtocol (string) --
The interface protocol. Valid values are VLAN and GRE .
VlanId (integer) --
The ID of the VLAN when you use the VLAN protocol.
GreKey (integer) --
The application key when you use the GRE protocol.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP ). The IPv6 CIDR block size is fixed at /56.
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_vpc_cidr_block(
AmazonProvidedIpv6CidrBlock=True|False,
CidrBlock='string',
VpcId='string',
Ipv6CidrBlockNetworkBorderGroup='string',
Ipv6Pool='string',
Ipv6CidrBlock='string'
)
[REQUIRED]
The ID of the VPC.
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
You can have one IPv6 CIDR block association per network border group.
An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
dict
Response Syntax
{
'Ipv6CidrBlockAssociation': {
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string'
},
'CidrBlockAssociation': {
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
'VpcId': 'string'
}
Response Structure
(dict) --
Ipv6CidrBlockAssociation (dict) --
Information about the IPv6 CIDR block association.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1 .
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
CidrBlockAssociation (dict) --
Information about the IPv4 CIDR block association.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
VpcId (string) --
The ID of the VPC.
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
See also: AWS API Documentation
Request Syntax
response = client.attach_classic_link_vpc(
DryRun=True|False,
Groups=[
'string',
],
InstanceId='string',
VpcId='string'
)
[REQUIRED]
The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
[REQUIRED]
The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
[REQUIRED]
The ID of a ClassicLink-enabled VPC.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.attach_internet_gateway(
DryRun=True|False,
InternetGatewayId='string',
VpcId='string'
)
[REQUIRED]
The ID of the internet gateway.
[REQUIRED]
The ID of the VPC.
None
Examples
This example attaches the specified Internet gateway to the specified VPC.
response = client.attach_internet_gateway(
InternetGatewayId='igw-c0a643a9',
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Attaches a network interface to an instance.
See also: AWS API Documentation
Request Syntax
response = client.attach_network_interface(
DeviceIndex=123,
DryRun=True|False,
InstanceId='string',
NetworkInterfaceId='string',
NetworkCardIndex=123
)
[REQUIRED]
The index of the device for the network interface attachment.
[REQUIRED]
The ID of the instance.
[REQUIRED]
The ID of the network interface.
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.
Examples
This example attaches the specified network interface to the specified instance.
response = client.attach_network_interface(
DeviceIndex=1,
InstanceId='i-1234567890abcdef0',
NetworkInterfaceId='eni-e5aa89a3',
)
print(response)
Expected Output:
{
'AttachmentId': 'eni-attach-66c4350a',
'ResponseMetadata': {
'...': '...',
},
}
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use .
If a volume has an AWS Marketplace product code:
For more information, see Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.attach_volume(
Device='string',
InstanceId='string',
VolumeId='string',
DryRun=True|False
)
[REQUIRED]
The device name (for example, /dev/sdh or xvdh ).
[REQUIRED]
The ID of the instance.
[REQUIRED]
The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
dict
Response Syntax
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
}
Response Structure
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Examples
This example attaches a volume (vol-1234567890abcdef0) to an instance (i-01474ef662b89480) as /dev/sdf.
response = client.attach_volume(
Device='/dev/sdf',
InstanceId='i-01474ef662b89480',
VolumeId='vol-1234567890abcdef0',
)
print(response)
Expected Output:
{
'AttachTime': datetime(2016, 8, 29, 18, 52, 32, 0, 242, 0),
'Device': '/dev/sdf',
'InstanceId': 'i-01474ef662b89480',
'State': 'attaching',
'VolumeId': 'vol-1234567890abcdef0',
'ResponseMetadata': {
'...': '...',
},
}
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
response = client.attach_vpn_gateway(
VpcId='string',
VpnGatewayId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the VPC.
[REQUIRED]
The ID of the virtual private gateway.
dict
Response Syntax
{
'VpcAttachment': {
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
}
}
Response Structure
(dict) --
Contains the output of AttachVpnGateway.
VpcAttachment (dict) --
Information about the attachment.
State (string) --
The current state of the attachment.
VpcId (string) --
The ID of the VPC.
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.
See also: AWS API Documentation
Request Syntax
response = client.authorize_client_vpn_ingress(
ClientVpnEndpointId='string',
TargetNetworkCidr='string',
AccessGroupId='string',
AuthorizeAllGroups=True|False,
Description='string',
ClientToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint.
[REQUIRED]
The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
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
{
'Status': {
'Code': 'authorizing'|'active'|'failed'|'revoking',
'Message': 'string'
}
}
Response Structure
(dict) --
Status (dict) --
The current state of the authorization rule.
Code (string) --
The state of the authorization rule.
Message (string) --
A message about the status of the authorization rule, if applicable.
[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas .
See also: AWS API Documentation
Request Syntax
response = client.authorize_security_group_egress(
DryRun=True|False,
GroupId='string',
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
CidrIp='string',
FromPort=123,
IpProtocol='string',
ToPort=123,
SourceSecurityGroupName='string',
SourceSecurityGroupOwnerId='string'
)
[REQUIRED]
The ID of the security group.
The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The tags applied to the security group rule.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Return': True|False,
'SecurityGroupRules': [
{
'SecurityGroupRuleId': 'string',
'GroupId': 'string',
'GroupOwnerId': 'string',
'IsEgress': True|False,
'IpProtocol': 'string',
'FromPort': 123,
'ToPort': 123,
'CidrIpv4': 'string',
'CidrIpv6': 'string',
'PrefixListId': 'string',
'ReferencedGroupInfo': {
'GroupId': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
SecurityGroupRules (list) --
Information about the outbound (egress) security group rules that were added.
(dict) --
Describes a security group rule.
SecurityGroupRuleId (string) --
The ID of the security group rule.
GroupId (string) --
The ID of the security group.
GroupOwnerId (string) --
The ID of the account that owns the security group.
IsEgress (boolean) --
Indicates whether the security group rule is an outbound rule.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
Use -1 to specify all protocols.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
CidrIpv4 (string) --
The IPv4 CIDR range.
CidrIpv6 (string) --
The IPv6 CIDR range.
PrefixListId (string) --
The ID of the prefix list.
ReferencedGroupInfo (dict) --
Describes the security group that is referenced in the rule.
GroupId (string) --
The ID of the security group.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The account ID.
VpcId (string) --
The ID of the VPC.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Description (string) --
The security group rule description.
Tags (list) --
The tags applied to the security group rule.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example adds a rule that grants access to the specified address ranges on TCP port 80.
response = client.authorize_security_group_egress(
GroupId='sg-1a2b3c4d',
IpPermissions=[
{
'FromPort': 80,
'IpProtocol': 'tcp',
'IpRanges': [
{
'CidrIp': '10.0.0.0/16',
},
],
'ToPort': 80,
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example adds a rule that grants access to the specified security group on TCP port 80.
response = client.authorize_security_group_egress(
GroupId='sg-1a2b3c4d',
IpPermissions=[
{
'FromPort': 80,
'IpProtocol': 'tcp',
'ToPort': 80,
'UserIdGroupPairs': [
{
'GroupId': 'sg-4b51a32f',
},
],
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group quotas, see Amazon VPC quotas .
See also: AWS API Documentation
Request Syntax
response = client.authorize_security_group_ingress(
CidrIp='string',
FromPort=123,
GroupId='string',
GroupName='string',
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
IpProtocol='string',
SourceSecurityGroupName='string',
SourceSecurityGroupOwnerId='string',
ToPort=123,
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
The sets of IP permissions.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The IP protocol name (tcp , udp , icmp ) or number (see Protocol Numbers ). To specify icmpv6 , use a set of IP permissions.
[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp , udp , or icmp , traffic on all ports is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
[VPC Only] The tags applied to the security group rule.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Return': True|False,
'SecurityGroupRules': [
{
'SecurityGroupRuleId': 'string',
'GroupId': 'string',
'GroupOwnerId': 'string',
'IsEgress': True|False,
'IpProtocol': 'string',
'FromPort': 123,
'ToPort': 123,
'CidrIpv4': 'string',
'CidrIpv6': 'string',
'PrefixListId': 'string',
'ReferencedGroupInfo': {
'GroupId': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
SecurityGroupRules (list) --
Information about the inbound (ingress) security group rules that were added.
(dict) --
Describes a security group rule.
SecurityGroupRuleId (string) --
The ID of the security group rule.
GroupId (string) --
The ID of the security group.
GroupOwnerId (string) --
The ID of the account that owns the security group.
IsEgress (boolean) --
Indicates whether the security group rule is an outbound rule.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
Use -1 to specify all protocols.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
CidrIpv4 (string) --
The IPv4 CIDR range.
CidrIpv6 (string) --
The IPv6 CIDR range.
PrefixListId (string) --
The ID of the prefix list.
ReferencedGroupInfo (dict) --
Describes the security group that is referenced in the rule.
GroupId (string) --
The ID of the security group.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The account ID.
VpcId (string) --
The ID of the VPC.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Description (string) --
The security group rule description.
Tags (list) --
The tags applied to the security group rule.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later.
response = client.authorize_security_group_ingress(
GroupId='sg-903004f8',
IpPermissions=[
{
'FromPort': 22,
'IpProtocol': 'tcp',
'IpRanges': [
{
'CidrIp': '203.0.113.0/24',
'Description': 'SSH access from the LA office',
},
],
'ToPort': 22,
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group.
response = client.authorize_security_group_ingress(
GroupId='sg-111aaa22',
IpPermissions=[
{
'FromPort': 80,
'IpProtocol': 'tcp',
'ToPort': 80,
'UserIdGroupPairs': [
{
'Description': 'HTTP access from other instances',
'GroupId': 'sg-1a2b3c4d',
},
],
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later.
response = client.authorize_security_group_ingress(
GroupId='sg-123abc12 ',
IpPermissions=[
{
'FromPort': 3389,
'IpProtocol': 'tcp',
'Ipv6Ranges': [
{
'CidrIpv6': '2001:db8:1234:1a00::/64',
'Description': 'RDP access from the NY office',
},
],
'ToPort': 3389,
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:) is bundled. Data on other instance store volumes is not preserved.
Note
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
See also: AWS API Documentation
Request Syntax
response = client.bundle_instance(
InstanceId='string',
Storage={
'S3': {
'AWSAccessKeyId': 'string',
'Bucket': 'string',
'Prefix': 'string',
'UploadPolicy': b'bytes',
'UploadPolicySignature': 'string'
}
},
DryRun=True|False
)
[REQUIRED]
The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
[REQUIRED]
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
An Amazon S3 storage location.
The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys .
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
The beginning of the file name of the AMI.
An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
The signature of the JSON document.
dict
Response Syntax
{
'BundleTask': {
'BundleId': 'string',
'BundleTaskError': {
'Code': 'string',
'Message': 'string'
},
'InstanceId': 'string',
'Progress': 'string',
'StartTime': datetime(2015, 1, 1),
'State': 'pending'|'waiting-for-shutdown'|'bundling'|'storing'|'cancelling'|'complete'|'failed',
'Storage': {
'S3': {
'AWSAccessKeyId': 'string',
'Bucket': 'string',
'Prefix': 'string',
'UploadPolicy': b'bytes',
'UploadPolicySignature': 'string'
}
},
'UpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Contains the output of BundleInstance.
BundleTask (dict) --
Information about the bundle task.
BundleId (string) --
The ID of the bundle task.
BundleTaskError (dict) --
If the task fails, a description of the error.
Code (string) --
The error code.
Message (string) --
The error message.
InstanceId (string) --
The ID of the instance associated with this bundle task.
Progress (string) --
The level of task completion, as a percent (for example, 20%).
StartTime (datetime) --
The time this task started.
State (string) --
The state of the task.
Storage (dict) --
The Amazon S3 storage locations.
S3 (dict) --
An Amazon S3 storage location.
AWSAccessKeyId (string) --
The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys .
Bucket (string) --
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
Prefix (string) --
The beginning of the file name of the AMI.
UploadPolicy (bytes) --
An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
UploadPolicySignature (string) --
The signature of the JSON document.
UpdateTime (datetime) --
The time of the most recent update for the task.
Check if an operation can be paginated.
Cancels a bundling operation for an instance store-backed Windows instance.
See also: AWS API Documentation
Request Syntax
response = client.cancel_bundle_task(
BundleId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the bundle task.
dict
Response Syntax
{
'BundleTask': {
'BundleId': 'string',
'BundleTaskError': {
'Code': 'string',
'Message': 'string'
},
'InstanceId': 'string',
'Progress': 'string',
'StartTime': datetime(2015, 1, 1),
'State': 'pending'|'waiting-for-shutdown'|'bundling'|'storing'|'cancelling'|'complete'|'failed',
'Storage': {
'S3': {
'AWSAccessKeyId': 'string',
'Bucket': 'string',
'Prefix': 'string',
'UploadPolicy': b'bytes',
'UploadPolicySignature': 'string'
}
},
'UpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Contains the output of CancelBundleTask.
BundleTask (dict) --
Information about the bundle task.
BundleId (string) --
The ID of the bundle task.
BundleTaskError (dict) --
If the task fails, a description of the error.
Code (string) --
The error code.
Message (string) --
The error message.
InstanceId (string) --
The ID of the instance associated with this bundle task.
Progress (string) --
The level of task completion, as a percent (for example, 20%).
StartTime (datetime) --
The time this task started.
State (string) --
The state of the task.
Storage (dict) --
The Amazon S3 storage locations.
S3 (dict) --
An Amazon S3 storage location.
AWSAccessKeyId (string) --
The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys .
Bucket (string) --
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
Prefix (string) --
The beginning of the file name of the AMI.
UploadPolicy (bytes) --
An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
UploadPolicySignature (string) --
The signature of the JSON document.
UpdateTime (datetime) --
The time of the most recent update for the task.
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled .
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
See also: AWS API Documentation
Request Syntax
response = client.cancel_capacity_reservation(
CapacityReservationId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Capacity Reservation to be cancelled.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI .
See also: AWS API Documentation
Request Syntax
response = client.cancel_conversion_task(
ConversionTaskId='string',
DryRun=True|False,
ReasonMessage='string'
)
[REQUIRED]
The ID of the conversion task.
None
Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
See also: AWS API Documentation
Request Syntax
response = client.cancel_export_task(
ExportTaskId='string'
)
[REQUIRED]
The ID of the export task. This is the ID returned by CreateInstanceExportTask .
Cancels an in-process import virtual machine or import snapshot task.
See also: AWS API Documentation
Request Syntax
response = client.cancel_import_task(
CancelReason='string',
DryRun=True|False,
ImportTaskId='string'
)
dict
Response Syntax
{
'ImportTaskId': 'string',
'PreviousState': 'string',
'State': 'string'
}
Response Structure
(dict) --
ImportTaskId (string) --
The ID of the task being canceled.
PreviousState (string) --
The current state of the task being canceled.
State (string) --
The current state of the task being canceled.
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.cancel_reserved_instances_listing(
ReservedInstancesListingId='string'
)
[REQUIRED]
The ID of the Reserved Instance listing.
{
'ReservedInstancesListings': [
{
'ClientToken': 'string',
'CreateDate': datetime(2015, 1, 1),
'InstanceCounts': [
{
'InstanceCount': 123,
'State': 'available'|'sold'|'cancelled'|'pending'
},
],
'PriceSchedules': [
{
'Active': True|False,
'CurrencyCode': 'USD',
'Price': 123.0,
'Term': 123
},
],
'ReservedInstancesId': 'string',
'ReservedInstancesListingId': 'string',
'Status': 'active'|'pending'|'cancelled'|'closed',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'UpdateDate': datetime(2015, 1, 1)
},
]
}
Response Structure
Contains the output of CancelReservedInstancesListing.
The Reserved Instance listing.
Describes a Reserved Instance listing.
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency .
The time the listing was created.
The number of instances in this state.
Describes a Reserved Instance listing state.
The number of listed Reserved Instances in the state specified by the state .
The states of the listed Reserved Instances.
The price of the Reserved Instance listing.
Describes the price for a Reserved Instance.
The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD .
The fixed price for the term.
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
The ID of the Reserved Instance.
The ID of the Reserved Instance listing.
The status of the Reserved Instance listing.
The reason for the current status of the Reserved Instance listing. The response can be blank.
Any tags assigned to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The last modified timestamp of the listing.
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
See also: AWS API Documentation
Request Syntax
response = client.cancel_spot_fleet_requests(
DryRun=True|False,
SpotFleetRequestIds=[
'string',
],
TerminateInstances=True|False
)
[REQUIRED]
The IDs of the Spot Fleet requests.
[REQUIRED]
Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
dict
Response Syntax
{
'SuccessfulFleetRequests': [
{
'CurrentSpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying',
'PreviousSpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying',
'SpotFleetRequestId': 'string'
},
],
'UnsuccessfulFleetRequests': [
{
'Error': {
'Code': 'fleetRequestIdDoesNotExist'|'fleetRequestIdMalformed'|'fleetRequestNotInCancellableState'|'unexpectedError',
'Message': 'string'
},
'SpotFleetRequestId': 'string'
},
]
}
Response Structure
(dict) --
Contains the output of CancelSpotFleetRequests.
SuccessfulFleetRequests (list) --
Information about the Spot Fleet requests that are successfully canceled.
(dict) --
Describes a Spot Fleet request that was successfully canceled.
CurrentSpotFleetRequestState (string) --
The current state of the Spot Fleet request.
PreviousSpotFleetRequestState (string) --
The previous state of the Spot Fleet request.
SpotFleetRequestId (string) --
The ID of the Spot Fleet request.
UnsuccessfulFleetRequests (list) --
Information about the Spot Fleet requests that are not successfully canceled.
(dict) --
Describes a Spot Fleet request that was not successfully canceled.
Error (dict) --
The error.
Code (string) --
The error code.
Message (string) --
The description for the error code.
SpotFleetRequestId (string) --
The ID of the Spot Fleet request.
Examples
This example cancels the specified Spot fleet request and terminates its associated Spot Instances.
response = client.cancel_spot_fleet_requests(
SpotFleetRequestIds=[
'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
],
TerminateInstances=True,
)
print(response)
Expected Output:
{
'SuccessfulFleetRequests': [
{
'CurrentSpotFleetRequestState': 'cancelled_running',
'PreviousSpotFleetRequestState': 'active',
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example cancels the specified Spot fleet request without terminating its associated Spot Instances.
response = client.cancel_spot_fleet_requests(
SpotFleetRequestIds=[
'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
],
TerminateInstances=False,
)
print(response)
Expected Output:
{
'SuccessfulFleetRequests': [
{
'CurrentSpotFleetRequestState': 'cancelled_terminating',
'PreviousSpotFleetRequestState': 'active',
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Cancels one or more Spot Instance requests.
Warning
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
See also: AWS API Documentation
Request Syntax
response = client.cancel_spot_instance_requests(
DryRun=True|False,
SpotInstanceRequestIds=[
'string',
]
)
[REQUIRED]
One or more Spot Instance request IDs.
dict
Response Syntax
{
'CancelledSpotInstanceRequests': [
{
'SpotInstanceRequestId': 'string',
'State': 'active'|'open'|'closed'|'cancelled'|'completed'
},
]
}
Response Structure
(dict) --
Contains the output of CancelSpotInstanceRequests.
CancelledSpotInstanceRequests (list) --
One or more Spot Instance requests.
(dict) --
Describes a request to cancel a Spot Instance.
SpotInstanceRequestId (string) --
The ID of the Spot Instance request.
State (string) --
The state of the Spot Instance request.
Examples
This example cancels a Spot Instance request.
response = client.cancel_spot_instance_requests(
SpotInstanceRequestIds=[
'sir-08b93456',
],
)
print(response)
Expected Output:
{
'CancelledSpotInstanceRequests': [
{
'SpotInstanceRequestId': 'sir-08b93456',
'State': 'cancelled',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
See also: AWS API Documentation
Request Syntax
response = client.confirm_product_instance(
InstanceId='string',
ProductCode='string',
DryRun=True|False
)
[REQUIRED]
The ID of the instance.
[REQUIRED]
The product code. This must be a product code that you own.
dict
Response Syntax
{
'OwnerId': 'string',
'Return': True|False
}
Response Structure
(dict) --
OwnerId (string) --
The account ID of the instance owner. This is only present if the product code is attached to the instance.
Return (boolean) --
The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
Examples
This example determines whether the specified product code is associated with the specified instance.
response = client.confirm_product_instance(
InstanceId='i-1234567890abcdef0',
ProductCode='774F4FF8',
)
print(response)
Expected Output:
{
'OwnerId': '123456789012',
'ResponseMetadata': {
'...': '...',
},
}
Copies the specified Amazon FPGA Image (AFI) to the current Region.
See also: AWS API Documentation
Request Syntax
response = client.copy_fpga_image(
DryRun=True|False,
SourceFpgaImageId='string',
Description='string',
Name='string',
SourceRegion='string',
ClientToken='string'
)
[REQUIRED]
The ID of the source AFI.
[REQUIRED]
The Region that contains the source AFI.
dict
Response Syntax
{
'FpgaImageId': 'string'
}
Response Structure
(dict) --
FpgaImageId (string) --
The ID of the new AFI.
Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an AWS Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask .
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn . Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId . Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide .
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.copy_image(
ClientToken='string',
Description='string',
Encrypted=True|False,
KmsKeyId='string',
Name='string',
SourceImageId='string',
SourceRegion='string',
DestinationOutpostArn='string',
DryRun=True|False
)
The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true .
You can specify a CMK using any of the following:
AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified CMK must exist in the destination Region.
Amazon EBS does not support asymmetric CMKs.
[REQUIRED]
The name of the new AMI in the destination Region.
[REQUIRED]
The ID of the AMI to copy.
[REQUIRED]
The name of the Region that contains the AMI to copy.
The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an AWS Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide .
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
Contains the output of CopyImage.
ImageId (string) --
The ID of the new AMI.
Examples
This example copies the specified AMI from the us-east-1 region to the current region.
response = client.copy_image(
Description='',
Name='My server',
SourceImageId='ami-5731123e',
SourceRegion='us-east-1',
)
print(response)
Expected Output:
{
'ImageId': 'ami-438bea42',
'ResponseMetadata': {
'...': '...',
},
}
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId . Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide .
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.copy_snapshot(
Description='string',
DestinationOutpostArn='string',
Encrypted=True|False,
KmsKeyId='string',
SourceRegion='string',
SourceSnapshotId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an AWS Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying snapshots from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide .
The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com ). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true .
You can specify the CMK using any of the following:
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests .
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion , SourceSnapshotId , and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference . An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
[REQUIRED]
The ID of the Region that contains the snapshot to be copied.
[REQUIRED]
The ID of the EBS snapshot to copy.
The tags to apply to the new snapshot.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'SnapshotId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
SnapshotId (string) --
The ID of the new snapshot.
Tags (list) --
Any tags applied to the new snapshot.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example copies a snapshot with the snapshot ID of snap-066877671789bd71b from the us-west-2 region to the us-east-1 region and adds a short description to identify the snapshot.
response = client.copy_snapshot(
Description='This is my copied snapshot.',
DestinationRegion='us-east-1',
SourceRegion='us-west-2',
SourceSnapshotId='snap-066877671789bd71b',
)
print(response)
Expected Output:
{
'SnapshotId': 'snap-066877671789bd71b',
'ResponseMetadata': {
'...': '...',
},
}
Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide .
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_capacity_reservation(
ClientToken='string',
InstanceType='string',
InstancePlatform='Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
AvailabilityZone='string',
AvailabilityZoneId='string',
Tenancy='default'|'dedicated',
InstanceCount=123,
EbsOptimized=True|False,
EphemeralStorage=True|False,
EndDate=datetime(2015, 1, 1),
EndDateType='unlimited'|'limited',
InstanceMatchCriteria='open'|'targeted',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
OutpostArn='string'
)
[REQUIRED]
The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide .
[REQUIRED]
The type of operating system for which to reserve capacity.
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
[REQUIRED]
The number of instances for which to reserve capacity.
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited . Omit EndDate if EndDateType is unlimited .
If the EndDateType is limited , the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
Default: open
The tags to apply to the Capacity Reservation during launch.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'CapacityReservation': {
'CapacityReservationId': 'string',
'OwnerId': 'string',
'CapacityReservationArn': 'string',
'AvailabilityZoneId': 'string',
'InstanceType': 'string',
'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
'AvailabilityZone': 'string',
'Tenancy': 'default'|'dedicated',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'EbsOptimized': True|False,
'EphemeralStorage': True|False,
'State': 'active'|'expired'|'cancelled'|'pending'|'failed',
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'EndDateType': 'unlimited'|'limited',
'InstanceMatchCriteria': 'open'|'targeted',
'CreateDate': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OutpostArn': 'string'
}
}
Response Structure
(dict) --
CapacityReservation (dict) --
Information about the Capacity Reservation.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
OwnerId (string) --
The ID of the account that owns the Capacity Reservation.
CapacityReservationArn (string) --
The Amazon Resource Name (ARN) of the Capacity Reservation.
AvailabilityZoneId (string) --
The Availability Zone ID of the Capacity Reservation.
InstanceType (string) --
The type of instance for which the Capacity Reservation reserves capacity.
InstancePlatform (string) --
The type of operating system for which the Capacity Reservation reserves capacity.
AvailabilityZone (string) --
The Availability Zone in which the capacity is reserved.
Tenancy (string) --
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
TotalInstanceCount (integer) --
The total number of instances for which the Capacity Reservation reserves capacity.
AvailableInstanceCount (integer) --
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
EbsOptimized (boolean) --
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
EphemeralStorage (boolean) --
Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
State (string) --
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
StartDate (datetime) --
The date and time at which the Capacity Reservation was started.
EndDate (datetime) --
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
EndDateType (string) --
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
InstanceMatchCriteria (string) --
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
CreateDate (datetime) --
The date and time at which the Capacity Reservation was created.
Tags (list) --
Any tags assigned to the Capacity Reservation.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_carrier_gateway(
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
ClientToken='string'
)
[REQUIRED]
The ID of the VPC to associate with the carrier gateway.
The tags to associate with the carrier gateway.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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
{
'CarrierGateway': {
'CarrierGatewayId': 'string',
'VpcId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
CarrierGateway (dict) --
Information about the carrier gateway.
CarrierGatewayId (string) --
The ID of the carrier gateway.
VpcId (string) --
The ID of the VPC associated with the carrier gateway.
State (string) --
The state of the carrier gateway.
OwnerId (string) --
The AWS account ID of the owner of the carrier gateway.
Tags (list) --
The tags assigned to the carrier gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
See also: AWS API Documentation
Request Syntax
response = client.create_client_vpn_endpoint(
ClientCidrBlock='string',
ServerCertificateArn='string',
AuthenticationOptions=[
{
'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication',
'ActiveDirectory': {
'DirectoryId': 'string'
},
'MutualAuthentication': {
'ClientRootCertificateChainArn': 'string'
},
'FederatedAuthentication': {
'SAMLProviderArn': 'string',
'SelfServiceSAMLProviderArn': 'string'
}
},
],
ConnectionLogOptions={
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string'
},
DnsServers=[
'string',
],
TransportProtocol='tcp'|'udp',
VpnPort=123,
Description='string',
SplitTunnel=True|False,
DryRun=True|False,
ClientToken='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
SecurityGroupIds=[
'string',
],
VpcId='string',
SelfServicePortal='enabled'|'disabled',
ClientConnectOptions={
'Enabled': True|False,
'LambdaFunctionArn': 'string'
}
)
[REQUIRED]
The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.
[REQUIRED]
The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide .
[REQUIRED]
Information about the authentication method to be used to authenticate clients.
Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the AWS Client VPN Administrator Guide .
The type of client authentication to be used.
Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication .
The ID of the Active Directory to be used for authentication.
Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication .
The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).
Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication .
The Amazon Resource Name (ARN) of the IAM SAML identity provider.
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
[REQUIRED]
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Indicates whether connection logging is enabled.
The name of the CloudWatch Logs log group. Required if connection logging is enabled.
The name of the CloudWatch Logs log stream to which the connection data is published.
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
The transport protocol to be used by the VPN session.
Default value: udp
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide .
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.
The tags to apply to the Client VPN endpoint during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
The options for managing connection authorization for new client connections.
Indicates whether client connect options are enabled. The default is false (not enabled).
The Amazon Resource Name (ARN) of the AWS Lambda function used for connection authorization.
dict
Response Syntax
{
'ClientVpnEndpointId': 'string',
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted',
'Message': 'string'
},
'DnsName': 'string'
}
Response Structure
(dict) --
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
Message (string) --
A message about the status of the Client VPN endpoint.
DnsName (string) --
The DNS name to be used by clients when establishing their VPN session.
Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
See also: AWS API Documentation
Request Syntax
response = client.create_client_vpn_route(
ClientVpnEndpointId='string',
DestinationCidrBlock='string',
TargetVpcSubnetId='string',
Description='string',
ClientToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint to which to add the route.
[REQUIRED]
The IPv4 address range, in CIDR notation, of the route destination. For example:
[REQUIRED]
The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you're adding a route for the local network, specify local .
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
{
'Status': {
'Code': 'creating'|'active'|'failed'|'deleting',
'Message': 'string'
}
}
Response Structure
(dict) --
Status (dict) --
The current state of the route.
Code (string) --
The state of the Client VPN endpoint route.
Message (string) --
A message about the status of the Client VPN endpoint route, if applicable.
Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
Note
Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with the exception of the following:
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
Warning
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. Identical requests return information about the existing customer gateway and do not create new customer gateways.
See also: AWS API Documentation
Request Syntax
response = client.create_customer_gateway(
BgpAsn=123,
PublicIp='string',
CertificateArn='string',
Type='ipsec.1',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DeviceName='string',
DryRun=True|False
)
[REQUIRED]
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
[REQUIRED]
The type of VPN connection that this customer gateway supports (ipsec.1 ).
The tags to apply to the customer gateway.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
dict
Response Syntax
{
'CustomerGateway': {
'BgpAsn': 'string',
'CustomerGatewayId': 'string',
'IpAddress': 'string',
'CertificateArn': 'string',
'State': 'string',
'Type': 'string',
'DeviceName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Contains the output of CreateCustomerGateway.
CustomerGateway (dict) --
Information about the customer gateway.
BgpAsn (string) --
The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
CustomerGatewayId (string) --
The ID of the customer gateway.
IpAddress (string) --
The Internet-routable IP address of the customer gateway's outside interface.
CertificateArn (string) --
The Amazon Resource Name (ARN) for the customer gateway certificate.
State (string) --
The current state of the customer gateway (pending | available | deleting | deleted ).
Type (string) --
The type of VPN connection the customer gateway supports (ipsec.1 ).
DeviceName (string) --
The name of customer gateway device.
Tags (list) --
Any tags assigned to the customer gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example creates a customer gateway with the specified IP address for its outside interface.
response = client.create_customer_gateway(
BgpAsn=65534,
PublicIp='12.1.2.3',
Type='ipsec.1',
)
print(response)
Expected Output:
{
'CustomerGateway': {
'BgpAsn': '65534',
'CustomerGatewayId': 'cgw-0e11f167',
'IpAddress': '12.1.2.3',
'State': 'available',
'Type': 'ipsec.1',
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_default_subnet(
AvailabilityZone='string',
DryRun=True|False
)
[REQUIRED]
The Availability Zone in which to create the default subnet.
dict
Response Syntax
{
'Subnet': {
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'AvailableIpAddressCount': 123,
'CidrBlock': 'string',
'DefaultForAz': True|False,
'MapPublicIpOnLaunch': True|False,
'MapCustomerOwnedIpOnLaunch': True|False,
'CustomerOwnedIpv4Pool': 'string',
'State': 'pending'|'available',
'SubnetId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'AssignIpv6AddressOnCreation': True|False,
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SubnetArn': 'string',
'OutpostArn': 'string'
}
}
Response Structure
(dict) --
Subnet (dict) --
Information about the subnet.
AvailabilityZone (string) --
The Availability Zone of the subnet.
AvailabilityZoneId (string) --
The AZ ID of the subnet.
AvailableIpAddressCount (integer) --
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
CidrBlock (string) --
The IPv4 CIDR block assigned to the subnet.
DefaultForAz (boolean) --
Indicates whether this is the default subnet for the Availability Zone.
MapPublicIpOnLaunch (boolean) --
Indicates whether instances launched in this subnet receive a public IPv4 address.
MapCustomerOwnedIpOnLaunch (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives a customer-owned IPv4 address.
CustomerOwnedIpv4Pool (string) --
The customer-owned IPv4 address pool associated with the subnet.
State (string) --
The current state of the subnet.
SubnetId (string) --
The ID of the subnet.
VpcId (string) --
The ID of the VPC the subnet is in.
OwnerId (string) --
The ID of the AWS account that owns the subnet.
AssignIpv6AddressOnCreation (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives an IPv6 address.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the subnet.
(dict) --
Describes an IPv6 CIDR block associated with a subnet.
AssociationId (string) --
The association ID for the CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of a CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
Tags (list) --
Any tags assigned to the subnet.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in the Amazon Virtual Private Cloud User Guide . You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ .
See also: AWS API Documentation
Request Syntax
response = client.create_default_vpc(
DryRun=True|False
)
{
'Vpc': {
'CidrBlock': 'string',
'DhcpOptionsId': 'string',
'State': 'pending'|'available',
'VpcId': 'string',
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
Information about the VPC.
The primary IPv4 CIDR block for the VPC.
The ID of the set of DHCP options you've associated with the VPC.
The current state of the VPC.
The ID of the VPC.
The ID of the AWS account that owns the VPC.
The allowed tenancy of instances launched into the VPC.
Information about the IPv6 CIDR blocks associated with the VPC.
Describes an IPv6 CIDR block associated with a VPC.
The association ID for the IPv6 CIDR block.
The IPv6 CIDR block.
Information about the state of the CIDR block.
The state of the CIDR block.
A message about the status of the CIDR block, if applicable.
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1 .
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
Information about the IPv4 CIDR blocks associated with the VPC.
Describes an IPv4 CIDR block associated with a VPC.
The association ID for the IPv4 CIDR block.
The IPv4 CIDR block.
Information about the state of the CIDR block.
The state of the CIDR block.
A message about the status of the CIDR block, if applicable.
Indicates whether the VPC is the default VPC.
Any tags assigned to the VPC.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132 .
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_dhcp_options(
DhcpConfigurations=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
A DHCP configuration option.
The tags to assign to the DHCP option.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'DhcpOptions': {
'DhcpConfigurations': [
{
'Key': 'string',
'Values': [
{
'Value': 'string'
},
]
},
],
'DhcpOptionsId': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
DhcpOptions (dict) --
A set of DHCP options.
DhcpConfigurations (list) --
One or more DHCP options in the set.
(dict) --
Describes a DHCP configuration option.
Key (string) --
The name of a DHCP option.
Values (list) --
One or more values for the DHCP option.
(dict) --
Describes a value for a resource attribute that is a String.
Value (string) --
The attribute value. The value is case-sensitive.
DhcpOptionsId (string) --
The ID of the set of DHCP options.
OwnerId (string) --
The ID of the AWS account that owns the DHCP options set.
Tags (list) --
Any tags assigned to the DHCP options set.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example creates a DHCP options set.
response = client.create_dhcp_options(
DhcpConfigurations=[
{
'Key': 'domain-name-servers',
'Values': [
'10.2.5.1',
'10.2.5.2',
],
},
],
)
print(response)
Expected Output:
{
'DhcpOptions': {
'DhcpConfigurations': [
{
'Key': 'domain-name-servers',
'Values': [
{
'Value': '10.2.5.2',
},
{
'Value': '10.2.5.1',
},
],
},
],
'DhcpOptionsId': 'dopt-d9070ebb',
},
'ResponseMetadata': {
'...': '...',
},
}
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
See also: AWS API Documentation
Request Syntax
response = client.create_egress_only_internet_gateway(
ClientToken='string',
DryRun=True|False,
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the VPC for which to create the egress-only internet gateway.
The tags to assign to the egress-only internet gateway.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ClientToken': 'string',
'EgressOnlyInternetGateway': {
'Attachments': [
{
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
},
],
'EgressOnlyInternetGatewayId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
EgressOnlyInternetGateway (dict) --
Information about the egress-only internet gateway.
Attachments (list) --
Information about the attachment of the egress-only internet gateway.
(dict) --
Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
State (string) --
The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
VpcId (string) --
The ID of the VPC.
EgressOnlyInternetGatewayId (string) --
The ID of the egress-only internet gateway.
Tags (list) --
The tags assigned to the egress-only internet gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_fleet(
DryRun=True|False,
ClientToken='string',
SpotOptions={
'AllocationStrategy': 'lowest-price'|'diversified'|'capacity-optimized'|'capacity-optimized-prioritized',
'MaintenanceStrategies': {
'CapacityRebalance': {
'ReplacementStrategy': 'launch'
}
},
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
'InstancePoolsToUseCount': 123,
'SingleInstanceType': True|False,
'SingleAvailabilityZone': True|False,
'MinTargetCapacity': 123,
'MaxTotalPrice': 'string'
},
OnDemandOptions={
'AllocationStrategy': 'lowest-price'|'prioritized',
'CapacityReservationOptions': {
'UsageStrategy': 'use-capacity-reservations-first'
},
'SingleInstanceType': True|False,
'SingleAvailabilityZone': True|False,
'MinTargetCapacity': 123,
'MaxTotalPrice': 'string'
},
ExcessCapacityTerminationPolicy='no-termination'|'termination',
LaunchTemplateConfigs=[
{
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
}
},
]
},
],
TargetCapacitySpecification={
'TotalTargetCapacity': 123,
'OnDemandTargetCapacity': 123,
'SpotTargetCapacity': 123,
'DefaultTargetCapacityType': 'spot'|'on-demand'
},
TerminateInstancesWithExpiration=True|False,
Type='request'|'maintain'|'instant',
ValidFrom=datetime(2015, 1, 1),
ValidUntil=datetime(2015, 1, 1),
ReplaceUnhealthyInstances=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
Context='string'
)
Describes the configuration of Spot Instances in an EC2 Fleet.
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
If the allocation strategy is lowest-price , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified , EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
The replacement strategy to use. Only available for fleets of type maintain .
To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for an existing Spot Instance in the fleet, specify launch . You must specify a value, otherwise you get an error.
Note
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
The behavior when a Spot Instance is interrupted. The default is terminate .
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant .
Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant .
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
The maximum amount per hour for Spot Instances that you're willing to pay.
Describes the configuration of On-Demand Instances in an EC2 Fleet.
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price , EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price .
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type instant .
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized ).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported only for fleets of type instant .
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type instant .
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
The maximum amount per hour for On-Demand Instances that you're willing to pay.
[REQUIRED]
The configuration for the EC2 Fleet.
Describes a launch template and overrides.
The launch template to use. You must specify either the launch template ID or launch template name in the request.
The ID of the launch template. If you specify the template ID, you can't specify the template name.
The name of the launch template. If you specify the template name, you can't specify the template ID.
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Any parameters that you specify override the same parameters in the launch template.
For fleets of type request and maintain , a maximum of 300 items is allowed across all launch templates.
Describes overrides for a launch template.
The instance type.
The maximum price per unit hour that you are willing to pay for a Spot Instance.
The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2 ). A request of type instant can have only one subnet ID.
The Availability Zone in which to launch the instances.
The number of units provided by the specified instance type.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The location where the instance launched, if applicable.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The name of the placement group the instance is in.
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Reserved for future use.
This parameter is not supported by CreateFleet .
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
[REQUIRED]
The number of units to request.
The number of units to request, filled using DefaultTargetCapacityType .
The number of On-Demand units to request.
The number of Spot units to request.
The default TotalTargetCapacity , which is either Spot or On-Demand .
The fleet type. The default value is maintain .
For more information, see EC2 Fleet request types in the Amazon EC2 User Guide .
The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging your resources .
If the fleet type is instant , specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request , specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance . To tag instances at launch, specify the tags in a launch template .
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'FleetId': 'string',
'Errors': [
{
'LaunchTemplateAndOverrides': {
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': {
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'GroupName': 'string'
}
}
},
'Lifecycle': 'spot'|'on-demand',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'Instances': [
{
'LaunchTemplateAndOverrides': {
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': {
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'GroupName': 'string'
}
}
},
'Lifecycle': 'spot'|'on-demand',
'InstanceIds': [
'string',
],
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'Platform': 'Windows'
},
]
}
Response Structure
(dict) --
FleetId (string) --
The ID of the EC2 Fleet.
Errors (list) --
Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant .
(dict) --
Describes the instances that could not be launched by the fleet.
LaunchTemplateAndOverrides (dict) --
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (dict) --
Any parameters that you specify override the same parameters in the launch template.
InstanceType (string) --
The instance type.
MaxPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
Placement (dict) --
The location where the instance launched, if applicable.
GroupName (string) --
The name of the placement group that the instance is in.
Lifecycle (string) --
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
ErrorCode (string) --
The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes .
ErrorMessage (string) --
The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes .
Instances (list) --
Information about the instances that were launched by the fleet. Supported only for fleets of type instant .
(dict) --
Describes the instances that were launched by the fleet.
LaunchTemplateAndOverrides (dict) --
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (dict) --
Any parameters that you specify override the same parameters in the launch template.
InstanceType (string) --
The instance type.
MaxPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
Placement (dict) --
The location where the instance launched, if applicable.
GroupName (string) --
The name of the placement group that the instance is in.
Lifecycle (string) --
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
InstanceIds (list) --
The IDs of the instances.
InstanceType (string) --
The instance type.
Platform (string) --
The value is Windows for Windows instances. Otherwise, the value is blank.
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide .
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_flow_logs(
DryRun=True|False,
ClientToken='string',
DeliverLogsPermissionArn='string',
LogGroupName='string',
ResourceIds=[
'string',
],
ResourceType='VPC'|'Subnet'|'NetworkInterface',
TrafficType='ACCEPT'|'REJECT'|'ALL',
LogDestinationType='cloud-watch-logs'|'s3',
LogDestination='string',
LogFormat='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MaxAggregationInterval=123
)
The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
If you specify LogDestinationType as s3 , do not specify DeliverLogsPermissionArn or LogGroupName .
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify LogDestinationType as s3 , do not specify DeliverLogsPermissionArn or LogGroupName .
[REQUIRED]
The ID of the subnet, network interface, or VPC for which you want to create a flow log.
Constraints: Maximum of 1000 resources
[REQUIRED]
The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
[REQUIRED]
The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs . To publish flow log data to Amazon S3, specify s3 .
If you specify LogDestinationType as s3 , do not specify DeliverLogsPermissionArn or LogGroupName .
Default: cloud-watch-logs
Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType .
If LogDestinationType is not specified or cloud-watch-logs , specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs , specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs . Alternatively, use LogGroupName instead.
If LogDestinationType is s3 , specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/ . For example, to specify a subfolder named my-logs in a bucket named my-bucket , use the following ARN: arn:aws:s3:::my-bucket/my-logs/ . You cannot use AWSLogs as a subfolder name. This is a reserved term.
The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records . If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.
Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.
The tags to apply to the flow logs.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
When a network interface is attached to a Nitro-based instance , the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
dict
Response Syntax
{
'ClientToken': 'string',
'FlowLogIds': [
'string',
],
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
FlowLogIds (list) --
The IDs of the flow logs.
Unsuccessful (list) --
Information about the flow logs that could not be created successfully.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit .
See also: AWS API Documentation
Request Syntax
response = client.create_fpga_image(
DryRun=True|False,
InputStorageLocation={
'Bucket': 'string',
'Key': 'string'
},
LogsStorageLocation={
'Bucket': 'string',
'Key': 'string'
},
Description='string',
Name='string',
ClientToken='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
The name of the S3 bucket.
The key.
The location in Amazon S3 for the output logs.
The name of the S3 bucket.
The key.
The tags to apply to the FPGA image during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'FpgaImageId': 'string',
'FpgaImageGlobalId': 'string'
}
Response Structure
(dict) --
FpgaImageId (string) --
The FPGA image identifier (AFI ID).
FpgaImageGlobalId (string) --
The global FPGA image identifier (AGFI ID).
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_image(
BlockDeviceMappings=[
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
Description='string',
DryRun=True|False,
InstanceId='string',
Name='string',
NoReboot=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
[REQUIRED]
The ID of the instance.
[REQUIRED]
A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
If you specify other values for ResourceType , the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags .
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The ID of the new AMI.
Examples
This example creates an AMI from the specified instance and adds an EBS volume with the device name /dev/sdh and an instance store volume with the device name /dev/sdc.
response = client.create_image(
BlockDeviceMappings=[
{
'DeviceName': '/dev/sdh',
'Ebs': {
'VolumeSize': '100',
},
},
{
'DeviceName': '/dev/sdc',
'VirtualName': 'ephemeral1',
},
],
Description='An AMI for my server',
InstanceId='i-1234567890abcdef0',
Name='My server',
NoReboot=True,
)
print(response)
Expected Output:
{
'ImageId': 'ami-1a2b3c4d',
'ResponseMetadata': {
'...': '...',
},
}
Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_instance_export_task(
Description='string',
ExportToS3Task={
'ContainerFormat': 'ova',
'DiskImageFormat': 'VMDK'|'RAW'|'VHD',
'S3Bucket': 'string',
'S3Prefix': 'string'
},
InstanceId='string',
TargetEnvironment='citrix'|'vmware'|'microsoft',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The format and location for an export instance task.
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
The format for the exported image.
The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com .
The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
[REQUIRED]
The ID of the instance.
[REQUIRED]
The target virtualization environment.
The tags to apply to the export instance task during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ExportTask': {
'Description': 'string',
'ExportTaskId': 'string',
'ExportToS3Task': {
'ContainerFormat': 'ova',
'DiskImageFormat': 'VMDK'|'RAW'|'VHD',
'S3Bucket': 'string',
'S3Key': 'string'
},
'InstanceExportDetails': {
'InstanceId': 'string',
'TargetEnvironment': 'citrix'|'vmware'|'microsoft'
},
'State': 'active'|'cancelling'|'cancelled'|'completed',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ExportTask (dict) --
Information about the export instance task.
Description (string) --
A description of the resource being exported.
ExportTaskId (string) --
The ID of the export task.
ExportToS3Task (dict) --
Information about the export task.
ContainerFormat (string) --
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
DiskImageFormat (string) --
The format for the exported image.
S3Bucket (string) --
The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com .
S3Key (string) --
The encryption key for your S3 bucket.
InstanceExportDetails (dict) --
Information about the instance to export.
InstanceId (string) --
The ID of the resource being exported.
TargetEnvironment (string) --
The target virtualization environment.
State (string) --
The state of the export task.
StatusMessage (string) --
The status message related to the export task.
Tags (list) --
The tags for the export task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway .
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_internet_gateway(
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
The tags to assign to the internet gateway.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'InternetGateway': {
'Attachments': [
{
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
},
],
'InternetGatewayId': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
InternetGateway (dict) --
Information about the internet gateway.
Attachments (list) --
Any VPCs attached to the internet gateway.
(dict) --
Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
State (string) --
The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
VpcId (string) --
The ID of the VPC.
InternetGatewayId (string) --
The ID of the internet gateway.
OwnerId (string) --
The ID of the AWS account that owns the internet gateway.
Tags (list) --
Any tags assigned to the internet gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example creates an Internet gateway.
response = client.create_internet_gateway(
)
print(response)
Expected Output:
{
'InternetGateway': {
'Attachments': [
],
'InternetGatewayId': 'igw-c0a643a9',
'Tags': [
],
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair .
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_key_pair(
KeyName='string',
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
A unique name for the key pair.
Constraints: Up to 255 ASCII characters
The tags to apply to the new key pair.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'KeyFingerprint': 'string',
'KeyMaterial': 'string',
'KeyName': 'string',
'KeyPairId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Describes a key pair.
KeyFingerprint (string) --
The SHA-1 digest of the DER encoded private key.
KeyMaterial (string) --
An unencrypted PEM encoded RSA private key.
KeyName (string) --
The name of the key pair.
KeyPairId (string) --
The ID of the key pair.
Tags (list) --
Any tags applied to the key pair.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example creates a key pair named my-key-pair.
response = client.create_key_pair(
KeyName='my-key-pair',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances , you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_launch_template(
DryRun=True|False,
ClientToken='string',
LaunchTemplateName='string',
VersionDescription='string',
LaunchTemplateData={
'KernelId': 'string',
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'Encrypted': True|False,
'DeleteOnTermination': True|False,
'Iops': 123,
'KmsKeyId': 'string',
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'Throughput': 123
},
'NoDevice': 'string'
},
],
'NetworkInterfaces': [
{
'AssociateCarrierIpAddress': True|False,
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'InterfaceType': 'string',
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'NetworkCardIndex': 123
},
],
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string',
'PartitionNumber': 123
},
'RamDiskId': 'string',
'DisableApiTermination': True|False,
'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
'UserData': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ElasticGpuSpecifications': [
{
'Type': 'string'
},
],
'ElasticInferenceAccelerators': [
{
'Type': 'string',
'Count': 123
},
],
'SecurityGroupIds': [
'string',
],
'SecurityGroups': [
'string',
],
'InstanceMarketOptions': {
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
'CreditSpecification': {
'CpuCredits': 'string'
},
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
'HibernationOptions': {
'Configured': True|False
},
'MetadataOptions': {
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
}
},
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
Constraint: Maximum 128 ASCII characters.
[REQUIRED]
A name for the launch template.
[REQUIRED]
The information for the launch template.
The ID of the kernel.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
The name or Amazon Resource Name (ARN) of an IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
The block device mapping.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh).
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
Indicates whether the EBS volume is deleted on instance termination.
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is supported for io1 , io2 , and gp3 volumes only. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
To omit the device from the block device mapping, specify an empty string.
One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
The parameters for a network interface.
Associates a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide .
Associates a public IPv4 address with eth0 for a new network interface.
Indicates whether the network interface is deleted when the instance is terminated.
A description for the network interface.
The device index for the network interface attachment.
The IDs of one or more security groups.
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
If you are not creating an EFA, specify interface or omit this parameter.
Valid values: interface | efa
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
Describes an IPv6 address.
The IPv6 address.
The ID of the network interface.
The primary private IPv4 address of the network interface.
One or more private IPv4 addresses.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses to assign to a network interface.
The ID of the subnet for the network interface.
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.
The ID of the AMI.
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .
Warning
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The monitoring for the instance.
Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
The placement for the instance.
The Availability Zone for the instance.
The affinity setting for an instance on a Dedicated Host.
The name of the placement group for the instance.
The ID of the Dedicated Host for the instance.
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
Reserved for future use.
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .
The ID of the RAM disk.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .
If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .
The tags specification for the launch template.
The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume . To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
An elastic GPU to associate with the instance.
A specification for an Elastic Graphics accelerator.
The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see Elastic Graphics Basics , specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances .
The elastic inference accelerator for the instance.
Describes an elastic inference accelerator.
The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
The number of elastic inference accelerators to attach to the instance.
Default: 1
One or more security group IDs. You can create a security group using CreateSecurityGroup . You cannot specify both a security group ID and security name in the same request.
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
The market (purchasing) option for the instances.
The market type.
The options for Spot Instances.
The maximum hourly price you're willing to pay for the Spot Instances.
The Spot Instance request type.
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.
The behavior when a Spot Instance is interrupted. The default is terminate .
The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide .
The number of CPU cores for the instance.
The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.
The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
Information about the target Capacity Reservation or Capacity Reservation group.
The ID of the Capacity Reservation in which to run the instance.
The ARN of the Capacity Reservation resource group in which to run the instance.
The license configurations.
Describes a license configuration.
The Amazon Resource Name (ARN) of the license configuration.
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites . For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide .
If you set this parameter to true , the instance is enabled for hibernation.
Default: false
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide .
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide .
You can't enable AWS Nitro Enclaves and hibernation on the same instance.
To enable the instance for AWS Nitro Enclaves, set this parameter to true .
The tags to apply to the launch template during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'LaunchTemplate': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersionNumber': 123,
'LatestVersionNumber': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'Warning': {
'Errors': [
{
'Code': 'string',
'Message': 'string'
},
]
}
}
Response Structure
(dict) --
LaunchTemplate (dict) --
Information about the launch template.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
CreateTime (datetime) --
The time launch template was created.
CreatedBy (string) --
The principal that created the launch template.
DefaultVersionNumber (integer) --
The version number of the default version of the launch template.
LatestVersionNumber (integer) --
The version number of the latest version of the launch template.
Tags (list) --
The tags for the launch template.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Warning (dict) --
If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
Errors (list) --
The error codes and error messages.
(dict) --
The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
Code (string) --
The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes .
Message (string) --
The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes .
Examples
This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.
response = client.create_launch_template(
LaunchTemplateData={
'ImageId': 'ami-8c1be5f6',
'InstanceType': 't2.small',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True,
'DeviceIndex': 0,
'Ipv6AddressCount': 1,
'SubnetId': 'subnet-7b16de0c',
},
],
'TagSpecifications': [
{
'ResourceType': 'instance',
'Tags': [
{
'Key': 'Name',
'Value': 'webserver',
},
],
},
],
},
LaunchTemplateName='my-template',
VersionDescription='WebVersion1',
)
print(response)
Expected Output:
{
'LaunchTemplate': {
'CreateTime': datetime(2017, 11, 27, 9, 13, 24, 0, 331, 0),
'CreatedBy': 'arn:aws:iam::123456789012:root',
'DefaultVersionNumber': 1,
'LatestVersionNumber': 1,
'LaunchTemplateId': 'lt-01238c059e3466abc',
'LaunchTemplateName': 'my-template',
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
For more information, see Managing launch template versions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_launch_template_version(
DryRun=True|False,
ClientToken='string',
LaunchTemplateId='string',
LaunchTemplateName='string',
SourceVersion='string',
VersionDescription='string',
LaunchTemplateData={
'KernelId': 'string',
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'Encrypted': True|False,
'DeleteOnTermination': True|False,
'Iops': 123,
'KmsKeyId': 'string',
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'Throughput': 123
},
'NoDevice': 'string'
},
],
'NetworkInterfaces': [
{
'AssociateCarrierIpAddress': True|False,
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'InterfaceType': 'string',
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'NetworkCardIndex': 123
},
],
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string',
'PartitionNumber': 123
},
'RamDiskId': 'string',
'DisableApiTermination': True|False,
'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
'UserData': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ElasticGpuSpecifications': [
{
'Type': 'string'
},
],
'ElasticInferenceAccelerators': [
{
'Type': 'string',
'Count': 123
},
],
'SecurityGroupIds': [
'string',
],
'SecurityGroups': [
'string',
],
'InstanceMarketOptions': {
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
'CreditSpecification': {
'CpuCredits': 'string'
},
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
'HibernationOptions': {
'Configured': True|False
},
'MetadataOptions': {
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
}
}
)
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
Constraint: Maximum 128 ASCII characters.
[REQUIRED]
The information for the launch template.
The ID of the kernel.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
The name or Amazon Resource Name (ARN) of an IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
The block device mapping.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh).
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
Indicates whether the EBS volume is deleted on instance termination.
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is supported for io1 , io2 , and gp3 volumes only. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
To omit the device from the block device mapping, specify an empty string.
One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
The parameters for a network interface.
Associates a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide .
Associates a public IPv4 address with eth0 for a new network interface.
Indicates whether the network interface is deleted when the instance is terminated.
A description for the network interface.
The device index for the network interface attachment.
The IDs of one or more security groups.
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
If you are not creating an EFA, specify interface or omit this parameter.
Valid values: interface | efa
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
Describes an IPv6 address.
The IPv6 address.
The ID of the network interface.
The primary private IPv4 address of the network interface.
One or more private IPv4 addresses.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses to assign to a network interface.
The ID of the subnet for the network interface.
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.
The ID of the AMI.
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .
Warning
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The monitoring for the instance.
Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
The placement for the instance.
The Availability Zone for the instance.
The affinity setting for an instance on a Dedicated Host.
The name of the placement group for the instance.
The ID of the Dedicated Host for the instance.
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
Reserved for future use.
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .
The ID of the RAM disk.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .
If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .
The tags specification for the launch template.
The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume . To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
An elastic GPU to associate with the instance.
A specification for an Elastic Graphics accelerator.
The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see Elastic Graphics Basics , specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances .
The elastic inference accelerator for the instance.
Describes an elastic inference accelerator.
The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
The number of elastic inference accelerators to attach to the instance.
Default: 1
One or more security group IDs. You can create a security group using CreateSecurityGroup . You cannot specify both a security group ID and security name in the same request.
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
The market (purchasing) option for the instances.
The market type.
The options for Spot Instances.
The maximum hourly price you're willing to pay for the Spot Instances.
The Spot Instance request type.
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.
The behavior when a Spot Instance is interrupted. The default is terminate .
The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide .
The number of CPU cores for the instance.
The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.
The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
Information about the target Capacity Reservation or Capacity Reservation group.
The ID of the Capacity Reservation in which to run the instance.
The ARN of the Capacity Reservation resource group in which to run the instance.
The license configurations.
Describes a license configuration.
The Amazon Resource Name (ARN) of the license configuration.
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites . For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide .
If you set this parameter to true , the instance is enabled for hibernation.
Default: false
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide .
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide .
You can't enable AWS Nitro Enclaves and hibernation on the same instance.
To enable the instance for AWS Nitro Enclaves, set this parameter to true .
dict
Response Syntax
{
'LaunchTemplateVersion': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'VersionNumber': 123,
'VersionDescription': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersion': True|False,
'LaunchTemplateData': {
'KernelId': 'string',
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'Encrypted': True|False,
'DeleteOnTermination': True|False,
'Iops': 123,
'KmsKeyId': 'string',
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'Throughput': 123
},
'NoDevice': 'string'
},
],
'NetworkInterfaces': [
{
'AssociateCarrierIpAddress': True|False,
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'InterfaceType': 'string',
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'NetworkCardIndex': 123
},
],
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string',
'PartitionNumber': 123
},
'RamDiskId': 'string',
'DisableApiTermination': True|False,
'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
'UserData': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ElasticGpuSpecifications': [
{
'Type': 'string'
},
],
'ElasticInferenceAccelerators': [
{
'Type': 'string',
'Count': 123
},
],
'SecurityGroupIds': [
'string',
],
'SecurityGroups': [
'string',
],
'InstanceMarketOptions': {
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
'CreditSpecification': {
'CpuCredits': 'string'
},
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
'HibernationOptions': {
'Configured': True|False
},
'MetadataOptions': {
'State': 'pending'|'applied',
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
}
}
},
'Warning': {
'Errors': [
{
'Code': 'string',
'Message': 'string'
},
]
}
}
Response Structure
(dict) --
LaunchTemplateVersion (dict) --
Information about the launch template version.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
VersionNumber (integer) --
The version number.
VersionDescription (string) --
The description for the version.
CreateTime (datetime) --
The time the version was created.
CreatedBy (string) --
The principal that created the version.
DefaultVersion (boolean) --
Indicates whether the version is the default version.
LaunchTemplateData (dict) --
Information about the launch template.
KernelId (string) --
The ID of the kernel, if applicable.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for Amazon EBS I/O.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
BlockDeviceMappings (list) --
The block device mappings.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name.
VirtualName (string) --
The virtual device name (ephemeralN).
Ebs (dict) --
Information about the block device for an EBS volume.
Encrypted (boolean) --
Indicates whether the EBS volume is encrypted.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports.
KmsKeyId (string) --
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiB.
VolumeType (string) --
The volume type.
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
NetworkInterfaces (list) --
The network interfaces.
(dict) --
Describes a network interface.
AssociateCarrierIpAddress (boolean) --
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide .
AssociatePublicIpAddress (boolean) --
Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
DeleteOnTermination (boolean) --
Indicates whether the network interface is deleted when the instance is terminated.
Description (string) --
A description for the network interface.
DeviceIndex (integer) --
The device index for the network interface attachment.
Groups (list) --
The IDs of one or more security groups.
InterfaceType (string) --
The type of network interface.
Ipv6AddressCount (integer) --
The number of IPv6 addresses for the network interface.
Ipv6Addresses (list) --
The IPv6 addresses for the network interface.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
PrivateIpAddress (string) --
The primary private IPv4 address of the network interface.
PrivateIpAddresses (list) --
One or more private IPv4 addresses.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses for the network interface.
SubnetId (string) --
The ID of the subnet for the network interface.
NetworkCardIndex (integer) --
The index of the network card.
ImageId (string) --
The ID of the AMI that was used to launch the instance.
InstanceType (string) --
The instance type.
KeyName (string) --
The name of the key pair.
Monitoring (dict) --
The monitoring for the instance.
Enabled (boolean) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Placement (dict) --
The placement of the instance.
AvailabilityZone (string) --
The Availability Zone of the instance.
Affinity (string) --
The affinity setting for the instance on the Dedicated Host.
GroupName (string) --
The name of the placement group for the instance.
HostId (string) --
The ID of the Dedicated Host for the instance.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
SpreadDomain (string) --
Reserved for future use.
HostResourceGroupArn (string) --
The ARN of the host resource group in which to launch the instances.
PartitionNumber (integer) --
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .
RamDiskId (string) --
The ID of the RAM disk, if applicable.
DisableApiTermination (boolean) --
If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
InstanceInitiatedShutdownBehavior (string) --
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
UserData (string) --
The user data for the instance.
TagSpecifications (list) --
The tags.
(dict) --
The tag specification for the launch template.
ResourceType (string) --
The type of resource.
Tags (list) --
The tags for the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ElasticGpuSpecifications (list) --
The elastic GPU specification.
(dict) --
Describes an elastic GPU.
Type (string) --
The elastic GPU type.
ElasticInferenceAccelerators (list) --
The elastic inference accelerator for the instance.
(dict) --
Describes an elastic inference accelerator.
Type (string) --
The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
Count (integer) --
The number of elastic inference accelerators to attach to the instance.
Default: 1
SecurityGroupIds (list) --
The security group IDs.
SecurityGroups (list) --
The security group names.
InstanceMarketOptions (dict) --
The market (purchasing) option for the instances.
MarketType (string) --
The market type.
SpotOptions (dict) --
The options for Spot Instances.
MaxPrice (string) --
The maximum hourly price you're willing to pay for the Spot Instances.
SpotInstanceType (string) --
The Spot Instance request type.
BlockDurationMinutes (integer) --
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
ValidUntil (datetime) --
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted.
CreditSpecification (dict) --
The credit option for CPU usage of the instance.
CpuCredits (string) --
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
CpuOptions (dict) --
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide .
CoreCount (integer) --
The number of CPU cores for the instance.
ThreadsPerCore (integer) --
The number of threads per CPU core.
CapacityReservationSpecification (dict) --
Information about the Capacity Reservation targeting option.
CapacityReservationPreference (string) --
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
CapacityReservationTarget (dict) --
Information about the target Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) --
The ID of the targeted Capacity Reservation.
CapacityReservationResourceGroupArn (string) --
The ARN of the targeted Capacity Reservation group.
LicenseSpecifications (list) --
The license configurations.
(dict) --
Describes a license configuration.
LicenseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the license configuration.
HibernationOptions (dict) --
Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide .
Configured (boolean) --
If this parameter is set to true , the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
MetadataOptions (dict) --
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide .
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
EnclaveOptions (dict) --
Indicates whether the instance is enabled for AWS Nitro Enclaves.
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.
Warning (dict) --
If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
Errors (list) --
The error codes and error messages.
(dict) --
The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
Code (string) --
The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes .
Message (string) --
The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes .
Examples
This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID.
response = client.create_launch_template_version(
LaunchTemplateData={
'ImageId': 'ami-c998b6b2',
},
LaunchTemplateId='lt-0abcd290751193123',
SourceVersion='1',
VersionDescription='WebVersion2',
)
print(response)
Expected Output:
{
'LaunchTemplateVersion': {
'CreateTime': datetime(2017, 12, 1, 13, 35, 46, 4, 335, 0),
'CreatedBy': 'arn:aws:iam::123456789012:root',
'DefaultVersion': False,
'LaunchTemplateData': {
'ImageId': 'ami-c998b6b2',
'InstanceType': 't2.micro',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True,
'DeviceIndex': 0,
'Ipv6Addresses': [
{
'Ipv6Address': '2001:db8:1234:1a00::123',
},
],
'SubnetId': 'subnet-7b16de0c',
},
],
},
'LaunchTemplateId': 'lt-0abcd290751193123',
'LaunchTemplateName': 'my-template',
'VersionDescription': 'WebVersion2',
'VersionNumber': 2,
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a static route for the specified local gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.create_local_gateway_route(
DestinationCidrBlock='string',
LocalGatewayRouteTableId='string',
DryRun=True|False,
LocalGatewayVirtualInterfaceGroupId='string'
)
[REQUIRED]
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
[REQUIRED]
The ID of the local gateway route table.
[REQUIRED]
The ID of the virtual interface group.
dict
Response Syntax
{
'Route': {
'DestinationCidrBlock': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
Type (string) --
The route type.
State (string) --
The state of the route.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
OwnerId (string) --
The AWS account ID that owns the local gateway route.
Associates the specified VPC with the specified local gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.create_local_gateway_route_table_vpc_association(
LocalGatewayRouteTableId='string',
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the local gateway route table.
[REQUIRED]
The ID of the VPC.
The tags to assign to the local gateway route table VPC association.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'LocalGatewayRouteTableVpcAssociation': {
'LocalGatewayRouteTableVpcAssociationId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
LocalGatewayRouteTableVpcAssociation (dict) --
Information about the association.
LocalGatewayRouteTableVpcAssociationId (string) --
The ID of the association.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the association.
LocalGatewayId (string) --
The ID of the local gateway.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The AWS account ID that owns the local gateway route table for the association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.
You must specify the maximum number of entries for the prefix list. The maximum number of entries cannot be changed later.
See also: AWS API Documentation
Request Syntax
response = client.create_managed_prefix_list(
DryRun=True|False,
PrefixListName='string',
Entries=[
{
'Cidr': 'string',
'Description': 'string'
},
],
MaxEntries=123,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
AddressFamily='string',
ClientToken='string'
)
[REQUIRED]
A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws .
One or more entries for the prefix list.
An entry for a prefix list.
The CIDR block.
A description for the entry.
Constraints: Up to 255 characters in length.
[REQUIRED]
The maximum number of entries for the prefix list.
The tags to apply to the prefix list during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
[REQUIRED]
The IP address type.
Valid Values: IPv4 | IPv6
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
Constraints: Up to 255 UTF-8 characters in length.
This field is autopopulated if not provided.
dict
Response Syntax
{
'PrefixList': {
'PrefixListId': 'string',
'AddressFamily': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'PrefixListArn': 'string',
'PrefixListName': 'string',
'MaxEntries': 123,
'Version': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string'
}
}
Response Structure
(dict) --
PrefixList (dict) --
Information about the prefix list.
PrefixListId (string) --
The ID of the prefix list.
AddressFamily (string) --
The IP address version.
State (string) --
The state of the prefix list.
StateMessage (string) --
The state message.
PrefixListArn (string) --
The Amazon Resource Name (ARN) for the prefix list.
PrefixListName (string) --
The name of the prefix list.
MaxEntries (integer) --
The maximum number of entries for the prefix list.
Version (integer) --
The version of the prefix list.
Tags (list) --
The tags for the prefix list.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the owner of the prefix list.
Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_nat_gateway(
AllocationId='string',
ClientToken='string',
DryRun=True|False,
SubnetId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ConnectivityType='private'|'public'
)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .
Constraint: Maximum 64 ASCII characters.
This field is autopopulated if not provided.
[REQUIRED]
The subnet in which to create the NAT gateway.
The tags to assign to the NAT gateway.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ClientToken': 'string',
'NatGateway': {
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'FailureCode': 'string',
'FailureMessage': 'string',
'NatGatewayAddresses': [
{
'AllocationId': 'string',
'NetworkInterfaceId': 'string',
'PrivateIp': 'string',
'PublicIp': 'string'
},
],
'NatGatewayId': 'string',
'ProvisionedBandwidth': {
'ProvisionTime': datetime(2015, 1, 1),
'Provisioned': 'string',
'RequestTime': datetime(2015, 1, 1),
'Requested': 'string',
'Status': 'string'
},
'State': 'pending'|'failed'|'available'|'deleting'|'deleted',
'SubnetId': 'string',
'VpcId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConnectivityType': 'private'|'public'
}
}
Response Structure
(dict) --
ClientToken (string) --
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
NatGateway (dict) --
Information about the NAT gateway.
CreateTime (datetime) --
The date and time the NAT gateway was created.
DeleteTime (datetime) --
The date and time the NAT gateway was deleted, if applicable.
FailureCode (string) --
If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound )
FailureMessage (string) --
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
NatGatewayAddresses (list) --
Information about the IP addresses and network interface associated with the NAT gateway.
(dict) --
Describes the IP addresses and network interface associated with a NAT gateway.
AllocationId (string) --
[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
NetworkInterfaceId (string) --
The ID of the network interface associated with the NAT gateway.
PrivateIp (string) --
The private IP address associated with the NAT gateway.
PublicIp (string) --
[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
NatGatewayId (string) --
The ID of the NAT gateway.
ProvisionedBandwidth (dict) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
ProvisionTime (datetime) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Provisioned (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
RequestTime (datetime) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Requested (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Status (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
State (string) --
The state of the NAT gateway.
SubnetId (string) --
The ID of the subnet in which the NAT gateway is located.
VpcId (string) --
The ID of the VPC in which the NAT gateway is located.
Tags (list) --
The tags for the NAT gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ConnectivityType (string) --
Indicates whether the NAT gateway supports public or private connectivity.
Examples
This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.
response = client.create_nat_gateway(
AllocationId='eipalloc-37fc1a52',
SubnetId='subnet-1a2b3c4d',
)
print(response)
Expected Output:
{
'NatGateway': {
'CreateTime': datetime(2015, 12, 17, 12, 45, 26, 3, 351, 0),
'NatGatewayAddresses': [
{
'AllocationId': 'eipalloc-37fc1a52',
},
],
'NatGatewayId': 'nat-08d48af2a8e83edfd',
'State': 'pending',
'SubnetId': 'subnet-1a2b3c4d',
'VpcId': 'vpc-1122aabb',
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_network_acl(
DryRun=True|False,
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the VPC.
The tags to assign to the network ACL.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'NetworkAcl': {
'Associations': [
{
'NetworkAclAssociationId': 'string',
'NetworkAclId': 'string',
'SubnetId': 'string'
},
],
'Entries': [
{
'CidrBlock': 'string',
'Egress': True|False,
'IcmpTypeCode': {
'Code': 123,
'Type': 123
},
'Ipv6CidrBlock': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'allow'|'deny',
'RuleNumber': 123
},
],
'IsDefault': True|False,
'NetworkAclId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string',
'OwnerId': 'string'
}
}
Response Structure
(dict) --
NetworkAcl (dict) --
Information about the network ACL.
Associations (list) --
Any associations between the network ACL and one or more subnets
(dict) --
Describes an association between a network ACL and a subnet.
NetworkAclAssociationId (string) --
The ID of the association between a network ACL and a subnet.
NetworkAclId (string) --
The ID of the network ACL.
SubnetId (string) --
The ID of the subnet.
Entries (list) --
One or more entries (rules) in the network ACL.
(dict) --
Describes an entry in a network ACL.
CidrBlock (string) --
The IPv4 network range to allow or deny, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
IcmpTypeCode (dict) --
ICMP protocol: The ICMP type and code.
Code (integer) --
The ICMP code. A value of -1 means all codes for the specified ICMP type.
Type (integer) --
The ICMP type. A value of -1 means all types.
Ipv6CidrBlock (string) --
The IPv6 network range to allow or deny, in CIDR notation.
PortRange (dict) --
TCP or UDP protocols: The range of ports the rule applies to.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol number. A value of "-1" means all protocols.
RuleAction (string) --
Indicates whether to allow or deny the traffic that matches the rule.
RuleNumber (integer) --
The rule number for the entry. ACL entries are processed in ascending order by rule number.
IsDefault (boolean) --
Indicates whether this is the default network ACL for the VPC.
NetworkAclId (string) --
The ID of the network ACL.
Tags (list) --
Any tags assigned to the network ACL.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC for the network ACL.
OwnerId (string) --
The ID of the AWS account that owns the network ACL.
Examples
This example creates a network ACL for the specified VPC.
response = client.create_network_acl(
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'NetworkAcl': {
'Associations': [
],
'Entries': [
{
'CidrBlock': '0.0.0.0/0',
'Egress': True,
'Protocol': '-1',
'RuleAction': 'deny',
'RuleNumber': 32767,
},
{
'CidrBlock': '0.0.0.0/0',
'Egress': False,
'Protocol': '-1',
'RuleAction': 'deny',
'RuleNumber': 32767,
},
],
'IsDefault': False,
'NetworkAclId': 'acl-5fb85d36',
'Tags': [
],
'VpcId': 'vpc-a01106c2',
},
'ResponseMetadata': {
'...': '...',
},
}
Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_network_acl_entry(
CidrBlock='string',
DryRun=True|False,
Egress=True|False,
IcmpTypeCode={
'Code': 123,
'Type': 123
},
Ipv6CidrBlock='string',
NetworkAclId='string',
PortRange={
'From': 123,
'To': 123
},
Protocol='string',
RuleAction='allow'|'deny',
RuleNumber=123
)
[REQUIRED]
Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
The ICMP code. A value of -1 means all codes for the specified ICMP type.
The ICMP type. A value of -1 means all types.
[REQUIRED]
The ID of the network ACL.
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
The first port in the range.
The last port in the range.
[REQUIRED]
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
[REQUIRED]
Indicates whether to allow or deny the traffic that matches the rule.
[REQUIRED]
The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
None
Examples
This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.
response = client.create_network_acl_entry(
CidrBlock='0.0.0.0/0',
Egress=False,
NetworkAclId='acl-5fb85d36',
PortRange={
'From': 53,
'To': 53,
},
Protocol='udp',
RuleAction='allow',
RuleNumber=100,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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
response = client.create_network_insights_path(
SourceIp='string',
DestinationIp='string',
Source='string',
Destination='string',
Protocol='tcp'|'udp',
DestinationPort=123,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
ClientToken='string'
)
[REQUIRED]
The AWS resource that is the source of the path.
[REQUIRED]
The AWS resource that is the destination of the path.
[REQUIRED]
The protocol.
The tags to add to the path.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
[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',
'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 AWS resource that is the source of the path.
Destination (string) --
The AWS resource that is the destination of the path.
SourceIp (string) --
The IP address of the AWS resource that is the source of the path.
DestinationIp (string) --
The IP address of the AWS 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 255 Unicode characters.
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_network_interface(
Description='string',
DryRun=True|False,
Groups=[
'string',
],
Ipv6AddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string'
},
],
PrivateIpAddress='string',
PrivateIpAddresses=[
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
SecondaryPrivateIpAddressCount=123,
InterfaceType='efa'|'branch'|'trunk',
SubnetId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
The IDs of one or more security groups.
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
Describes an IPv6 address.
The IPv6 address.
One or more private IPv4 addresses.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .
[REQUIRED]
The ID of the subnet to associate with the network interface.
The tags to apply to the new network interface.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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'
},
'AvailabilityZone': 'string',
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa'|'trunk',
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Association': {
'AllocationId': 'string',
'AssociationId': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string',
'CustomerOwnedIp': 'string',
'CarrierIp': 'string'
},
'Primary': True|False,
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string'
},
],
'RequesterId': 'string',
'RequesterManaged': True|False,
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'TagSet': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
'ClientToken': 'string'
}
Response Structure
(dict) --
Contains the output of CreateNetworkInterface.
NetworkInterface (dict) --
Information about the network interface.
Association (dict) --
The association information for an Elastic IP address (IPv4) associated with the network interface.
AllocationId (string) --
The allocation ID.
AssociationId (string) --
The association ID.
IpOwnerId (string) --
The ID of the Elastic IP address owner.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The address of the Elastic IP address 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 account ID of the owner of the instance.
Status (string) --
The attachment state.
AvailabilityZone (string) --
The Availability Zone.
Description (string) --
A description.
Groups (list) --
Any security groups for the network interface.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
InterfaceType (string) --
The type of network interface.
Ipv6Addresses (list) --
The IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address associated with a network interface.
Ipv6Address (string) --
The IPv6 address.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The 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.
RequesterId (string) --
The alias or 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 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
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.
Examples
This example creates a network interface for the specified subnet.
response = client.create_network_interface(
Description='my network interface',
Groups=[
'sg-903004f8',
],
PrivateIpAddress='10.0.2.17',
SubnetId='subnet-9d4a7b6c',
)
print(response)
Expected Output:
{
'NetworkInterface': {
'AvailabilityZone': 'us-east-1d',
'Description': 'my network interface',
'Groups': [
{
'GroupId': 'sg-903004f8',
'GroupName': 'default',
},
],
'MacAddress': '02:1a:80:41:52:9c',
'NetworkInterfaceId': 'eni-e5aa89a3',
'OwnerId': '123456789012',
'PrivateIpAddress': '10.0.2.17',
'PrivateIpAddresses': [
{
'Primary': True,
'PrivateIpAddress': '10.0.2.17',
},
],
'RequesterManaged': False,
'SourceDestCheck': True,
'Status': 'pending',
'SubnetId': 'subnet-9d4a7b6c',
'TagSet': [
],
'VpcId': 'vpc-a01106c2',
},
'ResponseMetadata': {
'...': '...',
},
}
Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single account only, and only one account at a time.
See also: AWS API Documentation
Request Syntax
response = client.create_network_interface_permission(
NetworkInterfaceId='string',
AwsAccountId='string',
AwsService='string',
Permission='INSTANCE-ATTACH'|'EIP-ASSOCIATE',
DryRun=True|False
)
[REQUIRED]
The ID of the network interface.
[REQUIRED]
The type of permission to grant.
dict
Response Syntax
{
'InterfacePermission': {
'NetworkInterfacePermissionId': 'string',
'NetworkInterfaceId': 'string',
'AwsAccountId': 'string',
'AwsService': 'string',
'Permission': 'INSTANCE-ATTACH'|'EIP-ASSOCIATE',
'PermissionState': {
'State': 'pending'|'granted'|'revoking'|'revoked',
'StatusMessage': 'string'
}
}
}
Response Structure
(dict) --
Contains the output of CreateNetworkInterfacePermission.
InterfacePermission (dict) --
Information about the permission for the network interface.
NetworkInterfacePermissionId (string) --
The ID of the network interface permission.
NetworkInterfaceId (string) --
The ID of the network interface.
AwsAccountId (string) --
The account ID.
AwsService (string) --
The Amazon Web Service.
Permission (string) --
The type of permission.
PermissionState (dict) --
Information about the state of the permission.
State (string) --
The state of the permission.
StatusMessage (string) --
A status message, if applicable.
Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_placement_group(
DryRun=True|False,
GroupName='string',
Strategy='cluster'|'spread'|'partition',
PartitionCount=123,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
The tags to apply to the new placement group.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'PlacementGroup': {
'GroupName': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Strategy': 'cluster'|'spread'|'partition',
'PartitionCount': 123,
'GroupId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
PlacementGroup (dict) --
Describes a placement group.
GroupName (string) --
The name of the placement group.
State (string) --
The state of the placement group.
Strategy (string) --
The placement strategy.
PartitionCount (integer) --
The number of partitions. Valid only if strategy is set to partition .
GroupId (string) --
The ID of the placement group.
Tags (list) --
Any tags applied to the placement group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example creates a placement group with the specified name.
response = client.create_placement_group(
GroupName='my-cluster',
Strategy='cluster',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_replace_root_volume_task(
InstanceId='string',
SnapshotId='string',
ClientToken='string',
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the instance for which to replace the root volume.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring Idempotency .
This field is autopopulated if not provided.
The tags to apply to the root volume replacement task.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ReplaceRootVolumeTask': {
'ReplaceRootVolumeTaskId': 'string',
'InstanceId': 'string',
'TaskState': 'pending'|'in-progress'|'failing'|'succeeded'|'failed'|'failed-detached',
'StartTime': 'string',
'CompleteTime': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ReplaceRootVolumeTask (dict) --
Information about the root volume replacement task.
ReplaceRootVolumeTaskId (string) --
The ID of the root volume replacement task.
InstanceId (string) --
The ID of the instance for which the root volume replacement task was created.
TaskState (string) --
The state of the task. The task can be in one of the following states:
StartTime (string) --
The time the task was started.
CompleteTime (string) --
The time the task completed.
Tags (list) --
The tags assigned to the task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Note
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_reserved_instances_listing(
ClientToken='string',
InstanceCount=123,
PriceSchedules=[
{
'CurrencyCode': 'USD',
'Price': 123.0,
'Term': 123
},
],
ReservedInstancesId='string'
)
[REQUIRED]
Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency .
[REQUIRED]
The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
[REQUIRED]
A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
Describes the price for a Reserved Instance.
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD .
The fixed price for the term.
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
[REQUIRED]
The ID of the active Standard Reserved Instance.
dict
Response Syntax
{
'ReservedInstancesListings': [
{
'ClientToken': 'string',
'CreateDate': datetime(2015, 1, 1),
'InstanceCounts': [
{
'InstanceCount': 123,
'State': 'available'|'sold'|'cancelled'|'pending'
},
],
'PriceSchedules': [
{
'Active': True|False,
'CurrencyCode': 'USD',
'Price': 123.0,
'Term': 123
},
],
'ReservedInstancesId': 'string',
'ReservedInstancesListingId': 'string',
'Status': 'active'|'pending'|'cancelled'|'closed',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'UpdateDate': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Contains the output of CreateReservedInstancesListing.
ReservedInstancesListings (list) --
Information about the Standard Reserved Instance listing.
(dict) --
Describes a Reserved Instance listing.
ClientToken (string) --
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency .
CreateDate (datetime) --
The time the listing was created.
InstanceCounts (list) --
The number of instances in this state.
(dict) --
Describes a Reserved Instance listing state.
InstanceCount (integer) --
The number of listed Reserved Instances in the state specified by the state .
State (string) --
The states of the listed Reserved Instances.
PriceSchedules (list) --
The price of the Reserved Instance listing.
(dict) --
Describes the price for a Reserved Instance.
Active (boolean) --
The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
CurrencyCode (string) --
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD .
Price (float) --
The fixed price for the term.
Term (integer) --
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
ReservedInstancesId (string) --
The ID of the Reserved Instance.
ReservedInstancesListingId (string) --
The ID of the Reserved Instance listing.
Status (string) --
The status of the Reserved Instance listing.
StatusMessage (string) --
The reason for the current status of the Reserved Instance listing. The response can be blank.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
UpdateDate (datetime) --
The last modified timestamp of the listing.
Starts a task that restores an AMI from an S3 object that was previously created by using CreateStoreImageTask .
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using S3 in the Amazon Elastic Compute Cloud User Guide .
For more information, see Store and restore an AMI using S3 in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_restore_image_task(
Bucket='string',
ObjectKey='string',
Name='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
The name of the S3 bucket that contains the stored AMI object.
[REQUIRED]
The name of the stored AMI object in the bucket.
The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The AMI ID.
Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3 , and the route table includes the following two IPv4 routes:
Both routes apply to the traffic destined for 192.0.2.3 . However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_route(
DestinationCidrBlock='string',
DestinationIpv6CidrBlock='string',
DestinationPrefixListId='string',
DryRun=True|False,
VpcEndpointId='string',
EgressOnlyInternetGatewayId='string',
GatewayId='string',
InstanceId='string',
NatGatewayId='string',
TransitGatewayId='string',
LocalGatewayId='string',
CarrierGatewayId='string',
NetworkInterfaceId='string',
RouteTableId='string',
VpcPeeringConnectionId='string'
)
The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
[REQUIRED]
The ID of the route table for the route.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Examples
This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.
response = client.create_route(
DestinationCidrBlock='0.0.0.0/0',
GatewayId='igw-c0a643a9',
RouteTableId='rtb-22574640',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_route_table(
DryRun=True|False,
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the VPC.
The tags to assign to the route table.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'RouteTable': {
'Associations': [
{
'Main': True|False,
'RouteTableAssociationId': 'string',
'RouteTableId': 'string',
'SubnetId': 'string',
'GatewayId': 'string',
'AssociationState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failed',
'StatusMessage': 'string'
}
},
],
'PropagatingVgws': [
{
'GatewayId': 'string'
},
],
'RouteTableId': 'string',
'Routes': [
{
'DestinationCidrBlock': 'string',
'DestinationIpv6CidrBlock': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'NatGatewayId': 'string',
'TransitGatewayId': 'string',
'LocalGatewayId': 'string',
'CarrierGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'CreateRouteTable'|'CreateRoute'|'EnableVgwRoutePropagation',
'State': 'active'|'blackhole',
'VpcPeeringConnectionId': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string',
'OwnerId': 'string'
}
}
Response Structure
(dict) --
RouteTable (dict) --
Information about the route table.
Associations (list) --
The associations between the route table and one or more subnets or a gateway.
(dict) --
Describes an association between a route table and a subnet or gateway.
Main (boolean) --
Indicates whether this is the main route table.
RouteTableAssociationId (string) --
The ID of the association.
RouteTableId (string) --
The ID of the route table.
SubnetId (string) --
The ID of the subnet. A subnet ID is not returned for an implicit association.
GatewayId (string) --
The ID of the internet gateway or virtual private gateway.
AssociationState (dict) --
The state of the association.
State (string) --
The state of the association.
StatusMessage (string) --
The status message, if applicable.
PropagatingVgws (list) --
Any virtual private gateway (VGW) propagating routes.
(dict) --
Describes a virtual private gateway propagating route.
GatewayId (string) --
The ID of the virtual private gateway.
RouteTableId (string) --
The ID of the route table.
Routes (list) --
The routes in the route table.
(dict) --
Describes a route in a route table.
DestinationCidrBlock (string) --
The IPv4 CIDR block used for the destination match.
DestinationIpv6CidrBlock (string) --
The IPv6 CIDR block used for the destination match.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of the egress-only internet gateway.
GatewayId (string) --
The ID of a gateway attached to your VPC.
InstanceId (string) --
The ID of a NAT instance in your VPC.
InstanceOwnerId (string) --
The AWS account ID of the owner of the instance.
NatGatewayId (string) --
The ID of a NAT gateway.
TransitGatewayId (string) --
The ID of a transit gateway.
LocalGatewayId (string) --
The ID of the local gateway.
CarrierGatewayId (string) --
The ID of the carrier gateway.
NetworkInterfaceId (string) --
The ID of the network interface.
Origin (string) --
Describes how the route was created.
State (string) --
The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
Tags (list) --
Any tags assigned to the route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The ID of the AWS account that owns the route table.
Examples
This example creates a route table for the specified VPC.
response = client.create_route_table(
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'RouteTable': {
'Associations': [
],
'PropagatingVgws': [
],
'RouteTableId': 'rtb-22574640',
'Routes': [
{
'DestinationCidrBlock': '10.0.0.0/16',
'GatewayId': 'local',
'State': 'active',
},
],
'Tags': [
],
'VpcId': 'vpc-a01106c2',
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress , AuthorizeSecurityGroupEgress , RevokeSecurityGroupIngress , and RevokeSecurityGroupEgress .
For more information about VPC security group limits, see Amazon VPC Limits .
See also: AWS API Documentation
Request Syntax
response = client.create_security_group(
Description='string',
GroupName='string',
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[REQUIRED]
The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg- .
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
The tags to assign to the security group.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'GroupId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
GroupId (string) --
The ID of the security group.
Tags (list) --
The tags assigned to the security group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example creates a security group for the specified VPC.
response = client.create_security_group(
Description='My security group',
GroupName='my-security-group',
VpcId='vpc-1a2b3c4d',
)
print(response)
Expected Output:
{
'GroupId': 'sg-903004f8',
'ResponseMetadata': {
'...': '...',
},
}
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending .
To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide .
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_snapshot(
Description='string',
OutpostArn='string',
VolumeId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.
For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide .
[REQUIRED]
The ID of the EBS volume.
The tags to apply to the snapshot during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'DataEncryptionKeyId': 'string',
'Description': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'OwnerId': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'StartTime': datetime(2015, 1, 1),
'State': 'pending'|'completed'|'error',
'StateMessage': 'string',
'VolumeId': 'string',
'VolumeSize': 123,
'OwnerAlias': 'string',
'OutpostArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Describes a snapshot.
DataEncryptionKeyId (string) --
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots .
Description (string) --
The description for the snapshot.
Encrypted (boolean) --
Indicates whether the snapshot is encrypted.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
OwnerId (string) --
The AWS account ID of the EBS snapshot owner.
Progress (string) --
The progress of the snapshot, as a percentage.
SnapshotId (string) --
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
StartTime (datetime) --
The time stamp when the snapshot was initiated.
State (string) --
The snapshot state.
StateMessage (string) --
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots .
VolumeId (string) --
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
VolumeSize (integer) --
The size of the volume, in GiB.
OwnerAlias (string) --
The AWS owner alias, from an Amazon-maintained list (amazon ). This is not the user-configured AWS account alias set using the IAM console.
OutpostArn (string) --
The ARN of the AWS Outpost on which the snapshot is stored. For more information, see EBS Local Snapshot on Outposts in the Amazon Elastic Compute Cloud User Guide .
Tags (list) --
Any tags assigned to the snapshot.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example creates a snapshot of the volume with a volume ID of vol-1234567890abcdef0 and a short description to identify the snapshot.
response = client.create_snapshot(
Description='This is my root volume snapshot.',
VolumeId='vol-1234567890abcdef0',
)
print(response)
Expected Output:
{
'Description': 'This is my root volume snapshot.',
'OwnerId': '012345678910',
'SnapshotId': 'snap-066877671789bd71b',
'StartTime': datetime(2014, 2, 28, 21, 6, 1, 4, 59, 0),
'State': 'pending',
'Tags': [
],
'VolumeId': 'vol-1234567890abcdef0',
'VolumeSize': 8,
'ResponseMetadata': {
'...': '...',
},
}
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
See also: AWS API Documentation
Request Syntax
response = client.create_snapshots(
Description='string',
InstanceSpecification={
'InstanceId': 'string',
'ExcludeBootVolume': True|False
},
OutpostArn='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
CopyTagsFromSource='volume'
)
[REQUIRED]
The instance to specify which volumes should be included in the snapshots.
The instance to specify which volumes should be snapshotted.
Excludes the root volume from being snapshotted.
The Amazon Resource Name (ARN) of the AWS Outpost on which to create the local snapshots.
For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide .
Tags to apply to every snapshot specified by the instance.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Snapshots': [
{
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Encrypted': True|False,
'VolumeId': 'string',
'State': 'pending'|'completed'|'error',
'VolumeSize': 123,
'StartTime': datetime(2015, 1, 1),
'Progress': 'string',
'OwnerId': 'string',
'SnapshotId': 'string',
'OutpostArn': 'string'
},
]
}
Response Structure
(dict) --
Snapshots (list) --
List of snapshots.
(dict) --
Information about a snapshot.
Description (string) --
Description specified by the CreateSnapshotRequest that has been applied to all snapshots.
Tags (list) --
Tags associated with this snapshot.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Encrypted (boolean) --
Indicates whether the snapshot is encrypted.
VolumeId (string) --
Source volume from which this snapshot was created.
State (string) --
Current state of the snapshot.
VolumeSize (integer) --
Size of the volume from which this snapshot was created.
StartTime (datetime) --
Time this snapshot was started. This is the same for all snapshots initiated by the same request.
Progress (string) --
Progress this snapshot has made towards completing.
OwnerId (string) --
Account id used when creating this snapshot.
SnapshotId (string) --
Snapshot id that can be used to describe this snapshot.
OutpostArn (string) --
The ARN of the AWS Outpost on which the snapshot is stored. For more information, see EBS Local Snapshot on Outposts in the Amazon Elastic Compute Cloud User Guide .
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances .
See also: AWS API Documentation
Request Syntax
response = client.create_spot_datafeed_subscription(
Bucket='string',
DryRun=True|False,
Prefix='string'
)
[REQUIRED]
The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide .
dict
Response Syntax
{
'SpotDatafeedSubscription': {
'Bucket': 'string',
'Fault': {
'Code': 'string',
'Message': 'string'
},
'OwnerId': 'string',
'Prefix': 'string',
'State': 'Active'|'Inactive'
}
}
Response Structure
(dict) --
Contains the output of CreateSpotDatafeedSubscription.
SpotDatafeedSubscription (dict) --
The Spot Instance data feed subscription.
Bucket (string) --
The name of the Amazon S3 bucket where the Spot Instance data feed is located.
Fault (dict) --
The fault codes for the Spot Instance request, if any.
Code (string) --
The reason code for the Spot Instance state change.
Message (string) --
The message for the Spot Instance state change.
OwnerId (string) --
The account ID of the account.
Prefix (string) --
The prefix for the data feed files.
State (string) --
The state of the Spot Instance data feed subscription.
Examples
This example creates a Spot Instance data feed for your AWS account.
response = client.create_spot_datafeed_subscription(
Bucket='my-s3-bucket',
Prefix='spotdata',
)
print(response)
Expected Output:
{
'SpotDatafeedSubscription': {
'Bucket': 'my-s3-bucket',
'OwnerId': '123456789012',
'Prefix': 'spotdata',
'State': 'Active',
},
'ResponseMetadata': {
'...': '...',
},
}
Stores an AMI as a single object in an S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using S3 in the Amazon Elastic Compute Cloud User Guide .
For more information, see Store and restore an AMI using S3 in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_store_image_task(
ImageId='string',
Bucket='string',
S3ObjectTags=[
{
'Key': 'string',
'Value': 'string'
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the AMI.
[REQUIRED]
The name of the S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed.
The tags to apply to the AMI object that will be stored in the S3 bucket.
The tags to apply to the AMI object that will be stored in the S3 bucket. For more information, see Categorizing your storage using tags in the Amazon Simple Storage Service User Guide .
The key of the tag.
Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in length. May not begin with aws :.
The value of the tag.
Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in length.
dict
Response Syntax
{
'ObjectKey': 'string'
}
Response Structure
(dict) --
ObjectKey (string) --
The name of the stored AMI object in the S3 bucket.
Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
Warning
AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_subnet(
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
AvailabilityZone='string',
AvailabilityZoneId='string',
CidrBlock='string',
Ipv6CidrBlock='string',
OutpostArn='string',
VpcId='string',
DryRun=True|False
)
The tags to assign to the subnet.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The Availability Zone or Local Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a . For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide .
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
[REQUIRED]
The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .
[REQUIRED]
The ID of the VPC.
dict
Response Syntax
{
'Subnet': {
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'AvailableIpAddressCount': 123,
'CidrBlock': 'string',
'DefaultForAz': True|False,
'MapPublicIpOnLaunch': True|False,
'MapCustomerOwnedIpOnLaunch': True|False,
'CustomerOwnedIpv4Pool': 'string',
'State': 'pending'|'available',
'SubnetId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'AssignIpv6AddressOnCreation': True|False,
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SubnetArn': 'string',
'OutpostArn': 'string'
}
}
Response Structure
(dict) --
Subnet (dict) --
Information about the subnet.
AvailabilityZone (string) --
The Availability Zone of the subnet.
AvailabilityZoneId (string) --
The AZ ID of the subnet.
AvailableIpAddressCount (integer) --
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
CidrBlock (string) --
The IPv4 CIDR block assigned to the subnet.
DefaultForAz (boolean) --
Indicates whether this is the default subnet for the Availability Zone.
MapPublicIpOnLaunch (boolean) --
Indicates whether instances launched in this subnet receive a public IPv4 address.
MapCustomerOwnedIpOnLaunch (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives a customer-owned IPv4 address.
CustomerOwnedIpv4Pool (string) --
The customer-owned IPv4 address pool associated with the subnet.
State (string) --
The current state of the subnet.
SubnetId (string) --
The ID of the subnet.
VpcId (string) --
The ID of the VPC the subnet is in.
OwnerId (string) --
The ID of the AWS account that owns the subnet.
AssignIpv6AddressOnCreation (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives an IPv6 address.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the subnet.
(dict) --
Describes an IPv6 CIDR block associated with a subnet.
AssociationId (string) --
The association ID for the CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of a CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
Tags (list) --
Any tags assigned to the subnet.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Examples
This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.
response = client.create_subnet(
CidrBlock='10.0.1.0/24',
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'Subnet': {
'AvailabilityZone': 'us-west-2c',
'AvailableIpAddressCount': 251,
'CidrBlock': '10.0.1.0/24',
'State': 'pending',
'SubnetId': 'subnet-9d4a7b6c',
'VpcId': 'vpc-a01106c2',
},
'ResponseMetadata': {
'...': '...',
},
}
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
DryRun=True|False,
Resources=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
None
Examples
This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.
response = client.create_tags(
Resources=[
'ami-78a54011',
],
Tags=[
{
'Key': 'Stack',
'Value': 'production',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
See also: AWS API Documentation
Request Syntax
response = client.create_traffic_mirror_filter(
Description='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
ClientToken='string'
)
The tags to assign to a Traffic Mirror filter.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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
{
'TrafficMirrorFilter': {
'TrafficMirrorFilterId': 'string',
'IngressFilterRules': [
{
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
],
'EgressFilterRules': [
{
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
],
'NetworkServices': [
'amazon-dns',
],
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
TrafficMirrorFilter (dict) --
Information about the Traffic Mirror filter.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
IngressFilterRules (list) --
Information about the ingress rules that are associated with the Traffic Mirror filter.
(dict) --
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
EgressFilterRules (list) --
Information about the egress rules that are associated with the Traffic Mirror filter.
(dict) --
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
NetworkServices (list) --
The network service traffic that is associated with the Traffic Mirror filter.
Description (string) --
The description of the Traffic Mirror filter.
Tags (list) --
The tags assigned to the Traffic Mirror filter.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .
Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
See also: AWS API Documentation
Request Syntax
response = client.create_traffic_mirror_filter_rule(
TrafficMirrorFilterId='string',
TrafficDirection='ingress'|'egress',
RuleNumber=123,
RuleAction='accept'|'reject',
DestinationPortRange={
'FromPort': 123,
'ToPort': 123
},
SourcePortRange={
'FromPort': 123,
'ToPort': 123
},
Protocol=123,
DestinationCidrBlock='string',
SourceCidrBlock='string',
Description='string',
DryRun=True|False,
ClientToken='string'
)
[REQUIRED]
The ID of the filter that this rule is associated with.
[REQUIRED]
The type of traffic (ingress | egress ).
[REQUIRED]
The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
[REQUIRED]
The action to take (accept | reject ) on the filtered traffic.
The destination port range.
The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
The source port range.
The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
[REQUIRED]
The destination CIDR block to assign to the Traffic Mirror rule.
[REQUIRED]
The source CIDR block to assign to the Traffic Mirror rule.
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
{
'TrafficMirrorFilterRule': {
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
'ClientToken': 'string'
}
Response Structure
(dict) --
TrafficMirrorFilterRule (dict) --
The Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .
Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
See also: AWS API Documentation
Request Syntax
response = client.create_traffic_mirror_session(
NetworkInterfaceId='string',
TrafficMirrorTargetId='string',
TrafficMirrorFilterId='string',
PacketLength=123,
SessionNumber=123,
VirtualNetworkId=123,
Description='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
ClientToken='string'
)
[REQUIRED]
The ID of the source network interface.
[REQUIRED]
The ID of the Traffic Mirror target.
[REQUIRED]
The ID of the Traffic Mirror filter.
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
[REQUIRED]
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
The tags to assign to a Traffic Mirror session.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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
{
'TrafficMirrorSession': {
'TrafficMirrorSessionId': 'string',
'TrafficMirrorTargetId': 'string',
'TrafficMirrorFilterId': 'string',
'NetworkInterfaceId': 'string',
'OwnerId': 'string',
'PacketLength': 123,
'SessionNumber': 123,
'VirtualNetworkId': 123,
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
TrafficMirrorSession (dict) --
Information about the Traffic Mirror session.
TrafficMirrorSessionId (string) --
The ID for the Traffic Mirror session.
TrafficMirrorTargetId (string) --
The ID of the Traffic Mirror target.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
NetworkInterfaceId (string) --
The ID of the Traffic Mirror session's network interface.
OwnerId (string) --
The ID of the account that owns the Traffic Mirror session.
PacketLength (integer) --
The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet
SessionNumber (integer) --
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
VirtualNetworkId (integer) --
The virtual network ID associated with the Traffic Mirror session.
Description (string) --
The description of the Traffic Mirror session.
Tags (list) --
The tags assigned to the Traffic Mirror session.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .
Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, or a Network Load Balancer.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession .
See also: AWS API Documentation
Request Syntax
response = client.create_traffic_mirror_target(
NetworkInterfaceId='string',
NetworkLoadBalancerArn='string',
Description='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False,
ClientToken='string'
)
The tags to assign to the Traffic Mirror target.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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
{
'TrafficMirrorTarget': {
'TrafficMirrorTargetId': 'string',
'NetworkInterfaceId': 'string',
'NetworkLoadBalancerArn': 'string',
'Type': 'network-interface'|'network-load-balancer',
'Description': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
TrafficMirrorTarget (dict) --
Information about the Traffic Mirror target.
TrafficMirrorTargetId (string) --
The ID of the Traffic Mirror target.
NetworkInterfaceId (string) --
The network interface ID that is attached to the target.
NetworkLoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the Network Load Balancer.
Type (string) --
The type of Traffic Mirror target.
Description (string) --
Information about the Traffic Mirror target.
OwnerId (string) --
The ID of the account that owns the Traffic Mirror target.
Tags (list) --
The tags assigned to the Traffic Mirror target.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .
Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment .
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection .
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway(
Description='string',
Options={
'AmazonSideAsn': 123,
'AutoAcceptSharedAttachments': 'enable'|'disable',
'DefaultRouteTableAssociation': 'enable'|'disable',
'DefaultRouteTablePropagation': 'enable'|'disable',
'VpnEcmpSupport': 'enable'|'disable',
'DnsSupport': 'enable'|'disable',
'MulticastSupport': 'enable'|'disable',
'TransitGatewayCidrBlocks': [
'string',
]
},
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
The transit gateway options.
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512 .
Enable or disable automatic acceptance of attachment requests. Disabled by default.
Enable or disable automatic association with the default association route table. Enabled by default.
Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
Enable or disable DNS support. Enabled by default.
Indicates whether multicast is enabled on the transit gateway
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
The tags to apply to the transit gateway.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'TransitGateway': {
'TransitGatewayId': 'string',
'TransitGatewayArn': 'string',
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'OwnerId': 'string',
'Description': 'string',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'AmazonSideAsn': 123,
'TransitGatewayCidrBlocks': [
'string',
],
'AutoAcceptSharedAttachments': 'enable'|'disable',
'DefaultRouteTableAssociation': 'enable'|'disable',
'AssociationDefaultRouteTableId': 'string',
'DefaultRouteTablePropagation': 'enable'|'disable',
'PropagationDefaultRouteTableId': 'string',
'VpnEcmpSupport': 'enable'|'disable',
'DnsSupport': 'enable'|'disable',
'MulticastSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGateway (dict) --
Information about the transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (string) --
The state of the transit gateway.
OwnerId (string) --
The ID of the AWS account ID that owns the transit gateway.
Description (string) --
The description of the transit gateway.
CreationTime (datetime) --
The creation time.
Options (dict) --
The transit gateway options.
AmazonSideAsn (integer) --
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
TransitGatewayCidrBlocks (list) --
The transit gateway CIDR blocks.
AutoAcceptSharedAttachments (string) --
Indicates whether attachment requests are automatically accepted.
DefaultRouteTableAssociation (string) --
Indicates whether resource attachments are automatically associated with the default association route table.
AssociationDefaultRouteTableId (string) --
The ID of the default association route table.
DefaultRouteTablePropagation (string) --
Indicates whether resource attachments automatically propagate routes to the default propagation route table.
PropagationDefaultRouteTableId (string) --
The ID of the default propagation route table.
VpnEcmpSupport (string) --
Indicates whether Equal Cost Multipath Protocol support is enabled.
DnsSupport (string) --
Indicates whether DNS support is enabled.
MulticastSupport (string) --
Indicates whether multicast is enabled on the transit gateway
Tags (list) --
The tags for the transit gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or AWS Direct Connect attachment as the underlying transport mechanism.
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway_connect(
TransportTransitGatewayAttachmentId='string',
Options={
'Protocol': 'gre'
},
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway attachment. You can specify a VPC attachment or a AWS Direct Connect attachment.
[REQUIRED]
The Connect attachment options.
The tunnel protocol.
The tags to apply to the Connect attachment.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'TransitGatewayConnect': {
'TransitGatewayAttachmentId': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'Protocol': 'gre'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayConnect (dict) --
Information about the Connect attachment.
TransitGatewayAttachmentId (string) --
The ID of the Connect attachment.
TransportTransitGatewayAttachmentId (string) --
The ID of the attachment from which the Connect attachment was created.
TransitGatewayId (string) --
The ID of the transit gateway.
State (string) --
The state of the attachment.
CreationTime (datetime) --
The creation time.
Options (dict) --
The Connect attachment options.
Protocol (string) --
The tunnel protocol.
Tags (list) --
The tags for the attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway_connect_peer(
TransitGatewayAttachmentId='string',
TransitGatewayAddress='string',
PeerAddress='string',
BgpOptions={
'PeerAsn': 123
},
InsideCidrBlocks=[
'string',
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the Connect attachment.
[REQUIRED]
The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
The BGP options for the Connect peer.
The peer Autonomous System Number (ASN).
[REQUIRED]
The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.
The tags to apply to the Connect peer.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'TransitGatewayConnectPeer': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayConnectPeerId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CreationTime': datetime(2015, 1, 1),
'ConnectPeerConfiguration': {
'TransitGatewayAddress': 'string',
'PeerAddress': 'string',
'InsideCidrBlocks': [
'string',
],
'Protocol': 'gre',
'BgpConfigurations': [
{
'TransitGatewayAsn': 123,
'PeerAsn': 123,
'TransitGatewayAddress': 'string',
'PeerAddress': 'string',
'BgpStatus': 'up'|'down'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayConnectPeer (dict) --
Information about the Connect peer.
TransitGatewayAttachmentId (string) --
The ID of the Connect attachment.
TransitGatewayConnectPeerId (string) --
The ID of the Connect peer.
State (string) --
The state of the Connect peer.
CreationTime (datetime) --
The creation time.
ConnectPeerConfiguration (dict) --
The Connect peer details.
TransitGatewayAddress (string) --
The Connect peer IP address on the transit gateway side of the tunnel.
PeerAddress (string) --
The Connect peer IP address on the appliance side of the tunnel.
InsideCidrBlocks (list) --
The range of interior BGP peer IP addresses.
Protocol (string) --
The tunnel protocol.
BgpConfigurations (list) --
The BGP configuration details.
(dict) --
The BGP configuration information.
TransitGatewayAsn (integer) --
The transit gateway Autonomous System Number (ASN).
PeerAsn (integer) --
The peer Autonomous System Number (ASN).
TransitGatewayAddress (string) --
The interior BGP peer IP address for the transit gateway.
PeerAddress (string) --
The interior BGP peer IP address for the appliance.
BgpStatus (string) --
The BGP status.
Tags (list) --
The tags for the Connect peer.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway_multicast_domain(
TransitGatewayId='string',
Options={
'Igmpv2Support': 'enable'|'disable',
'StaticSourcesSupport': 'enable'|'disable',
'AutoAcceptSharedAssociations': 'enable'|'disable'
},
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway.
The options for the transit gateway multicast domain.
Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
Specify whether to enable support for statically configuring multicast group sources for a domain.
Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
The tags for the transit gateway multicast domain.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'TransitGatewayMulticastDomain': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayMulticastDomainArn': 'string',
'OwnerId': 'string',
'Options': {
'Igmpv2Support': 'enable'|'disable',
'StaticSourcesSupport': 'enable'|'disable',
'AutoAcceptSharedAssociations': 'enable'|'disable'
},
'State': 'pending'|'available'|'deleting'|'deleted',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayMulticastDomain (dict) --
Information about the transit gateway multicast domain.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayMulticastDomainArn (string) --
The Amazon Resource Name (ARN) of the transit gateway multicast domain.
OwnerId (string) --
The ID of the AWS account that owns the transit gateway multiicast domain.
Options (dict) --
The options for the transit gateway multicast domain.
Igmpv2Support (string) --
Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
StaticSourcesSupport (string) --
Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
AutoAcceptSharedAssociations (string) --
Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
State (string) --
The state of the transit gateway multicast domain.
CreationTime (datetime) --
The time the transit gateway multicast domain was created.
Tags (list) --
The tags for the transit gateway multicast domain.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway_peering_attachment(
TransitGatewayId='string',
PeerTransitGatewayId='string',
PeerAccountId='string',
PeerRegion='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway.
[REQUIRED]
The ID of the peer transit gateway with which to create the peering attachment.
[REQUIRED]
The AWS account ID of the owner of the peer transit gateway.
[REQUIRED]
The Region where the peer transit gateway is located.
The tags to apply to the transit gateway peering attachment.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
The transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates a reference (route) to a prefix list in a specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway_prefix_list_reference(
TransitGatewayRouteTableId='string',
PrefixListId='string',
TransitGatewayAttachmentId='string',
Blackhole=True|False,
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
[REQUIRED]
The ID of the prefix list that is used for destination matches.
dict
Response Syntax
{
'TransitGatewayPrefixListReference': {
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceId': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayPrefixListReference (dict) --
Information about the prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
Creates a static route for the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway_route(
DestinationCidrBlock='string',
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
Blackhole=True|False,
DryRun=True|False
)
[REQUIRED]
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
[REQUIRED]
The ID of the transit gateway route table.
dict
Response Syntax
{
'Route': {
'DestinationCidrBlock': 'string',
'PrefixListId': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
PrefixListId (string) --
The ID of the prefix list used for destination matches.
TransitGatewayAttachments (list) --
The attachments.
(dict) --
Describes a route attachment.
ResourceId (string) --
The ID of the resource.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
Type (string) --
The route type.
State (string) --
The state of the route.
Creates a route table for the specified transit gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway_route_table(
TransitGatewayId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway.
The tags to apply to the transit gateway route table.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'TransitGatewayRouteTable': {
'TransitGatewayRouteTableId': 'string',
'TransitGatewayId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'DefaultAssociationRouteTable': True|False,
'DefaultPropagationRouteTable': True|False,
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayRouteTable (dict) --
Information about the transit gateway route table.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
TransitGatewayId (string) --
The ID of the transit gateway.
State (string) --
The state of the transit gateway route table.
DefaultAssociationRouteTable (boolean) --
Indicates whether this is the default association route table for the transit gateway.
DefaultPropagationRouteTable (boolean) --
Indicates whether this is the default propagation route table for the transit gateway.
CreationTime (datetime) --
The creation time.
Tags (list) --
Any tags assigned to the route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute .
See also: AWS API Documentation
Request Syntax
response = client.create_transit_gateway_vpc_attachment(
TransitGatewayId='string',
VpcId='string',
SubnetIds=[
'string',
],
Options={
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway.
[REQUIRED]
The ID of the VPC.
[REQUIRED]
The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.
The VPC attachment options.
Enable or disable DNS support. The default is enable .
Enable or disable IPv6 support. The default is disable .
Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable .
The tags to apply to the VPC attachment.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'TransitGatewayVpcAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'VpcId': 'string',
'VpcOwnerId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'SubnetIds': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Options': {
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayVpcAttachment (dict) --
Information about the VPC attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
VpcId (string) --
The ID of the VPC.
VpcOwnerId (string) --
The ID of the AWS account that owns the VPC.
State (string) --
The state of the VPC attachment. Note that the initiating state has been deprecated.
SubnetIds (list) --
The IDs of the subnets.
CreationTime (datetime) --
The creation time.
Options (dict) --
The VPC attachment options.
DnsSupport (string) --
Indicates whether DNS support is enabled.
Ipv6Support (string) --
Indicates whether IPv6 support is disabled.
ApplianceModeSupport (string) --
Indicates whether appliance mode support is enabled.
Tags (list) --
The tags for the VPC attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
You can tag your volumes during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide .
For more information, see Creating an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_volume(
AvailabilityZone='string',
Encrypted=True|False,
Iops=123,
KmsKeyId='string',
OutpostArn='string',
Size=123,
SnapshotId='string',
VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiAttachEnabled=True|False,
Throughput=123
)
[REQUIRED]
The Availability Zone in which to create the volume.
Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide .
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true .
You can specify the CMK using any of the following:
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. This parameter can be one of the following values:
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .
Default: gp2
The tags to apply to the volume during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
dict
Response Syntax
{
'Attachments': [
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
},
],
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Encrypted': True|False,
'KmsKeyId': 'string',
'OutpostArn': 'string',
'Size': 123,
'SnapshotId': 'string',
'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
'VolumeId': 'string',
'Iops': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'FastRestored': True|False,
'MultiAttachEnabled': True|False,
'Throughput': 123
}
Response Structure
(dict) --
Describes a volume.
Attachments (list) --
Information about the volume attachments.
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
AvailabilityZone (string) --
The Availability Zone for the volume.
CreateTime (datetime) --
The time stamp when volume creation was initiated.
Encrypted (boolean) --
Indicates whether the volume is encrypted.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Size (integer) --
The size of the volume, in GiBs.
SnapshotId (string) --
The snapshot from which the volume was created, if applicable.
State (string) --
The volume state.
VolumeId (string) --
The ID of the volume.
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
Tags (list) --
Any tags assigned to the volume.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VolumeType (string) --
The volume type.
FastRestored (boolean) --
Indicates whether the volume was created using fast snapshot restore.
MultiAttachEnabled (boolean) --
Indicates whether Amazon EBS Multi-Attach is enabled.
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
Examples
This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone us-east-1a.
response = client.create_volume(
AvailabilityZone='us-east-1a',
Size=80,
VolumeType='gp2',
)
print(response)
Expected Output:
{
'AvailabilityZone': 'us-east-1a',
'CreateTime': datetime(2016, 8, 29, 18, 52, 32, 0, 242, 0),
'Encrypted': False,
'Iops': 240,
'Size': 80,
'SnapshotId': '',
'State': 'creating',
'VolumeId': 'vol-6b60b7c7',
'VolumeType': 'gp2',
'ResponseMetadata': {
'...': '...',
},
}
This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone us-east-1a.
response = client.create_volume(
AvailabilityZone='us-east-1a',
Iops=1000,
SnapshotId='snap-066877671789bd71b',
VolumeType='io1',
)
print(response)
Expected Output:
{
'Attachments': [
],
'AvailabilityZone': 'us-east-1a',
'CreateTime': datetime(2016, 8, 29, 18, 52, 32, 0, 242, 0),
'Iops': 1000,
'Size': 500,
'SnapshotId': 'snap-066877671789bd71b',
'State': 'creating',
'Tags': [
],
'VolumeId': 'vol-1234567890abcdef0',
'VolumeType': 'io1',
'ResponseMetadata': {
'...': '...',
},
}
Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP ).
By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .
You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_vpc(
CidrBlock='string',
AmazonProvidedIpv6CidrBlock=True|False,
Ipv6Pool='string',
Ipv6CidrBlock='string',
DryRun=True|False,
InstanceTenancy='default'|'dedicated'|'host',
Ipv6CidrBlockNetworkBorderGroup='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .
The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
The tenancy options for instances launched into the VPC. For default , instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated , instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
The tags to assign to the VPC.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Vpc': {
'CidrBlock': 'string',
'DhcpOptionsId': 'string',
'State': 'pending'|'available',
'VpcId': 'string',
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Vpc (dict) --
Information about the VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.
State (string) --
The current state of the VPC.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The ID of the AWS account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1 .
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
Tags (list) --
Any tags assigned to the VPC.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example creates a VPC with the specified CIDR block.
response = client.create_vpc(
CidrBlock='10.0.0.0/16',
)
print(response)
Expected Output:
{
'Vpc': {
'CidrBlock': '10.0.0.0/16',
'DhcpOptionsId': 'dopt-7a8b9c2d',
'InstanceTenancy': 'default',
'State': 'pending',
'VpcId': 'vpc-a01106c2',
},
'ResponseMetadata': {
'...': '...',
},
}
Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace Partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide .
A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint, which will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.
An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.
A GatewayLoadBalancer endpoint is a network interface in your subnet that serves an endpoint for communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service.
Use DescribeVpcEndpointServices to get a list of supported services.
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_endpoint(
DryRun=True|False,
VpcEndpointType='Interface'|'Gateway'|'GatewayLoadBalancer',
VpcId='string',
ServiceName='string',
PolicyDocument='string',
RouteTableIds=[
'string',
],
SubnetIds=[
'string',
],
SecurityGroupIds=[
'string',
],
ClientToken='string',
PrivateDnsEnabled=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The type of endpoint.
Default: Gateway
[REQUIRED]
The ID of the VPC in which the endpoint will be used.
[REQUIRED]
The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.
(Gateway endpoint) One or more route table IDs.
(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.
(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true : enableDnsHostnames and enableDnsSupport . Use ModifyVpcAttribute to set the VPC attributes.
Default: true
The tags to associate with the endpoint.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string',
'LastError': {
'Message': 'string',
'Code': 'string'
}
},
'ClientToken': 'string'
}
Response Structure
(dict) --
Contains the output of CreateVpcEndpoint.
VpcEndpoint (dict) --
Information about the endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcEndpointType (string) --
The type of endpoint.
VpcId (string) --
The ID of the VPC to which the endpoint is associated.
ServiceName (string) --
The name of the service to which the endpoint is associated.
State (string) --
The state of the VPC endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) One or more route tables associated with the endpoint.
SubnetIds (list) --
(Interface endpoint) One or more subnets in which the endpoint is located.
Groups (list) --
(Interface endpoint) Information about the security groups that are associated with the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the VPC endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) One or more network interfaces for the endpoint.
DnsEntries (list) --
(Interface endpoint) The DNS entries for the endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
CreationTimestamp (datetime) --
The date and time that the VPC endpoint was created.
Tags (list) --
Any tags assigned to the VPC endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the AWS account that owns the VPC endpoint.
LastError (dict) --
The last error that occurred for VPC endpoint.
Message (string) --
The error message for the VPC endpoint error.
Code (string) --
The error code for the VPC endpoint error.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide .
You can create a connection notification for interface endpoints only.
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_endpoint_connection_notification(
DryRun=True|False,
ServiceId='string',
VpcEndpointId='string',
ConnectionNotificationArn='string',
ConnectionEvents=[
'string',
],
ClientToken='string'
)
[REQUIRED]
The ARN of the SNS topic for the notifications.
[REQUIRED]
One or more endpoint events for which to receive notifications. Valid values are Accept , Connect , Delete , and Reject .
dict
Response Syntax
{
'ConnectionNotification': {
'ConnectionNotificationId': 'string',
'ServiceId': 'string',
'VpcEndpointId': 'string',
'ConnectionNotificationType': 'Topic',
'ConnectionNotificationArn': 'string',
'ConnectionEvents': [
'string',
],
'ConnectionNotificationState': 'Enabled'|'Disabled'
},
'ClientToken': 'string'
}
Response Structure
(dict) --
ConnectionNotification (dict) --
Information about the notification.
ConnectionNotificationId (string) --
The ID of the notification.
ServiceId (string) --
The ID of the endpoint service.
VpcEndpointId (string) --
The ID of the VPC endpoint.
ConnectionNotificationType (string) --
The type of notification.
ConnectionNotificationArn (string) --
The ARN of the SNS topic for the notification.
ConnectionEvents (list) --
The events for the notification. Valid values are Accept , Connect , Delete , and Reject .
ConnectionNotificationState (string) --
The state of the notification.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.
To create an endpoint service configuration, you must first create one of the following for your service:
For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide .
If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_endpoint_service_configuration(
DryRun=True|False,
AcceptanceRequired=True|False,
PrivateDnsName='string',
NetworkLoadBalancerArns=[
'string',
],
GatewayLoadBalancerArns=[
'string',
],
ClientToken='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
The tags to associate with the service.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ServiceConfiguration': {
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
},
],
'ServiceId': 'string',
'ServiceName': 'string',
'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
'AvailabilityZones': [
'string',
],
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'NetworkLoadBalancerArns': [
'string',
],
'GatewayLoadBalancerArns': [
'string',
],
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'PrivateDnsNameConfiguration': {
'State': 'pendingVerification'|'verified'|'failed',
'Type': 'string',
'Value': 'string',
'Name': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ClientToken': 'string'
}
Response Structure
(dict) --
ServiceConfiguration (dict) --
Information about the service configuration.
ServiceType (list) --
The type of service.
(dict) --
Describes the type of service for a VPC endpoint.
ServiceType (string) --
The type of service.
ServiceId (string) --
The ID of the service.
ServiceName (string) --
The name of the service.
ServiceState (string) --
The service state.
AvailabilityZones (list) --
The Availability Zones in which the service is available.
AcceptanceRequired (boolean) --
Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
ManagesVpcEndpoints (boolean) --
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
NetworkLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
GatewayLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
BaseEndpointDnsNames (list) --
The DNS names for the service.
PrivateDnsName (string) --
The private DNS name for the service.
PrivateDnsNameConfiguration (dict) --
Information about the endpoint service private DNS name configuration.
State (string) --
The verification state of the VPC endpoint service.
>Consumers of the endpoint service can use the private name only when the state is verified .
Type (string) --
The endpoint service verification type, for example TXT.
Value (string) --
The value the service provider adds to the private DNS name domain record before verification.
Name (string) --
The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name .
Tags (list) --
Any tags assigned to the service.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Note
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide .
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed .
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_peering_connection(
DryRun=True|False,
PeerOwnerId='string',
PeerVpcId='string',
VpcId='string',
PeerRegion='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
The tags to assign to the peering connection.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'VpcPeeringConnection': {
'AccepterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'ExpirationTime': datetime(2015, 1, 1),
'RequesterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcPeeringConnectionId': 'string'
}
}
Response Structure
(dict) --
VpcPeeringConnection (dict) --
Information about the VPC peering connection.
AccepterVpcInfo (dict) --
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
ExpirationTime (datetime) --
The time that an unaccepted VPC peering connection will expire.
RequesterVpcInfo (dict) --
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
Status (dict) --
The status of the VPC peering connection.
Code (string) --
The status of the VPC peering connection.
Message (string) --
A message that provides more information about the status, if applicable.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1 .
The response includes information that you need to give to your network administrator to configure your customer gateway.
Warning
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_vpn_connection(
CustomerGatewayId='string',
Type='string',
VpnGatewayId='string',
TransitGatewayId='string',
DryRun=True|False,
Options={
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DPDTimeoutSeconds': 123,
'DPDTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IKEVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string'
},
],
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string'
},
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the customer gateway.
[REQUIRED]
The type of VPN connection (ipsec.1 ).
The options for the VPN connection.
Indicate whether to enable acceleration for the VPN connection.
Default: false
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true . Use CreateVpnConnectionRoute to create a static route.
Default: false
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
The tunnel options for the VPN connection.
The tunnel options for a single VPN tunnel.
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds .
Default: 3600
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage .
Constraints: A value between 60 and half of Phase2LifetimeSeconds .
Default: 540
The percentage of the rekey window (determined by RekeyMarginTimeSeconds ) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
The number of seconds after which a DPD timeout occurs.
Constraints: A value between 0 and 30.
Default: 30
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.
The value for the encryption algorithm.
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.
The encryption algorithm.
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.
The value for the integrity algorithm.
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
The integrity algorithm.
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.
The Diffie-Hellmann group number.
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.
The Diffie-Hellmann group number.
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
The IKE version that is permitted for the VPN tunnel.
The IKE version.
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation.
Valid Values: add | start
Default: add
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
The tags to apply to the VPN connection.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'VpnConnection': {
'CustomerGatewayConfiguration': 'string',
'CustomerGatewayId': 'string',
'Category': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Type': 'ipsec.1',
'VpnConnectionId': 'string',
'VpnGatewayId': 'string',
'TransitGatewayId': 'string',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string'
},
]
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
]
}
}
Response Structure
(dict) --
Contains the output of CreateVpnConnection.
VpnConnection (dict) --
Information about the VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_vpn_connection_route(
DestinationCidrBlock='string',
VpnConnectionId='string'
)
[REQUIRED]
The CIDR block associated with the local subnet of the customer network.
[REQUIRED]
The ID of the VPN connection.
None
Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_vpn_gateway(
AvailabilityZone='string',
Type='ipsec.1',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
AmazonSideAsn=123,
DryRun=True|False
)
[REQUIRED]
The type of VPN connection this virtual private gateway supports.
The tags to apply to the virtual private gateway.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
dict
Response Syntax
{
'VpnGateway': {
'AvailabilityZone': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Type': 'ipsec.1',
'VpcAttachments': [
{
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
},
],
'VpnGatewayId': 'string',
'AmazonSideAsn': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Contains the output of CreateVpnGateway.
VpnGateway (dict) --
Information about the virtual private gateway.
AvailabilityZone (string) --
The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
State (string) --
The current state of the virtual private gateway.
Type (string) --
The type of VPN connection the virtual private gateway supports.
VpcAttachments (list) --
Any VPCs attached to the virtual private gateway.
(dict) --
Describes an attachment between a virtual private gateway and a VPC.
State (string) --
The current state of the attachment.
VpcId (string) --
The ID of the VPC.
VpnGatewayId (string) --
The ID of the virtual private gateway.
AmazonSideAsn (integer) --
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
Tags (list) --
Any tags assigned to the virtual private gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes a carrier gateway.
Warning
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute .
See also: AWS API Documentation
Request Syntax
response = client.delete_carrier_gateway(
CarrierGatewayId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the carrier gateway.
dict
Response Syntax
{
'CarrierGateway': {
'CarrierGatewayId': 'string',
'VpcId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
CarrierGateway (dict) --
Information about the carrier gateway.
CarrierGatewayId (string) --
The ID of the carrier gateway.
VpcId (string) --
The ID of the VPC associated with the carrier gateway.
State (string) --
The state of the carrier gateway.
OwnerId (string) --
The AWS account ID of the owner of the carrier gateway.
Tags (list) --
The tags assigned to the carrier gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_client_vpn_endpoint(
ClientVpnEndpointId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN to be deleted.
dict
Response Syntax
{
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted',
'Message': 'string'
}
}
Response Structure
(dict) --
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
Message (string) --
A message about the status of the Client VPN endpoint.
Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_client_vpn_route(
ClientVpnEndpointId='string',
TargetVpcSubnetId='string',
DestinationCidrBlock='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint from which the route is to be deleted.
[REQUIRED]
The IPv4 address range, in CIDR notation, of the route to be deleted.
dict
Response Syntax
{
'Status': {
'Code': 'creating'|'active'|'failed'|'deleting',
'Message': 'string'
}
}
Response Structure
(dict) --
Status (dict) --
The current state of the route.
Code (string) --
The state of the Client VPN endpoint route.
Message (string) --
A message about the status of the Client VPN endpoint route, if applicable.
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
See also: AWS API Documentation
Request Syntax
response = client.delete_customer_gateway(
CustomerGatewayId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the customer gateway.
None
Examples
This example deletes the specified customer gateway.
response = client.delete_customer_gateway(
CustomerGatewayId='cgw-0e11f167',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
See also: AWS API Documentation
Request Syntax
response = client.delete_dhcp_options(
DhcpOptionsId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the DHCP options set.
None
Examples
This example deletes the specified DHCP options set.
response = client.delete_dhcp_options(
DhcpOptionsId='dopt-d9070ebb',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes an egress-only internet gateway.
See also: AWS API Documentation
Request Syntax
response = client.delete_egress_only_internet_gateway(
DryRun=True|False,
EgressOnlyInternetGatewayId='string'
)
[REQUIRED]
The ID of the egress-only internet gateway.
dict
Response Syntax
{
'ReturnCode': True|False
}
Response Structure
(dict) --
ReturnCode (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
For more information, see Deleting an EC2 Fleet in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_fleets(
DryRun=True|False,
FleetIds=[
'string',
],
TerminateInstances=True|False
)
[REQUIRED]
The IDs of the EC2 Fleets.
[REQUIRED]
Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances . Supported only for fleets of type maintain and request .
For instant fleets, you cannot specify NoTerminateInstances . A deleted instant fleet with running instances is not supported.
dict
Response Syntax
{
'SuccessfulFleetDeletions': [
{
'CurrentFleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying',
'PreviousFleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying',
'FleetId': 'string'
},
],
'UnsuccessfulFleetDeletions': [
{
'Error': {
'Code': 'fleetIdDoesNotExist'|'fleetIdMalformed'|'fleetNotInDeletableState'|'unexpectedError',
'Message': 'string'
},
'FleetId': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulFleetDeletions (list) --
Information about the EC2 Fleets that are successfully deleted.
(dict) --
Describes an EC2 Fleet that was successfully deleted.
CurrentFleetState (string) --
The current state of the EC2 Fleet.
PreviousFleetState (string) --
The previous state of the EC2 Fleet.
FleetId (string) --
The ID of the EC2 Fleet.
UnsuccessfulFleetDeletions (list) --
Information about the EC2 Fleets that are not successfully deleted.
(dict) --
Describes an EC2 Fleet that was not successfully deleted.
Error (dict) --
The error.
Code (string) --
The error code.
Message (string) --
The description for the error code.
FleetId (string) --
The ID of the EC2 Fleet.
Deletes one or more flow logs.
See also: AWS API Documentation
Request Syntax
response = client.delete_flow_logs(
DryRun=True|False,
FlowLogIds=[
'string',
]
)
[REQUIRED]
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
dict
Response Syntax
{
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Unsuccessful (list) --
Information about the flow logs that could not be deleted successfully.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
Deletes the specified Amazon FPGA Image (AFI).
See also: AWS API Documentation
Request Syntax
response = client.delete_fpga_image(
DryRun=True|False,
FpgaImageId='string'
)
[REQUIRED]
The ID of the AFI.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Is true if the request succeeds, and an error otherwise.
Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
See also: AWS API Documentation
Request Syntax
response = client.delete_internet_gateway(
DryRun=True|False,
InternetGatewayId='string'
)
[REQUIRED]
The ID of the internet gateway.
None
Examples
This example deletes the specified Internet gateway.
response = client.delete_internet_gateway(
InternetGatewayId='igw-c0a643a9',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified key pair, by removing the public key from Amazon EC2.
See also: AWS API Documentation
Request Syntax
response = client.delete_key_pair(
KeyName='string',
KeyPairId='string',
DryRun=True|False
)
None
Examples
This example deletes the specified key pair.
response = client.delete_key_pair(
KeyName='my-key-pair',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes a launch template. Deleting a launch template deletes all of its versions.
See also: AWS API Documentation
Request Syntax
response = client.delete_launch_template(
DryRun=True|False,
LaunchTemplateId='string',
LaunchTemplateName='string'
)
dict
Response Syntax
{
'LaunchTemplate': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersionNumber': 123,
'LatestVersionNumber': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
LaunchTemplate (dict) --
Information about the launch template.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
CreateTime (datetime) --
The time launch template was created.
CreatedBy (string) --
The principal that created the launch template.
DefaultVersionNumber (integer) --
The version number of the default version of the launch template.
LatestVersionNumber (integer) --
The version number of the latest version of the launch template.
Tags (list) --
The tags for the launch template.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example deletes the specified launch template.
response = client.delete_launch_template(
LaunchTemplateId='lt-0abcd290751193123',
)
print(response)
Expected Output:
{
'LaunchTemplate': {
'CreateTime': datetime(2017, 11, 23, 16, 46, 25, 3, 327, 0),
'CreatedBy': 'arn:aws:iam::123456789012:root',
'DefaultVersionNumber': 2,
'LatestVersionNumber': 2,
'LaunchTemplateId': 'lt-0abcd290751193123',
'LaunchTemplateName': 'my-template',
},
'ResponseMetadata': {
'...': '...',
},
}
Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate .
See also: AWS API Documentation
Request Syntax
response = client.delete_launch_template_versions(
DryRun=True|False,
LaunchTemplateId='string',
LaunchTemplateName='string',
Versions=[
'string',
]
)
[REQUIRED]
The version numbers of one or more launch template versions to delete.
dict
Response Syntax
{
'SuccessfullyDeletedLaunchTemplateVersions': [
{
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'VersionNumber': 123
},
],
'UnsuccessfullyDeletedLaunchTemplateVersions': [
{
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'VersionNumber': 123,
'ResponseError': {
'Code': 'launchTemplateIdDoesNotExist'|'launchTemplateIdMalformed'|'launchTemplateNameDoesNotExist'|'launchTemplateNameMalformed'|'launchTemplateVersionDoesNotExist'|'unexpectedError',
'Message': 'string'
}
},
]
}
Response Structure
(dict) --
SuccessfullyDeletedLaunchTemplateVersions (list) --
Information about the launch template versions that were successfully deleted.
(dict) --
Describes a launch template version that was successfully deleted.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
VersionNumber (integer) --
The version number of the launch template.
UnsuccessfullyDeletedLaunchTemplateVersions (list) --
Information about the launch template versions that could not be deleted.
(dict) --
Describes a launch template version that could not be deleted.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
VersionNumber (integer) --
The version number of the launch template.
ResponseError (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message, if applicable.
Examples
This example deletes the specified launch template version.
response = client.delete_launch_template_versions(
LaunchTemplateId='lt-0abcd290751193123',
Versions=[
'1',
],
)
print(response)
Expected Output:
{
'SuccessfullyDeletedLaunchTemplateVersions': [
{
'LaunchTemplateId': 'lt-0abcd290751193123',
'LaunchTemplateName': 'my-template',
'VersionNumber': 1,
},
],
'UnsuccessfullyDeletedLaunchTemplateVersions': [
],
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified route from the specified local gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.delete_local_gateway_route(
DestinationCidrBlock='string',
LocalGatewayRouteTableId='string',
DryRun=True|False
)
[REQUIRED]
The CIDR range for the route. This must match the CIDR for the route exactly.
[REQUIRED]
The ID of the local gateway route table.
dict
Response Syntax
{
'Route': {
'DestinationCidrBlock': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
Type (string) --
The route type.
State (string) --
The state of the route.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
OwnerId (string) --
The AWS account ID that owns the local gateway route.
Deletes the specified association between a VPC and local gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.delete_local_gateway_route_table_vpc_association(
LocalGatewayRouteTableVpcAssociationId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the association.
dict
Response Syntax
{
'LocalGatewayRouteTableVpcAssociation': {
'LocalGatewayRouteTableVpcAssociationId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
LocalGatewayRouteTableVpcAssociation (dict) --
Information about the association.
LocalGatewayRouteTableVpcAssociationId (string) --
The ID of the association.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the association.
LocalGatewayId (string) --
The ID of the local gateway.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The AWS account ID that owns the local gateway route table for the association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
See also: AWS API Documentation
Request Syntax
response = client.delete_managed_prefix_list(
DryRun=True|False,
PrefixListId='string'
)
[REQUIRED]
The ID of the prefix list.
dict
Response Syntax
{
'PrefixList': {
'PrefixListId': 'string',
'AddressFamily': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'PrefixListArn': 'string',
'PrefixListName': 'string',
'MaxEntries': 123,
'Version': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string'
}
}
Response Structure
(dict) --
PrefixList (dict) --
Information about the prefix list.
PrefixListId (string) --
The ID of the prefix list.
AddressFamily (string) --
The IP address version.
State (string) --
The state of the prefix list.
StateMessage (string) --
The state message.
PrefixListArn (string) --
The Amazon Resource Name (ARN) for the prefix list.
PrefixListName (string) --
The name of the prefix list.
MaxEntries (integer) --
The maximum number of entries for the prefix list.
Version (integer) --
The version of the prefix list.
Tags (list) --
The tags for the prefix list.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the owner of the prefix list.
Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.
See also: AWS API Documentation
Request Syntax
response = client.delete_nat_gateway(
DryRun=True|False,
NatGatewayId='string'
)
[REQUIRED]
The ID of the NAT gateway.
dict
Response Syntax
{
'NatGatewayId': 'string'
}
Response Structure
(dict) --
NatGatewayId (string) --
The ID of the NAT gateway.
Examples
This example deletes the specified NAT gateway.
response = client.delete_nat_gateway(
NatGatewayId='nat-04ae55e711cec5680',
)
print(response)
Expected Output:
{
'NatGatewayId': 'nat-04ae55e711cec5680',
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
See also: AWS API Documentation
Request Syntax
response = client.delete_network_acl(
DryRun=True|False,
NetworkAclId='string'
)
[REQUIRED]
The ID of the network ACL.
None
Examples
This example deletes the specified network ACL.
response = client.delete_network_acl(
NetworkAclId='acl-5fb85d36',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
See also: AWS API Documentation
Request Syntax
response = client.delete_network_acl_entry(
DryRun=True|False,
Egress=True|False,
NetworkAclId='string',
RuleNumber=123
)
[REQUIRED]
Indicates whether the rule is an egress rule.
[REQUIRED]
The ID of the network ACL.
[REQUIRED]
The rule number of the entry to delete.
None
Examples
This example deletes ingress rule number 100 from the specified network ACL.
response = client.delete_network_acl_entry(
Egress=True,
NetworkAclId='acl-5fb85d36',
RuleNumber=100,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified network insights analysis.
See also: AWS API Documentation
Request Syntax
response = client.delete_network_insights_analysis(
DryRun=True|False,
NetworkInsightsAnalysisId='string'
)
[REQUIRED]
The ID of the network insights analysis.
dict
Response Syntax
{
'NetworkInsightsAnalysisId': 'string'
}
Response Structure
(dict) --
NetworkInsightsAnalysisId (string) --
The ID of the network insights analysis.
Deletes the specified path.
See also: AWS API Documentation
Request Syntax
response = client.delete_network_insights_path(
DryRun=True|False,
NetworkInsightsPathId='string'
)
[REQUIRED]
The ID of the path.
dict
Response Syntax
{
'NetworkInsightsPathId': 'string'
}
Response Structure
(dict) --
NetworkInsightsPathId (string) --
The ID of the path.
Deletes the specified network interface. You must detach the network interface before you can delete it.
See also: AWS API Documentation
Request Syntax
response = client.delete_network_interface(
DryRun=True|False,
NetworkInterfaceId='string'
)
[REQUIRED]
The ID of the network interface.
None
Examples
This example deletes the specified network interface.
response = client.delete_network_interface(
NetworkInterfaceId='eni-e5aa89a3',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.
See also: AWS API Documentation
Request Syntax
response = client.delete_network_interface_permission(
NetworkInterfacePermissionId='string',
Force=True|False,
DryRun=True|False
)
[REQUIRED]
The ID of the network interface permission.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Contains the output for DeleteNetworkInterfacePermission.
Return (boolean) --
Returns true if the request succeeds, otherwise returns an error.
Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_placement_group(
DryRun=True|False,
GroupName='string'
)
[REQUIRED]
The name of the placement group.
None
Examples
This example deletes the specified placement group.
response = client.delete_placement_group(
GroupName='my-cluster',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the queued purchases for the specified Reserved Instances.
See also: AWS API Documentation
Request Syntax
response = client.delete_queued_reserved_instances(
DryRun=True|False,
ReservedInstancesIds=[
'string',
]
)
[REQUIRED]
The IDs of the Reserved Instances.
dict
Response Syntax
{
'SuccessfulQueuedPurchaseDeletions': [
{
'ReservedInstancesId': 'string'
},
],
'FailedQueuedPurchaseDeletions': [
{
'Error': {
'Code': 'reserved-instances-id-invalid'|'reserved-instances-not-in-queued-state'|'unexpected-error',
'Message': 'string'
},
'ReservedInstancesId': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulQueuedPurchaseDeletions (list) --
Information about the queued purchases that were successfully deleted.
(dict) --
Describes a Reserved Instance whose queued purchase was successfully deleted.
ReservedInstancesId (string) --
The ID of the Reserved Instance.
FailedQueuedPurchaseDeletions (list) --
Information about the queued purchases that could not be deleted.
(dict) --
Describes a Reserved Instance whose queued purchase was not deleted.
Error (dict) --
The error.
Code (string) --
The error code.
Message (string) --
The error message.
ReservedInstancesId (string) --
The ID of the Reserved Instance.
Deletes the specified route from the specified route table.
See also: AWS API Documentation
Request Syntax
response = client.delete_route(
DestinationCidrBlock='string',
DestinationIpv6CidrBlock='string',
DestinationPrefixListId='string',
DryRun=True|False,
RouteTableId='string'
)
[REQUIRED]
The ID of the route table.
None
Examples
This example deletes the specified route from the specified route table.
response = client.delete_route(
DestinationCidrBlock='0.0.0.0/0',
RouteTableId='rtb-22574640',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
See also: AWS API Documentation
Request Syntax
response = client.delete_route_table(
DryRun=True|False,
RouteTableId='string'
)
[REQUIRED]
The ID of the route table.
None
Examples
This example deletes the specified route table.
response = client.delete_route_table(
RouteTableId='rtb-22574640',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
See also: AWS API Documentation
Request Syntax
response = client.delete_security_group(
GroupId='string',
GroupName='string',
DryRun=True|False
)
None
Examples
This example deletes the specified security group.
response = client.delete_security_group(
GroupId='sg-903004f8',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Deleting an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_snapshot(
SnapshotId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the EBS snapshot.
None
Examples
This example deletes a snapshot with the snapshot ID of snap-1234567890abcdef0. If the command succeeds, no output is returned.
response = client.delete_snapshot(
SnapshotId='snap-1234567890abcdef0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the data feed for Spot Instances.
See also: AWS API Documentation
Request Syntax
response = client.delete_spot_datafeed_subscription(
DryRun=True|False
)
Examples
This example deletes a Spot data feed subscription for the account.
response = client.delete_spot_datafeed_subscription(
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
See also: AWS API Documentation
Request Syntax
response = client.delete_subnet(
SubnetId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the subnet.
None
Examples
This example deletes the specified subnet.
response = client.delete_subnet(
SubnetId='subnet-9d4a7b6c',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags . For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_tags(
DryRun=True|False,
Resources=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix).
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
None
Examples
This example deletes the tag Stack=test from the specified image.
response = client.delete_tags(
Resources=[
'ami-78a54011',
],
Tags=[
{
'Key': 'Stack',
'Value': 'test',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
See also: AWS API Documentation
Request Syntax
response = client.delete_traffic_mirror_filter(
TrafficMirrorFilterId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Traffic Mirror filter.
dict
Response Syntax
{
'TrafficMirrorFilterId': 'string'
}
Response Structure
(dict) --
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
Deletes the specified Traffic Mirror rule.
See also: AWS API Documentation
Request Syntax
response = client.delete_traffic_mirror_filter_rule(
TrafficMirrorFilterRuleId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Traffic Mirror rule.
dict
Response Syntax
{
'TrafficMirrorFilterRuleId': 'string'
}
Response Structure
(dict) --
TrafficMirrorFilterRuleId (string) --
The ID of the deleted Traffic Mirror rule.
Deletes the specified Traffic Mirror session.
See also: AWS API Documentation
Request Syntax
response = client.delete_traffic_mirror_session(
TrafficMirrorSessionId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Traffic Mirror session.
dict
Response Syntax
{
'TrafficMirrorSessionId': 'string'
}
Response Structure
(dict) --
TrafficMirrorSessionId (string) --
The ID of the deleted Traffic Mirror session.
Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
See also: AWS API Documentation
Request Syntax
response = client.delete_traffic_mirror_target(
TrafficMirrorTargetId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Traffic Mirror target.
dict
Response Syntax
{
'TrafficMirrorTargetId': 'string'
}
Response Structure
(dict) --
TrafficMirrorTargetId (string) --
The ID of the deleted Traffic Mirror target.
Deletes the specified transit gateway.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway(
TransitGatewayId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway.
dict
Response Syntax
{
'TransitGateway': {
'TransitGatewayId': 'string',
'TransitGatewayArn': 'string',
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'OwnerId': 'string',
'Description': 'string',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'AmazonSideAsn': 123,
'TransitGatewayCidrBlocks': [
'string',
],
'AutoAcceptSharedAttachments': 'enable'|'disable',
'DefaultRouteTableAssociation': 'enable'|'disable',
'AssociationDefaultRouteTableId': 'string',
'DefaultRouteTablePropagation': 'enable'|'disable',
'PropagationDefaultRouteTableId': 'string',
'VpnEcmpSupport': 'enable'|'disable',
'DnsSupport': 'enable'|'disable',
'MulticastSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGateway (dict) --
Information about the deleted transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (string) --
The state of the transit gateway.
OwnerId (string) --
The ID of the AWS account ID that owns the transit gateway.
Description (string) --
The description of the transit gateway.
CreationTime (datetime) --
The creation time.
Options (dict) --
The transit gateway options.
AmazonSideAsn (integer) --
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
TransitGatewayCidrBlocks (list) --
The transit gateway CIDR blocks.
AutoAcceptSharedAttachments (string) --
Indicates whether attachment requests are automatically accepted.
DefaultRouteTableAssociation (string) --
Indicates whether resource attachments are automatically associated with the default association route table.
AssociationDefaultRouteTableId (string) --
The ID of the default association route table.
DefaultRouteTablePropagation (string) --
Indicates whether resource attachments automatically propagate routes to the default propagation route table.
PropagationDefaultRouteTableId (string) --
The ID of the default propagation route table.
VpnEcmpSupport (string) --
Indicates whether Equal Cost Multipath Protocol support is enabled.
DnsSupport (string) --
Indicates whether DNS support is enabled.
MulticastSupport (string) --
Indicates whether multicast is enabled on the transit gateway
Tags (list) --
The tags for the transit gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway_connect(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Connect attachment.
dict
Response Syntax
{
'TransitGatewayConnect': {
'TransitGatewayAttachmentId': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'Protocol': 'gre'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayConnect (dict) --
Information about the deleted Connect attachment.
TransitGatewayAttachmentId (string) --
The ID of the Connect attachment.
TransportTransitGatewayAttachmentId (string) --
The ID of the attachment from which the Connect attachment was created.
TransitGatewayId (string) --
The ID of the transit gateway.
State (string) --
The state of the attachment.
CreationTime (datetime) --
The creation time.
Options (dict) --
The Connect attachment options.
Protocol (string) --
The tunnel protocol.
Tags (list) --
The tags for the attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes the specified Connect peer.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway_connect_peer(
TransitGatewayConnectPeerId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Connect peer.
dict
Response Syntax
{
'TransitGatewayConnectPeer': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayConnectPeerId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CreationTime': datetime(2015, 1, 1),
'ConnectPeerConfiguration': {
'TransitGatewayAddress': 'string',
'PeerAddress': 'string',
'InsideCidrBlocks': [
'string',
],
'Protocol': 'gre',
'BgpConfigurations': [
{
'TransitGatewayAsn': 123,
'PeerAsn': 123,
'TransitGatewayAddress': 'string',
'PeerAddress': 'string',
'BgpStatus': 'up'|'down'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayConnectPeer (dict) --
Information about the deleted Connect peer.
TransitGatewayAttachmentId (string) --
The ID of the Connect attachment.
TransitGatewayConnectPeerId (string) --
The ID of the Connect peer.
State (string) --
The state of the Connect peer.
CreationTime (datetime) --
The creation time.
ConnectPeerConfiguration (dict) --
The Connect peer details.
TransitGatewayAddress (string) --
The Connect peer IP address on the transit gateway side of the tunnel.
PeerAddress (string) --
The Connect peer IP address on the appliance side of the tunnel.
InsideCidrBlocks (list) --
The range of interior BGP peer IP addresses.
Protocol (string) --
The tunnel protocol.
BgpConfigurations (list) --
The BGP configuration details.
(dict) --
The BGP configuration information.
TransitGatewayAsn (integer) --
The transit gateway Autonomous System Number (ASN).
PeerAsn (integer) --
The peer Autonomous System Number (ASN).
TransitGatewayAddress (string) --
The interior BGP peer IP address for the transit gateway.
PeerAddress (string) --
The interior BGP peer IP address for the appliance.
BgpStatus (string) --
The BGP status.
Tags (list) --
The tags for the Connect peer.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes the specified transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway_multicast_domain(
TransitGatewayMulticastDomainId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway multicast domain.
dict
Response Syntax
{
'TransitGatewayMulticastDomain': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayMulticastDomainArn': 'string',
'OwnerId': 'string',
'Options': {
'Igmpv2Support': 'enable'|'disable',
'StaticSourcesSupport': 'enable'|'disable',
'AutoAcceptSharedAssociations': 'enable'|'disable'
},
'State': 'pending'|'available'|'deleting'|'deleted',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayMulticastDomain (dict) --
Information about the deleted transit gateway multicast domain.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayMulticastDomainArn (string) --
The Amazon Resource Name (ARN) of the transit gateway multicast domain.
OwnerId (string) --
The ID of the AWS account that owns the transit gateway multiicast domain.
Options (dict) --
The options for the transit gateway multicast domain.
Igmpv2Support (string) --
Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
StaticSourcesSupport (string) --
Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
AutoAcceptSharedAssociations (string) --
Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
State (string) --
The state of the transit gateway multicast domain.
CreationTime (datetime) --
The time the transit gateway multicast domain was created.
Tags (list) --
The tags for the transit gateway multicast domain.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes a transit gateway peering attachment.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway_peering_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway peering attachment.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
The transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway_prefix_list_reference(
TransitGatewayRouteTableId='string',
PrefixListId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the route table.
[REQUIRED]
The ID of the prefix list.
dict
Response Syntax
{
'TransitGatewayPrefixListReference': {
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceId': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayPrefixListReference (dict) --
Information about the deleted prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
Deletes the specified route from the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway_route(
TransitGatewayRouteTableId='string',
DestinationCidrBlock='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
[REQUIRED]
The CIDR range for the route. This must match the CIDR for the route exactly.
dict
Response Syntax
{
'Route': {
'DestinationCidrBlock': 'string',
'PrefixListId': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
PrefixListId (string) --
The ID of the prefix list used for destination matches.
TransitGatewayAttachments (list) --
The attachments.
(dict) --
Describes a route attachment.
ResourceId (string) --
The ID of the resource.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
Type (string) --
The route type.
State (string) --
The state of the route.
Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway_route_table(
TransitGatewayRouteTableId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
dict
Response Syntax
{
'TransitGatewayRouteTable': {
'TransitGatewayRouteTableId': 'string',
'TransitGatewayId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'DefaultAssociationRouteTable': True|False,
'DefaultPropagationRouteTable': True|False,
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayRouteTable (dict) --
Information about the deleted transit gateway route table.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
TransitGatewayId (string) --
The ID of the transit gateway.
State (string) --
The state of the transit gateway route table.
DefaultAssociationRouteTable (boolean) --
Indicates whether this is the default association route table for the transit gateway.
DefaultPropagationRouteTable (boolean) --
Indicates whether this is the default propagation route table for the transit gateway.
CreationTime (datetime) --
The creation time.
Tags (list) --
Any tags assigned to the route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes the specified VPC attachment.
See also: AWS API Documentation
Request Syntax
response = client.delete_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'TransitGatewayVpcAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'VpcId': 'string',
'VpcOwnerId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'SubnetIds': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Options': {
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayVpcAttachment (dict) --
Information about the deleted VPC attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
VpcId (string) --
The ID of the VPC.
VpcOwnerId (string) --
The ID of the AWS account that owns the VPC.
State (string) --
The state of the VPC attachment. Note that the initiating state has been deprecated.
SubnetIds (list) --
The IDs of the subnets.
CreationTime (datetime) --
The creation time.
Options (dict) --
The VPC attachment options.
DnsSupport (string) --
Indicates whether DNS support is enabled.
Ipv6Support (string) --
Indicates whether IPv6 support is disabled.
ApplianceModeSupport (string) --
Indicates whether appliance mode support is enabled.
Tags (list) --
The tags for the VPC attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Deleting an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_volume(
VolumeId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the volume.
None
Examples
This example deletes an available volume with the volume ID of vol-049df61146c4d7901. If the command succeeds, no output is returned.
response = client.delete_volume(
VolumeId='vol-049df61146c4d7901',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc(
VpcId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the VPC.
None
Examples
This example deletes the specified VPC.
response = client.delete_vpc(
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes one or more VPC endpoint connection notifications.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc_endpoint_connection_notifications(
DryRun=True|False,
ConnectionNotificationIds=[
'string',
]
)
[REQUIRED]
One or more notification IDs.
dict
Response Syntax
{
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Unsuccessful (list) --
Information about the notifications that could not be deleted successfully.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc_endpoint_service_configurations(
DryRun=True|False,
ServiceIds=[
'string',
]
)
[REQUIRED]
The IDs of one or more services.
dict
Response Syntax
{
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Unsuccessful (list) --
Information about the service configurations that were not deleted, if applicable.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.
The following rules apply when you delete a VPC endpoint:
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc_endpoints(
DryRun=True|False,
VpcEndpointIds=[
'string',
]
)
[REQUIRED]
One or more VPC endpoint IDs.
dict
Response Syntax
{
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Contains the output of DeleteVpcEndpoints.
Unsuccessful (list) --
Information about the VPC endpoints that were not successfully deleted.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc_peering_connection(
DryRun=True|False,
VpcPeeringConnectionId='string'
)
[REQUIRED]
The ID of the VPC peering connection.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Deletes the specified VPN connection.
If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all AWS Certificate Manager (ACM) private certificates used for the AWS-side tunnel endpoints for the VPN connection before deleting the VPN connection.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpn_connection(
VpnConnectionId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the VPN connection.
None
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpn_connection_route(
DestinationCidrBlock='string',
VpnConnectionId='string'
)
[REQUIRED]
The CIDR block associated with the local subnet of the customer network.
[REQUIRED]
The ID of the VPN connection.
None
Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpn_gateway(
VpnGatewayId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the virtual private gateway.
None
Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
See also: AWS API Documentation
Request Syntax
response = client.deprovision_byoip_cidr(
Cidr='string',
DryRun=True|False
)
[REQUIRED]
The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'Description': 'string',
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address pool.
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
See also: AWS API Documentation
Request Syntax
response = client.deregister_image(
ImageId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the AMI.
None
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
See also: AWS API Documentation
Request Syntax
response = client.deregister_instance_event_notification_attributes(
DryRun=True|False,
InstanceTagAttribute={
'IncludeAllTagsOfInstance': True|False,
'InstanceTagKeys': [
'string',
]
}
)
Information about the tag keys to deregister.
Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
Information about the tag keys to deregister.
dict
Response Syntax
{
'InstanceTagAttribute': {
'InstanceTagKeys': [
'string',
],
'IncludeAllTagsOfInstance': True|False
}
}
Response Structure
(dict) --
InstanceTagAttribute (dict) --
The resulting set of tag keys.
InstanceTagKeys (list) --
The registered tag keys.
IncludeAllTagsOfInstance (boolean) --
Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.
Deregisters the specified members (network interfaces) from the transit gateway multicast group.
See also: AWS API Documentation
Request Syntax
response = client.deregister_transit_gateway_multicast_group_members(
TransitGatewayMulticastDomainId='string',
GroupIpAddress='string',
NetworkInterfaceIds=[
'string',
],
DryRun=True|False
)
The IDs of the group members' network interfaces.
dict
Response Syntax
{
'DeregisteredMulticastGroupMembers': {
'TransitGatewayMulticastDomainId': 'string',
'DeregisteredNetworkInterfaceIds': [
'string',
],
'GroupIpAddress': 'string'
}
}
Response Structure
(dict) --
DeregisteredMulticastGroupMembers (dict) --
Information about the deregistered members.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
DeregisteredNetworkInterfaceIds (list) --
The network interface IDs of the deregistered members.
GroupIpAddress (string) --
The IP address assigned to the transit gateway multicast group.
Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
See also: AWS API Documentation
Request Syntax
response = client.deregister_transit_gateway_multicast_group_sources(
TransitGatewayMulticastDomainId='string',
GroupIpAddress='string',
NetworkInterfaceIds=[
'string',
],
DryRun=True|False
)
The IDs of the group sources' network interfaces.
dict
Response Syntax
{
'DeregisteredMulticastGroupSources': {
'TransitGatewayMulticastDomainId': 'string',
'DeregisteredNetworkInterfaceIds': [
'string',
],
'GroupIpAddress': 'string'
}
}
Response Structure
(dict) --
DeregisteredMulticastGroupSources (dict) --
Information about the deregistered group sources.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
DeregisteredNetworkInterfaceIds (list) --
The network interface IDs of the non-registered members.
GroupIpAddress (string) --
The IP address assigned to the transit gateway multicast group.
Describes attributes of your AWS account. The following are the supported account attributes:
See also: AWS API Documentation
Request Syntax
response = client.describe_account_attributes(
AttributeNames=[
'supported-platforms'|'default-vpc',
],
DryRun=True|False
)
The account attribute names.
dict
Response Syntax
{
'AccountAttributes': [
{
'AttributeName': 'string',
'AttributeValues': [
{
'AttributeValue': 'string'
},
]
},
]
}
Response Structure
(dict) --
AccountAttributes (list) --
Information about the account attributes.
(dict) --
Describes an account attribute.
AttributeName (string) --
The name of the account attribute.
AttributeValues (list) --
The values for the account attribute.
(dict) --
Describes a value of an account attribute.
AttributeValue (string) --
The value of the attribute.
Examples
This example describes the supported-platforms attribute for your AWS account.
response = client.describe_account_attributes(
AttributeNames=[
'supported-platforms',
],
)
print(response)
Expected Output:
{
'AccountAttributes': [
{
'AttributeName': 'supported-platforms',
'AttributeValues': [
{
'AttributeValue': 'EC2',
},
{
'AttributeValue': 'VPC',
},
],
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example describes the attributes for your AWS account.
response = client.describe_account_attributes(
)
print(response)
Expected Output:
{
'AccountAttributes': [
{
'AttributeName': 'supported-platforms',
'AttributeValues': [
{
'AttributeValue': 'EC2',
},
{
'AttributeValue': 'VPC',
},
],
},
{
'AttributeName': 'vpc-max-security-groups-per-interface',
'AttributeValues': [
{
'AttributeValue': '5',
},
],
},
{
'AttributeName': 'max-elastic-ips',
'AttributeValues': [
{
'AttributeValue': '5',
},
],
},
{
'AttributeName': 'max-instances',
'AttributeValues': [
{
'AttributeValue': '20',
},
],
},
{
'AttributeName': 'vpc-max-elastic-ips',
'AttributeValues': [
{
'AttributeValue': '5',
},
],
},
{
'AttributeName': 'default-vpc',
'AttributeValues': [
{
'AttributeValue': 'none',
},
],
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_addresses(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PublicIps=[
'string',
],
AllocationIds=[
'string',
],
DryRun=True|False
)
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
[EC2-VPC] Information about the allocation IDs.
dict
Response Syntax
{
'Addresses': [
{
'InstanceId': 'string',
'PublicIp': 'string',
'AllocationId': 'string',
'AssociationId': 'string',
'Domain': 'vpc'|'standard',
'NetworkInterfaceId': 'string',
'NetworkInterfaceOwnerId': 'string',
'PrivateIpAddress': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PublicIpv4Pool': 'string',
'NetworkBorderGroup': 'string',
'CustomerOwnedIp': 'string',
'CustomerOwnedIpv4Pool': 'string',
'CarrierIp': 'string'
},
]
}
Response Structure
(dict) --
Addresses (list) --
Information about the Elastic IP addresses.
(dict) --
Describes an Elastic IP address, or a carrier IP address.
InstanceId (string) --
The ID of the instance that the address is associated with (if any).
PublicIp (string) --
The Elastic IP address.
AllocationId (string) --
The ID representing the allocation of the address for use with EC2-VPC.
AssociationId (string) --
The ID representing the association of the address with an instance in a VPC.
Domain (string) --
Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc ).
NetworkInterfaceId (string) --
The ID of the network interface.
NetworkInterfaceOwnerId (string) --
The ID of the account that owns the network interface.
PrivateIpAddress (string) --
The private IP address associated with the Elastic IP address.
Tags (list) --
Any tags assigned to the Elastic IP address.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
PublicIpv4Pool (string) --
The ID of an address pool.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
CustomerOwnedIp (string) --
The customer-owned IP address.
CustomerOwnedIpv4Pool (string) --
The ID of the customer-owned address pool.
CarrierIp (string) --
The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
Examples
This example describes your Elastic IP addresses.
response = client.describe_addresses(
)
print(response)
Expected Output:
{
'Addresses': [
{
'Domain': 'standard',
'InstanceId': 'i-1234567890abcdef0',
'PublicIp': '198.51.100.0',
},
{
'AllocationId': 'eipalloc-12345678',
'AssociationId': 'eipassoc-12345678',
'Domain': 'vpc',
'InstanceId': 'i-1234567890abcdef0',
'NetworkInterfaceId': 'eni-12345678',
'NetworkInterfaceOwnerId': '123456789012',
'PrivateIpAddress': '10.0.1.241',
'PublicIp': '203.0.113.0',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example describes your Elastic IP addresses for use with instances in a VPC.
response = client.describe_addresses(
Filters=[
{
'Name': 'domain',
'Values': [
'vpc',
],
},
],
)
print(response)
Expected Output:
{
'Addresses': [
{
'AllocationId': 'eipalloc-12345678',
'AssociationId': 'eipassoc-12345678',
'Domain': 'vpc',
'InstanceId': 'i-1234567890abcdef0',
'NetworkInterfaceId': 'eni-12345678',
'NetworkInterfaceOwnerId': '123456789012',
'PrivateIpAddress': '10.0.1.241',
'PublicIp': '203.0.113.0',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example describes your Elastic IP addresses for use with instances in EC2-Classic.
response = client.describe_addresses(
Filters=[
{
'Name': 'domain',
'Values': [
'standard',
],
},
],
)
print(response)
Expected Output:
{
'Addresses': [
{
'Domain': 'standard',
'InstanceId': 'i-1234567890abcdef0',
'PublicIp': '198.51.100.0',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications .
See also: AWS API Documentation
Request Syntax
response = client.describe_addresses_attribute(
AllocationIds=[
'string',
],
Attribute='domain-name',
NextToken='string',
MaxResults=123,
DryRun=True|False
)
[EC2-VPC] The allocation IDs.
dict
Response Syntax
{
'Addresses': [
{
'PublicIp': 'string',
'AllocationId': 'string',
'PtrRecord': 'string',
'PtrRecordUpdate': {
'Value': 'string',
'Status': 'string',
'Reason': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Addresses (list) --
Information about the IP addresses.
(dict) --
The attributes associated with an Elastic IP address.
PublicIp (string) --
The public IP address.
AllocationId (string) --
[EC2-VPC] The allocation ID.
PtrRecord (string) --
The pointer (PTR) record for the IP address.
PtrRecordUpdate (dict) --
The updated PTR record for the IP address.
Value (string) --
The value for the PTR record update.
Status (string) --
The status of the PTR record update.
Reason (string) --
The reason for the PTR record update.
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.
Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .
See also: AWS API Documentation
Request Syntax
response = client.describe_aggregate_id_format(
DryRun=True|False
)
{
'UseLongIdsAggregated': True|False,
'Statuses': [
{
'Deadline': datetime(2015, 1, 1),
'Resource': 'string',
'UseLongIds': True|False
},
]
}
Response Structure
Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.
Information about each resource's ID format.
Describes the ID format for a resource.
The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
The type of resource.
Indicates whether longer IDs (17-character IDs) are enabled for the resource.
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions, Zones and Outposts in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_availability_zones(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ZoneNames=[
'string',
],
ZoneIds=[
'string',
],
AllAvailabilityZones=True|False,
DryRun=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The names of the Availability Zones, Local Zones, and Wavelength Zones.
The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
dict
Response Syntax
{
'AvailabilityZones': [
{
'State': 'available'|'information'|'impaired'|'unavailable',
'OptInStatus': 'opt-in-not-required'|'opted-in'|'not-opted-in',
'Messages': [
{
'Message': 'string'
},
],
'RegionName': 'string',
'ZoneName': 'string',
'ZoneId': 'string',
'GroupName': 'string',
'NetworkBorderGroup': 'string',
'ZoneType': 'string',
'ParentZoneName': 'string',
'ParentZoneId': 'string'
},
]
}
Response Structure
(dict) --
AvailabilityZones (list) --
Information about the Availability Zones, Local Zones, and Wavelength Zones.
(dict) --
Describes Availability Zones, Local Zones, and Wavelength Zones.
State (string) --
The state of the Availability Zone, Local Zone, or Wavelength Zone.
OptInStatus (string) --
For Availability Zones, this parameter always has the value of opt-in-not-required .
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in , and not-opted-in .
Messages (list) --
Any messages about the Availability Zone, Local Zone, or Wavelength Zone.
(dict) --
Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.
Message (string) --
The message about the Availability Zone, Local Zone, or Wavelength Zone.
RegionName (string) --
The name of the Region.
ZoneName (string) --
The name of the Availability Zone, Local Zone, or Wavelength Zone.
ZoneId (string) --
The ID of the Availability Zone, Local Zone, or Wavelength Zone.
GroupName (string) --
For Availability Zones, this parameter has the same value as the Region name.
For Local Zones, the name of the associated group, for example us-west-2-lax-1 .
For Wavelength Zones, the name of the associated group, for example us-east-1-wl1-bos-wlz-1 .
NetworkBorderGroup (string) --
The name of the network border group.
ZoneType (string) --
The type of zone. The valid values are availability-zone , local-zone , and wavelength-zone .
ParentZoneName (string) --
The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
ParentZoneId (string) --
The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
Examples
This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.
response = client.describe_availability_zones(
)
print(response)
Expected Output:
{
'AvailabilityZones': [
{
'Messages': [
],
'RegionName': 'us-east-1',
'State': 'available',
'ZoneName': 'us-east-1b',
},
{
'Messages': [
],
'RegionName': 'us-east-1',
'State': 'available',
'ZoneName': 'us-east-1c',
},
{
'Messages': [
],
'RegionName': 'us-east-1',
'State': 'available',
'ZoneName': 'us-east-1d',
},
{
'Messages': [
],
'RegionName': 'us-east-1',
'State': 'available',
'ZoneName': 'us-east-1e',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified bundle tasks or all of your bundle tasks.
Note
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
See also: AWS API Documentation
Request Syntax
response = client.describe_bundle_tasks(
BundleIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
The bundle task IDs.
Default: Describes all your bundle tasks.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'BundleTasks': [
{
'BundleId': 'string',
'BundleTaskError': {
'Code': 'string',
'Message': 'string'
},
'InstanceId': 'string',
'Progress': 'string',
'StartTime': datetime(2015, 1, 1),
'State': 'pending'|'waiting-for-shutdown'|'bundling'|'storing'|'cancelling'|'complete'|'failed',
'Storage': {
'S3': {
'AWSAccessKeyId': 'string',
'Bucket': 'string',
'Prefix': 'string',
'UploadPolicy': b'bytes',
'UploadPolicySignature': 'string'
}
},
'UpdateTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
BundleTasks (list) --
Information about the bundle tasks.
(dict) --
Describes a bundle task.
BundleId (string) --
The ID of the bundle task.
BundleTaskError (dict) --
If the task fails, a description of the error.
Code (string) --
The error code.
Message (string) --
The error message.
InstanceId (string) --
The ID of the instance associated with this bundle task.
Progress (string) --
The level of task completion, as a percent (for example, 20%).
StartTime (datetime) --
The time this task started.
State (string) --
The state of the task.
Storage (dict) --
The Amazon S3 storage locations.
S3 (dict) --
An Amazon S3 storage location.
AWSAccessKeyId (string) --
The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys .
Bucket (string) --
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
Prefix (string) --
The beginning of the file name of the AMI.
UploadPolicy (bytes) --
An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
UploadPolicySignature (string) --
The signature of the JSON document.
UpdateTime (datetime) --
The time of the most recent update for the task.
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr .
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools .
See also: AWS API Documentation
Request Syntax
response = client.describe_byoip_cidrs(
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
dict
Response Syntax
{
'ByoipCidrs': [
{
'Cidr': 'string',
'Description': 'string',
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ByoipCidrs (list) --
Information about your address ranges.
(dict) --
Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address pool.
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.
Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Region that you're currently using.
See also: AWS API Documentation
Request Syntax
response = client.describe_capacity_reservations(
CapacityReservationIds=[
'string',
],
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
The ID of the Capacity Reservation.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'NextToken': 'string',
'CapacityReservations': [
{
'CapacityReservationId': 'string',
'OwnerId': 'string',
'CapacityReservationArn': 'string',
'AvailabilityZoneId': 'string',
'InstanceType': 'string',
'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
'AvailabilityZone': 'string',
'Tenancy': 'default'|'dedicated',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'EbsOptimized': True|False,
'EphemeralStorage': True|False,
'State': 'active'|'expired'|'cancelled'|'pending'|'failed',
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'EndDateType': 'unlimited'|'limited',
'InstanceMatchCriteria': 'open'|'targeted',
'CreateDate': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OutpostArn': 'string'
},
]
}
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.
CapacityReservations (list) --
Information about the Capacity Reservations.
(dict) --
Describes a Capacity Reservation.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
OwnerId (string) --
The ID of the account that owns the Capacity Reservation.
CapacityReservationArn (string) --
The Amazon Resource Name (ARN) of the Capacity Reservation.
AvailabilityZoneId (string) --
The Availability Zone ID of the Capacity Reservation.
InstanceType (string) --
The type of instance for which the Capacity Reservation reserves capacity.
InstancePlatform (string) --
The type of operating system for which the Capacity Reservation reserves capacity.
AvailabilityZone (string) --
The Availability Zone in which the capacity is reserved.
Tenancy (string) --
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
TotalInstanceCount (integer) --
The total number of instances for which the Capacity Reservation reserves capacity.
AvailableInstanceCount (integer) --
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
EbsOptimized (boolean) --
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
EphemeralStorage (boolean) --
Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
State (string) --
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
StartDate (datetime) --
The date and time at which the Capacity Reservation was started.
EndDate (datetime) --
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
EndDateType (string) --
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
InstanceMatchCriteria (string) --
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
CreateDate (datetime) --
The date and time at which the Capacity Reservation was created.
Tags (list) --
Any tags assigned to the Capacity Reservation.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
Describes one or more of your carrier gateways.
See also: AWS API Documentation
Request Syntax
response = client.describe_carrier_gateways(
CarrierGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
One or more carrier gateway IDs.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'CarrierGateways': [
{
'CarrierGatewayId': 'string',
'VpcId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CarrierGateways (list) --
Information about the carrier gateway.
(dict) --
Describes a carrier gateway.
CarrierGatewayId (string) --
The ID of the carrier gateway.
VpcId (string) --
The ID of the VPC associated with the carrier gateway.
State (string) --
The state of the carrier gateway.
OwnerId (string) --
The AWS account ID of the owner of the carrier gateway.
Tags (list) --
The tags assigned to the carrier gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.
See also: AWS API Documentation
Request Syntax
response = client.describe_classic_link_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
InstanceIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
dict
Response Syntax
{
'Instances': [
{
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InstanceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Instances (list) --
Information about one or more linked EC2-Classic instances.
(dict) --
Describes a linked EC2-Classic instance.
Groups (list) --
A list of security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
InstanceId (string) --
The ID of the instance.
Tags (list) --
Any tags assigned to the instance.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the authorization rules for a specified Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_client_vpn_authorization_rules(
ClientVpnEndpointId='string',
DryRun=True|False,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123
)
[REQUIRED]
The ID of the Client VPN endpoint.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'AuthorizationRules': [
{
'ClientVpnEndpointId': 'string',
'Description': 'string',
'GroupId': 'string',
'AccessAll': True|False,
'DestinationCidr': 'string',
'Status': {
'Code': 'authorizing'|'active'|'failed'|'revoking',
'Message': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AuthorizationRules (list) --
Information about the authorization rules.
(dict) --
Information about an authorization rule.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint with which the authorization rule is associated.
Description (string) --
A brief description of the authorization rule.
GroupId (string) --
The ID of the Active Directory group to which the authorization rule grants access.
AccessAll (boolean) --
Indicates whether the authorization rule grants access to all clients.
DestinationCidr (string) --
The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
Status (dict) --
The current state of the authorization rule.
Code (string) --
The state of the authorization rule.
Message (string) --
A message about the status of the authorization rule, if applicable.
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.
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_client_vpn_connections(
ClientVpnEndpointId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123,
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'Connections': [
{
'ClientVpnEndpointId': 'string',
'Timestamp': 'string',
'ConnectionId': 'string',
'Username': 'string',
'ConnectionEstablishedTime': 'string',
'IngressBytes': 'string',
'EgressBytes': 'string',
'IngressPackets': 'string',
'EgressPackets': 'string',
'ClientIp': 'string',
'CommonName': 'string',
'Status': {
'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated',
'Message': 'string'
},
'ConnectionEndTime': 'string',
'PostureComplianceStatuses': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Connections (list) --
Information about the active and terminated client connections.
(dict) --
Describes a client connection.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint to which the client is connected.
Timestamp (string) --
The current date and time.
ConnectionId (string) --
The ID of the client connection.
Username (string) --
The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.
ConnectionEstablishedTime (string) --
The date and time the client connection was established.
IngressBytes (string) --
The number of bytes sent by the client.
EgressBytes (string) --
The number of bytes received by the client.
IngressPackets (string) --
The number of packets sent by the client.
EgressPackets (string) --
The number of packets received by the client.
ClientIp (string) --
The IP address of the client.
CommonName (string) --
The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.
Status (dict) --
The current state of the client connection.
Code (string) --
The state of the client connection.
Message (string) --
A message about the status of the client connection, if applicable.
ConnectionEndTime (string) --
The date and time the client connection was terminated.
PostureComplianceStatuses (list) --
The statuses returned by the client connect handler for posture compliance, if applicable.
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.
Describes one or more Client VPN endpoints in the account.
See also: AWS API Documentation
Request Syntax
response = client.describe_client_vpn_endpoints(
ClientVpnEndpointIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
The ID of the Client VPN endpoint.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ClientVpnEndpoints': [
{
'ClientVpnEndpointId': 'string',
'Description': 'string',
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted',
'Message': 'string'
},
'CreationTime': 'string',
'DeletionTime': 'string',
'DnsName': 'string',
'ClientCidrBlock': 'string',
'DnsServers': [
'string',
],
'SplitTunnel': True|False,
'VpnProtocol': 'openvpn',
'TransportProtocol': 'tcp'|'udp',
'VpnPort': 123,
'AssociatedTargetNetworks': [
{
'NetworkId': 'string',
'NetworkType': 'vpc'
},
],
'ServerCertificateArn': 'string',
'AuthenticationOptions': [
{
'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication',
'ActiveDirectory': {
'DirectoryId': 'string'
},
'MutualAuthentication': {
'ClientRootCertificateChain': 'string'
},
'FederatedAuthentication': {
'SamlProviderArn': 'string',
'SelfServiceSamlProviderArn': 'string'
}
},
],
'ConnectionLogOptions': {
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string',
'SelfServicePortalUrl': 'string',
'ClientConnectOptions': {
'Enabled': True|False,
'LambdaFunctionArn': 'string',
'Status': {
'Code': 'applying'|'applied',
'Message': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ClientVpnEndpoints (list) --
Information about the Client VPN endpoints.
(dict) --
Describes a Client VPN endpoint.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
Description (string) --
A brief description of the endpoint.
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
Message (string) --
A message about the status of the Client VPN endpoint.
CreationTime (string) --
The date and time the Client VPN endpoint was created.
DeletionTime (string) --
The date and time the Client VPN endpoint was deleted, if applicable.
DnsName (string) --
The DNS name to be used by clients when connecting to the Client VPN endpoint.
ClientCidrBlock (string) --
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
DnsServers (list) --
Information about the DNS servers to be used for DNS resolution.
SplitTunnel (boolean) --
Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide .
VpnProtocol (string) --
The protocol used by the VPN session.
TransportProtocol (string) --
The transport protocol used by the Client VPN endpoint.
VpnPort (integer) --
The port number for the Client VPN endpoint.
AssociatedTargetNetworks (list) --
Information about the associated target networks. A target network is a subnet in a VPC.
(dict) --
Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
NetworkId (string) --
The ID of the subnet.
NetworkType (string) --
The target network type.
ServerCertificateArn (string) --
The ARN of the server certificate.
AuthenticationOptions (list) --
Information about the authentication method used by the Client VPN endpoint.
(dict) --
Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the AWS Client VPN Administrator Guide .
Type (string) --
The authentication type used.
ActiveDirectory (dict) --
Information about the Active Directory, if applicable.
DirectoryId (string) --
The ID of the Active Directory used for authentication.
MutualAuthentication (dict) --
Information about the authentication certificates, if applicable.
ClientRootCertificateChain (string) --
The ARN of the client certificate.
FederatedAuthentication (dict) --
Information about the IAM SAML identity provider, if applicable.
SamlProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider.
SelfServiceSamlProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
ConnectionLogOptions (dict) --
Information about the client connection logging options for the Client VPN endpoint.
Enabled (boolean) --
Indicates whether client connection logging is enabled for the Client VPN endpoint.
CloudwatchLogGroup (string) --
The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
CloudwatchLogStream (string) --
The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
Tags (list) --
Any tags assigned to the Client VPN endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
SecurityGroupIds (list) --
The IDs of the security groups for the target network.
VpcId (string) --
The ID of the VPC.
SelfServicePortalUrl (string) --
The URL of the self-service portal.
ClientConnectOptions (dict) --
The options for managing connection authorization for new client connections.
Enabled (boolean) --
Indicates whether client connect options are enabled.
LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the AWS Lambda function used for connection authorization.
Status (dict) --
The status of any updates to the client connect options.
Code (string) --
The status code.
Message (string) --
The status message.
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.
Describes the routes for the specified Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_client_vpn_routes(
ClientVpnEndpointId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'Routes': [
{
'ClientVpnEndpointId': 'string',
'DestinationCidr': 'string',
'TargetSubnet': 'string',
'Type': 'string',
'Origin': 'string',
'Status': {
'Code': 'creating'|'active'|'failed'|'deleting',
'Message': 'string'
},
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Routes (list) --
Information about the Client VPN endpoint routes.
(dict) --
Information about a Client VPN endpoint route.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint with which the route is associated.
DestinationCidr (string) --
The IPv4 address range, in CIDR notation, of the route destination.
TargetSubnet (string) --
The ID of the subnet through which traffic is routed.
Type (string) --
The route type.
Origin (string) --
Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.
Status (dict) --
The current state of the route.
Code (string) --
The state of the Client VPN endpoint route.
Message (string) --
A message about the status of the Client VPN endpoint route, if applicable.
Description (string) --
A brief description of the route.
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.
Describes the target networks associated with the specified Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_client_vpn_target_networks(
ClientVpnEndpointId='string',
AssociationIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint.
The IDs of the target network associations.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ClientVpnTargetNetworks': [
{
'AssociationId': 'string',
'VpcId': 'string',
'TargetNetworkId': 'string',
'ClientVpnEndpointId': 'string',
'Status': {
'Code': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated',
'Message': 'string'
},
'SecurityGroups': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ClientVpnTargetNetworks (list) --
Information about the associated target networks.
(dict) --
Describes a target network associated with a Client VPN endpoint.
AssociationId (string) --
The ID of the association.
VpcId (string) --
The ID of the VPC in which the target network (subnet) is located.
TargetNetworkId (string) --
The ID of the subnet specified as the target network.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint with which the target network is associated.
Status (dict) --
The current state of the target network association.
Code (string) --
The state of the target network association.
Message (string) --
A message about the status of the target network association, if applicable.
SecurityGroups (list) --
The IDs of the security groups applied to the target network association.
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.
Describes the specified customer-owned address pools or all of your customer-owned address pools.
See also: AWS API Documentation
Request Syntax
response = client.describe_coip_pools(
PoolIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the address pools.
The filters. The following are the possible values:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'CoipPools': [
{
'PoolId': 'string',
'PoolCidrs': [
'string',
],
'LocalGatewayRouteTableId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PoolArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CoipPools (list) --
Information about the address pools.
(dict) --
Describes a customer-owned address pool.
PoolId (string) --
The ID of the address pool.
PoolCidrs (list) --
The address ranges of the address pool.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
PoolArn (string) --
The ARN of the address pool.
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.
Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
See also: AWS API Documentation
Request Syntax
response = client.describe_conversion_tasks(
ConversionTaskIds=[
'string',
],
DryRun=True|False
)
The conversion task IDs.
dict
Response Syntax
{
'ConversionTasks': [
{
'ConversionTaskId': 'string',
'ExpirationTime': 'string',
'ImportInstance': {
'Description': 'string',
'InstanceId': 'string',
'Platform': 'Windows',
'Volumes': [
{
'AvailabilityZone': 'string',
'BytesConverted': 123,
'Description': 'string',
'Image': {
'Checksum': 'string',
'Format': 'VMDK'|'RAW'|'VHD',
'ImportManifestUrl': 'string',
'Size': 123
},
'Status': 'string',
'StatusMessage': 'string',
'Volume': {
'Id': 'string',
'Size': 123
}
},
]
},
'ImportVolume': {
'AvailabilityZone': 'string',
'BytesConverted': 123,
'Description': 'string',
'Image': {
'Checksum': 'string',
'Format': 'VMDK'|'RAW'|'VHD',
'ImportManifestUrl': 'string',
'Size': 123
},
'Volume': {
'Id': 'string',
'Size': 123
}
},
'State': 'active'|'cancelling'|'cancelled'|'completed',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
ConversionTasks (list) --
Information about the conversion tasks.
(dict) --
Describes a conversion task.
ConversionTaskId (string) --
The ID of the conversion task.
ExpirationTime (string) --
The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
ImportInstance (dict) --
If the task is for importing an instance, this contains information about the import instance task.
Description (string) --
A description of the task.
InstanceId (string) --
The ID of the instance.
Platform (string) --
The instance operating system.
Volumes (list) --
The volumes.
(dict) --
Describes an import volume task.
AvailabilityZone (string) --
The Availability Zone where the resulting instance will reside.
BytesConverted (integer) --
The number of bytes converted so far.
Description (string) --
A description of the task.
Image (dict) --
The image.
Checksum (string) --
The checksum computed for the disk image.
Format (string) --
The disk image format.
ImportManifestUrl (string) --
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
Size (integer) --
The size of the disk image, in GiB.
Status (string) --
The status of the import of this particular disk image.
StatusMessage (string) --
The status information or errors related to the disk image.
Volume (dict) --
The volume.
Id (string) --
The volume identifier.
Size (integer) --
The size of the volume, in GiB.
ImportVolume (dict) --
If the task is for importing a volume, this contains information about the import volume task.
AvailabilityZone (string) --
The Availability Zone where the resulting volume will reside.
BytesConverted (integer) --
The number of bytes converted so far.
Description (string) --
The description you provided when starting the import volume task.
Image (dict) --
The image.
Checksum (string) --
The checksum computed for the disk image.
Format (string) --
The disk image format.
ImportManifestUrl (string) --
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
Size (integer) --
The size of the disk image, in GiB.
Volume (dict) --
The volume.
Id (string) --
The volume identifier.
Size (integer) --
The size of the volume, in GiB.
State (string) --
The state of the conversion task.
StatusMessage (string) --
The status message related to the conversion task.
Tags (list) --
Any tags assigned to the task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Describes one or more of your VPN customer gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_customer_gateways(
CustomerGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False
)
One or more customer gateway IDs.
Default: Describes all your customer gateways.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'CustomerGateways': [
{
'BgpAsn': 'string',
'CustomerGatewayId': 'string',
'IpAddress': 'string',
'CertificateArn': 'string',
'State': 'string',
'Type': 'string',
'DeviceName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output of DescribeCustomerGateways.
CustomerGateways (list) --
Information about one or more customer gateways.
(dict) --
Describes a customer gateway.
BgpAsn (string) --
The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
CustomerGatewayId (string) --
The ID of the customer gateway.
IpAddress (string) --
The Internet-routable IP address of the customer gateway's outside interface.
CertificateArn (string) --
The Amazon Resource Name (ARN) for the customer gateway certificate.
State (string) --
The current state of the customer gateway (pending | available | deleting | deleted ).
Type (string) --
The type of VPN connection the customer gateway supports (ipsec.1 ).
DeviceName (string) --
The name of customer gateway device.
Tags (list) --
Any tags assigned to the customer gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example describes the specified customer gateway.
response = client.describe_customer_gateways(
CustomerGatewayIds=[
'cgw-0e11f167',
],
)
print(response)
Expected Output:
{
'CustomerGateways': [
{
'BgpAsn': '65534',
'CustomerGatewayId': 'cgw-0e11f167',
'IpAddress': '12.1.2.3',
'State': 'available',
'Type': 'ipsec.1',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more of your DHCP options sets.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_dhcp_options(
DhcpOptionsIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'DhcpOptions': [
{
'DhcpConfigurations': [
{
'Key': 'string',
'Values': [
{
'Value': 'string'
},
]
},
],
'DhcpOptionsId': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DhcpOptions (list) --
Information about one or more DHCP options sets.
(dict) --
Describes a set of DHCP options.
DhcpConfigurations (list) --
One or more DHCP options in the set.
(dict) --
Describes a DHCP configuration option.
Key (string) --
The name of a DHCP option.
Values (list) --
One or more values for the DHCP option.
(dict) --
Describes a value for a resource attribute that is a String.
Value (string) --
The attribute value. The value is case-sensitive.
DhcpOptionsId (string) --
The ID of the set of DHCP options.
OwnerId (string) --
The ID of the AWS account that owns the DHCP options set.
Tags (list) --
Any tags assigned to the DHCP options set.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Examples
This example describes the specified DHCP options set.
response = client.describe_dhcp_options(
DhcpOptionsIds=[
'dopt-d9070ebb',
],
)
print(response)
Expected Output:
{
'DhcpOptions': [
{
'DhcpConfigurations': [
{
'Key': 'domain-name-servers',
'Values': [
{
'Value': '10.2.5.2',
},
{
'Value': '10.2.5.1',
},
],
},
],
'DhcpOptionsId': 'dopt-d9070ebb',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more of your egress-only internet gateways.
See also: AWS API Documentation
Request Syntax
response = client.describe_egress_only_internet_gateways(
DryRun=True|False,
EgressOnlyInternetGatewayIds=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
One or more egress-only internet gateway IDs.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'EgressOnlyInternetGateways': [
{
'Attachments': [
{
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
},
],
'EgressOnlyInternetGatewayId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EgressOnlyInternetGateways (list) --
Information about the egress-only internet gateways.
(dict) --
Describes an egress-only internet gateway.
Attachments (list) --
Information about the attachment of the egress-only internet gateway.
(dict) --
Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
State (string) --
The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
VpcId (string) --
The ID of the VPC.
EgressOnlyInternetGatewayId (string) --
The ID of the egress-only internet gateway.
Tags (list) --
The tags assigned to the egress-only internet gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics .
See also: AWS API Documentation
Request Syntax
response = client.describe_elastic_gpus(
ElasticGpuIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
The Elastic Graphics accelerator IDs.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ElasticGpuSet': [
{
'ElasticGpuId': 'string',
'AvailabilityZone': 'string',
'ElasticGpuType': 'string',
'ElasticGpuHealth': {
'Status': 'OK'|'IMPAIRED'
},
'ElasticGpuState': 'ATTACHED',
'InstanceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'MaxResults': 123,
'NextToken': 'string'
}
Response Structure
(dict) --
ElasticGpuSet (list) --
Information about the Elastic Graphics accelerators.
(dict) --
Describes an Elastic Graphics accelerator.
ElasticGpuId (string) --
The ID of the Elastic Graphics accelerator.
AvailabilityZone (string) --
The Availability Zone in the which the Elastic Graphics accelerator resides.
ElasticGpuType (string) --
The type of Elastic Graphics accelerator.
ElasticGpuHealth (dict) --
The status of the Elastic Graphics accelerator.
Status (string) --
The health status.
ElasticGpuState (string) --
The state of the Elastic Graphics accelerator.
InstanceId (string) --
The ID of the instance to which the Elastic Graphics accelerator is attached.
Tags (list) --
The tags assigned to the Elastic Graphics accelerator.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
MaxResults (integer) --
The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
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.
Describes the specified export image tasks or all of your export image tasks.
See also: AWS API Documentation
Request Syntax
response = client.describe_export_image_tasks(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ExportImageTaskIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
Filter tasks using the task-state filter and one of the following values: active , completed , deleting , or deleted .
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the export image tasks.
dict
Response Syntax
{
'ExportImageTasks': [
{
'Description': 'string',
'ExportImageTaskId': 'string',
'ImageId': 'string',
'Progress': 'string',
'S3ExportLocation': {
'S3Bucket': 'string',
'S3Prefix': 'string'
},
'Status': 'string',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ExportImageTasks (list) --
Information about the export image tasks.
(dict) --
Describes an export image task.
Description (string) --
A description of the image being exported.
ExportImageTaskId (string) --
The ID of the export image task.
ImageId (string) --
The ID of the image.
Progress (string) --
The percent complete of the export image task.
S3ExportLocation (dict) --
Information about the destination Amazon S3 bucket.
S3Bucket (string) --
The destination Amazon S3 bucket.
S3Prefix (string) --
The prefix (logical hierarchy) in the bucket.
Status (string) --
The status of the export image task. The possible values are active , completed , deleting , and deleted .
StatusMessage (string) --
The status message for the export image task.
Tags (list) --
Any tags assigned to the export image task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
NextToken (string) --
The token to use to get the next page of results. This value is null when there are no more results to return.
Describes the specified export instance tasks or all of your export instance tasks.
See also: AWS API Documentation
Request Syntax
response = client.describe_export_tasks(
ExportTaskIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
The export task IDs.
the filters for the export tasks.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ExportTasks': [
{
'Description': 'string',
'ExportTaskId': 'string',
'ExportToS3Task': {
'ContainerFormat': 'ova',
'DiskImageFormat': 'VMDK'|'RAW'|'VHD',
'S3Bucket': 'string',
'S3Key': 'string'
},
'InstanceExportDetails': {
'InstanceId': 'string',
'TargetEnvironment': 'citrix'|'vmware'|'microsoft'
},
'State': 'active'|'cancelling'|'cancelled'|'completed',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
ExportTasks (list) --
Information about the export tasks.
(dict) --
Describes an export instance task.
Description (string) --
A description of the resource being exported.
ExportTaskId (string) --
The ID of the export task.
ExportToS3Task (dict) --
Information about the export task.
ContainerFormat (string) --
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
DiskImageFormat (string) --
The format for the exported image.
S3Bucket (string) --
The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com .
S3Key (string) --
The encryption key for your S3 bucket.
InstanceExportDetails (dict) --
Information about the instance to export.
InstanceId (string) --
The ID of the resource being exported.
TargetEnvironment (string) --
The target virtualization environment.
State (string) --
The state of the export task.
StatusMessage (string) --
The status message related to the export task.
Tags (list) --
The tags for the export task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Describes the state of fast snapshot restores for your snapshots.
See also: AWS API Documentation
Request Syntax
response = client.describe_fast_snapshot_restores(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'FastSnapshotRestores': [
{
'SnapshotId': 'string',
'AvailabilityZone': 'string',
'State': 'enabling'|'optimizing'|'enabled'|'disabling'|'disabled',
'StateTransitionReason': 'string',
'OwnerId': 'string',
'OwnerAlias': 'string',
'EnablingTime': datetime(2015, 1, 1),
'OptimizingTime': datetime(2015, 1, 1),
'EnabledTime': datetime(2015, 1, 1),
'DisablingTime': datetime(2015, 1, 1),
'DisabledTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FastSnapshotRestores (list) --
Information about the state of fast snapshot restores.
(dict) --
Describes fast snapshot restores for a snapshot.
SnapshotId (string) --
The ID of the snapshot.
AvailabilityZone (string) --
The Availability Zone.
State (string) --
The state of fast snapshot restores.
StateTransitionReason (string) --
The reason for the state transition. The possible values are as follows:
OwnerId (string) --
The ID of the AWS account that enabled fast snapshot restores on the snapshot.
OwnerAlias (string) --
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
EnablingTime (datetime) --
The time at which fast snapshot restores entered the enabling state.
OptimizingTime (datetime) --
The time at which fast snapshot restores entered the optimizing state.
EnabledTime (datetime) --
The time at which fast snapshot restores entered the enabled state.
DisablingTime (datetime) --
The time at which fast snapshot restores entered the disabling state.
DisabledTime (datetime) --
The time at which fast snapshot restores entered the disabled state.
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.
Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet_history(
DryRun=True|False,
EventType='instance-change'|'fleet-change'|'service-error',
MaxResults=123,
NextToken='string',
FleetId='string',
StartTime=datetime(2015, 1, 1)
)
[REQUIRED]
The ID of the EC2 Fleet.
[REQUIRED]
The start date and time for the events, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
dict
Response Syntax
{
'HistoryRecords': [
{
'EventInformation': {
'EventDescription': 'string',
'EventSubType': 'string',
'InstanceId': 'string'
},
'EventType': 'instance-change'|'fleet-change'|'service-error',
'Timestamp': datetime(2015, 1, 1)
},
],
'LastEvaluatedTime': datetime(2015, 1, 1),
'NextToken': 'string',
'FleetId': 'string',
'StartTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
HistoryRecords (list) --
Information about the events in the history of the EC2 Fleet.
(dict) --
Describes an event in the history of an EC2 Fleet.
EventInformation (dict) --
Information about the event.
EventDescription (string) --
The description of the event.
EventSubType (string) --
The event.
The following are the error events:
The following are the fleetRequestChange events:
The following are the instanceChange events:
The following are the Information events:
InstanceId (string) --
The ID of the instance. This information is available only for instanceChange events.
EventType (string) --
The event type.
Timestamp (datetime) --
The date and time of the event, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
LastEvaluatedTime (datetime) --
The last date and time for the events, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
NextToken (string) --
The token for the next set of results.
FleetId (string) --
The ID of the EC Fleet.
StartTime (datetime) --
The start date and time for the events, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Describes the running instances for the specified EC2 Fleet.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet_instances(
DryRun=True|False,
MaxResults=123,
NextToken='string',
FleetId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
[REQUIRED]
The ID of the EC2 Fleet.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ActiveInstances': [
{
'InstanceId': 'string',
'InstanceType': 'string',
'SpotInstanceRequestId': 'string',
'InstanceHealth': 'healthy'|'unhealthy'
},
],
'NextToken': 'string',
'FleetId': 'string'
}
Response Structure
(dict) --
ActiveInstances (list) --
The running instances. This list is refreshed periodically and might be out of date.
(dict) --
Describes a running instance in a Spot Fleet.
InstanceId (string) --
The ID of the instance.
InstanceType (string) --
The instance type.
SpotInstanceRequestId (string) --
The ID of the Spot Instance request.
InstanceHealth (string) --
The health status of the instance. If the status of either the instance status check or the system status check is impaired , the health status of the instance is unhealthy . Otherwise, the health status is healthy .
NextToken (string) --
The token for the next set of results.
FleetId (string) --
The ID of the EC2 Fleet.
Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_fleets(
DryRun=True|False,
MaxResults=123,
NextToken='string',
FleetIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
The ID of the EC2 Fleets.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'NextToken': 'string',
'Fleets': [
{
'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled',
'CreateTime': datetime(2015, 1, 1),
'FleetId': 'string',
'FleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying',
'ClientToken': 'string',
'ExcessCapacityTerminationPolicy': 'no-termination'|'termination',
'FulfilledCapacity': 123.0,
'FulfilledOnDemandCapacity': 123.0,
'LaunchTemplateConfigs': [
{
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'GroupName': 'string'
}
},
]
},
],
'TargetCapacitySpecification': {
'TotalTargetCapacity': 123,
'OnDemandTargetCapacity': 123,
'SpotTargetCapacity': 123,
'DefaultTargetCapacityType': 'spot'|'on-demand'
},
'TerminateInstancesWithExpiration': True|False,
'Type': 'request'|'maintain'|'instant',
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'ReplaceUnhealthyInstances': True|False,
'SpotOptions': {
'AllocationStrategy': 'lowest-price'|'diversified'|'capacity-optimized'|'capacity-optimized-prioritized',
'MaintenanceStrategies': {
'CapacityRebalance': {
'ReplacementStrategy': 'launch'
}
},
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
'InstancePoolsToUseCount': 123,
'SingleInstanceType': True|False,
'SingleAvailabilityZone': True|False,
'MinTargetCapacity': 123,
'MaxTotalPrice': 'string'
},
'OnDemandOptions': {
'AllocationStrategy': 'lowest-price'|'prioritized',
'CapacityReservationOptions': {
'UsageStrategy': 'use-capacity-reservations-first'
},
'SingleInstanceType': True|False,
'SingleAvailabilityZone': True|False,
'MinTargetCapacity': 123,
'MaxTotalPrice': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Errors': [
{
'LaunchTemplateAndOverrides': {
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': {
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'GroupName': 'string'
}
}
},
'Lifecycle': 'spot'|'on-demand',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'Instances': [
{
'LaunchTemplateAndOverrides': {
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': {
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'GroupName': 'string'
}
}
},
'Lifecycle': 'spot'|'on-demand',
'InstanceIds': [
'string',
],
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'Platform': 'Windows'
},
],
'Context': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token for the next set of results.
Fleets (list) --
Information about the EC2 Fleets.
(dict) --
Describes an EC2 Fleet.
ActivityStatus (string) --
The progress of the EC2 Fleet. If there is an error, the status is error . After all requests are placed, the status is pending_fulfillment . If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.
CreateTime (datetime) --
The creation date and time of the EC2 Fleet.
FleetId (string) --
The ID of the EC2 Fleet.
FleetState (string) --
The state of the EC2 Fleet.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
Constraints: Maximum 64 ASCII characters
ExcessCapacityTerminationPolicy (string) --
Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
FulfilledCapacity (float) --
The number of units fulfilled by this request compared to the set target capacity.
FulfilledOnDemandCapacity (float) --
The number of units fulfilled by this request compared to the set target On-Demand capacity.
LaunchTemplateConfigs (list) --
The launch template and overrides.
(dict) --
Describes a launch template and overrides.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (list) --
Any parameters that you specify override the same parameters in the launch template.
(dict) --
Describes overrides for a launch template.
InstanceType (string) --
The instance type.
MaxPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
Placement (dict) --
The location where the instance launched, if applicable.
GroupName (string) --
The name of the placement group that the instance is in.
TargetCapacitySpecification (dict) --
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
TotalTargetCapacity (integer) --
The number of units to request, filled using DefaultTargetCapacityType .
OnDemandTargetCapacity (integer) --
The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.
SpotTargetCapacity (integer) --
The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.
DefaultTargetCapacityType (string) --
The default TotalTargetCapacity , which is either Spot or On-Demand .
TerminateInstancesWithExpiration (boolean) --
Indicates whether running instances should be terminated when the EC2 Fleet expires.
Type (string) --
The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain .
ValidFrom (datetime) --
The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.
ValidUntil (datetime) --
The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
ReplaceUnhealthyInstances (boolean) --
Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain . For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide .
SpotOptions (dict) --
The configuration of Spot Instances in an EC2 Fleet.
AllocationStrategy (string) --
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
If the allocation strategy is lowest-price , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified , EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.
MaintenanceStrategies (dict) --
The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.
CapacityRebalance (dict) --
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
ReplacementStrategy (string) --
To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for an existing Spot Instance in the fleet, specify launch . Only available for fleets of type maintain .
Note
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for both instances while they are running.
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted. The default is terminate .
InstancePoolsToUseCount (integer) --
The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowest-price . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
SingleInstanceType (boolean) --
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant .
SingleAvailabilityZone (boolean) --
Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant .
MinTargetCapacity (integer) --
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
MaxTotalPrice (string) --
The maximum amount per hour for Spot Instances that you're willing to pay.
OnDemandOptions (dict) --
The allocation strategy of On-Demand Instances in an EC2 Fleet.
AllocationStrategy (string) --
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price , EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price .
CapacityReservationOptions (dict) --
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type instant .
UsageStrategy (string) --
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized ).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
SingleInstanceType (boolean) --
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported only for fleets of type instant .
SingleAvailabilityZone (boolean) --
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type instant .
MinTargetCapacity (integer) --
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
MaxTotalPrice (string) --
The maximum amount per hour for On-Demand Instances that you're willing to pay.
Tags (list) --
The tags for an EC2 Fleet resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Errors (list) --
Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant .
(dict) --
Describes the instances that could not be launched by the fleet.
LaunchTemplateAndOverrides (dict) --
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (dict) --
Any parameters that you specify override the same parameters in the launch template.
InstanceType (string) --
The instance type.
MaxPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
Placement (dict) --
The location where the instance launched, if applicable.
GroupName (string) --
The name of the placement group that the instance is in.
Lifecycle (string) --
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
ErrorCode (string) --
The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes .
ErrorMessage (string) --
The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes .
Instances (list) --
Information about the instances that were launched by the fleet. Valid only when Type is set to instant .
(dict) --
Describes the instances that were launched by the fleet.
LaunchTemplateAndOverrides (dict) --
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (dict) --
Any parameters that you specify override the same parameters in the launch template.
InstanceType (string) --
The instance type.
MaxPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
Placement (dict) --
The location where the instance launched, if applicable.
GroupName (string) --
The name of the placement group that the instance is in.
Lifecycle (string) --
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
InstanceIds (list) --
The IDs of the instances.
InstanceType (string) --
The instance type.
Platform (string) --
The value is Windows for Windows instances. Otherwise, the value is blank.
Context (string) --
Reserved.
Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.
See also: AWS API Documentation
Request Syntax
response = client.describe_flow_logs(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
FlowLogIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
dict
Response Syntax
{
'FlowLogs': [
{
'CreationTime': datetime(2015, 1, 1),
'DeliverLogsErrorMessage': 'string',
'DeliverLogsPermissionArn': 'string',
'DeliverLogsStatus': 'string',
'FlowLogId': 'string',
'FlowLogStatus': 'string',
'LogGroupName': 'string',
'ResourceId': 'string',
'TrafficType': 'ACCEPT'|'REJECT'|'ALL',
'LogDestinationType': 'cloud-watch-logs'|'s3',
'LogDestination': 'string',
'LogFormat': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'MaxAggregationInterval': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FlowLogs (list) --
Information about the flow logs.
(dict) --
Describes a flow log.
CreationTime (datetime) --
The date and time the flow log was created.
DeliverLogsErrorMessage (string) --
Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.
DeliverLogsPermissionArn (string) --
The ARN of the IAM role that posts logs to CloudWatch Logs.
DeliverLogsStatus (string) --
The status of the logs delivery (SUCCESS | FAILED ).
FlowLogId (string) --
The flow log ID.
FlowLogStatus (string) --
The status of the flow log (ACTIVE ).
LogGroupName (string) --
The name of the flow log group.
ResourceId (string) --
The ID of the resource on which the flow log was created.
TrafficType (string) --
The type of traffic captured for the flow log.
LogDestinationType (string) --
Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
LogDestination (string) --
Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.
LogFormat (string) --
The format of the flow log record.
Tags (list) --
The tags for the flow log.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
MaxAggregationInterval (integer) --
The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
When a network interface is attached to a Nitro-based instance , the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
Valid Values: 60 | 600
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.
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
See also: AWS API Documentation
Request Syntax
response = client.describe_fpga_image_attribute(
DryRun=True|False,
FpgaImageId='string',
Attribute='description'|'name'|'loadPermission'|'productCodes'
)
[REQUIRED]
The ID of the AFI.
[REQUIRED]
The AFI attribute.
dict
Response Syntax
{
'FpgaImageAttribute': {
'FpgaImageId': 'string',
'Name': 'string',
'Description': 'string',
'LoadPermissions': [
{
'UserId': 'string',
'Group': 'all'
},
],
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
]
}
}
Response Structure
(dict) --
FpgaImageAttribute (dict) --
Information about the attribute.
FpgaImageId (string) --
The ID of the AFI.
Name (string) --
The name of the AFI.
Description (string) --
The description of the AFI.
LoadPermissions (list) --
The load permissions.
(dict) --
Describes a load permission.
UserId (string) --
The AWS account ID.
Group (string) --
The name of the group.
ProductCodes (list) --
The product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.
See also: AWS API Documentation
Request Syntax
response = client.describe_fpga_images(
DryRun=True|False,
FpgaImageIds=[
'string',
],
Owners=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
The AFI IDs.
Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace ).
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'FpgaImages': [
{
'FpgaImageId': 'string',
'FpgaImageGlobalId': 'string',
'Name': 'string',
'Description': 'string',
'ShellVersion': 'string',
'PciId': {
'DeviceId': 'string',
'VendorId': 'string',
'SubsystemId': 'string',
'SubsystemVendorId': 'string'
},
'State': {
'Code': 'pending'|'failed'|'available'|'unavailable',
'Message': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'OwnerId': 'string',
'OwnerAlias': 'string',
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Public': True|False,
'DataRetentionSupport': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FpgaImages (list) --
Information about the FPGA images.
(dict) --
Describes an Amazon FPGA image (AFI).
FpgaImageId (string) --
The FPGA image identifier (AFI ID).
FpgaImageGlobalId (string) --
The global FPGA image identifier (AGFI ID).
Name (string) --
The name of the AFI.
Description (string) --
The description of the AFI.
ShellVersion (string) --
The version of the AWS Shell that was used to create the bitstream.
PciId (dict) --
Information about the PCI bus.
DeviceId (string) --
The ID of the device.
VendorId (string) --
The ID of the vendor.
SubsystemId (string) --
The ID of the subsystem.
SubsystemVendorId (string) --
The ID of the vendor for the subsystem.
State (dict) --
Information about the state of the AFI.
Code (string) --
The state. The following are the possible values:
Message (string) --
If the state is failed , this is the error message.
CreateTime (datetime) --
The date and time the AFI was created.
UpdateTime (datetime) --
The time of the most recent update to the AFI.
OwnerId (string) --
The AWS account ID of the AFI owner.
OwnerAlias (string) --
The alias of the AFI owner. Possible values include self , amazon , and aws-marketplace .
ProductCodes (list) --
The product codes for the AFI.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
Tags (list) --
Any tags assigned to the AFI.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Public (boolean) --
Indicates whether the AFI is public.
DataRetentionSupport (boolean) --
Indicates whether data retention support is enabled for the AFI.
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.
Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_host_reservation_offerings(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxDuration=123,
MaxResults=123,
MinDuration=123,
NextToken='string',
OfferingId='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'NextToken': 'string',
'OfferingSet': [
{
'CurrencyCode': 'USD',
'Duration': 123,
'HourlyPrice': 'string',
'InstanceFamily': 'string',
'OfferingId': 'string',
'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
'UpfrontPrice': 'string'
},
]
}
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.
OfferingSet (list) --
Information about the offerings.
(dict) --
Details about the Dedicated Host Reservation offering.
CurrencyCode (string) --
The currency of the offering.
Duration (integer) --
The duration of the offering (in seconds).
HourlyPrice (string) --
The hourly price of the offering.
InstanceFamily (string) --
The instance family of the offering.
OfferingId (string) --
The ID of the offering.
PaymentOption (string) --
The available payment option.
UpfrontPrice (string) --
The upfront price of the offering. Does not apply to No Upfront offerings.
Describes reservations that are associated with Dedicated Hosts in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_host_reservations(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
HostReservationIdSet=[
'string',
],
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The host reservation IDs.
dict
Response Syntax
{
'HostReservationSet': [
{
'Count': 123,
'CurrencyCode': 'USD',
'Duration': 123,
'End': datetime(2015, 1, 1),
'HostIdSet': [
'string',
],
'HostReservationId': 'string',
'HourlyPrice': 'string',
'InstanceFamily': 'string',
'OfferingId': 'string',
'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
'Start': datetime(2015, 1, 1),
'State': 'payment-pending'|'payment-failed'|'active'|'retired',
'UpfrontPrice': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
HostReservationSet (list) --
Details about the reservation's configuration.
(dict) --
Details about the Dedicated Host Reservation and associated Dedicated Hosts.
Count (integer) --
The number of Dedicated Hosts the reservation is associated with.
CurrencyCode (string) --
The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD .
Duration (integer) --
The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years) .
End (datetime) --
The date and time that the reservation ends.
HostIdSet (list) --
The IDs of the Dedicated Hosts associated with the reservation.
HostReservationId (string) --
The ID of the reservation that specifies the associated Dedicated Hosts.
HourlyPrice (string) --
The hourly price of the reservation.
InstanceFamily (string) --
The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
OfferingId (string) --
The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
PaymentOption (string) --
The payment option selected for this reservation.
Start (datetime) --
The date and time that the reservation started.
State (string) --
The state of the reservation.
UpfrontPrice (string) --
The upfront price of the reservation.
Tags (list) --
Any tags assigned to the Dedicated Host Reservation.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released .
See also: AWS API Documentation
Request Syntax
response = client.describe_hosts(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
HostIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
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 returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
dict
Response Syntax
{
'Hosts': [
{
'AutoPlacement': 'on'|'off',
'AvailabilityZone': 'string',
'AvailableCapacity': {
'AvailableInstanceCapacity': [
{
'AvailableCapacity': 123,
'InstanceType': 'string',
'TotalCapacity': 123
},
],
'AvailableVCpus': 123
},
'ClientToken': 'string',
'HostId': 'string',
'HostProperties': {
'Cores': 123,
'InstanceType': 'string',
'InstanceFamily': 'string',
'Sockets': 123,
'TotalVCpus': 123
},
'HostReservationId': 'string',
'Instances': [
{
'InstanceId': 'string',
'InstanceType': 'string',
'OwnerId': 'string'
},
],
'State': 'available'|'under-assessment'|'permanent-failure'|'released'|'released-permanent-failure'|'pending',
'AllocationTime': datetime(2015, 1, 1),
'ReleaseTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'HostRecovery': 'on'|'off',
'AllowsMultipleInstanceTypes': 'on'|'off',
'OwnerId': 'string',
'AvailabilityZoneId': 'string',
'MemberOfServiceLinkedResourceGroup': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Hosts (list) --
Information about the Dedicated Hosts.
(dict) --
Describes the properties of the Dedicated Host.
AutoPlacement (string) --
Whether auto-placement is on or off.
AvailabilityZone (string) --
The Availability Zone of the Dedicated Host.
AvailableCapacity (dict) --
Information about the instances running on the Dedicated Host.
AvailableInstanceCapacity (list) --
The number of instances that can be launched onto the Dedicated Host depending on the host's available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.
(dict) --
Information about the number of instances that can be launched onto the Dedicated Host.
AvailableCapacity (integer) --
The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.
InstanceType (string) --
The instance type supported by the Dedicated Host.
TotalCapacity (integer) --
The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.
AvailableVCpus (integer) --
The number of vCPUs available for launching instances onto the Dedicated Host.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
HostId (string) --
The ID of the Dedicated Host.
HostProperties (dict) --
The hardware specifications of the Dedicated Host.
Cores (integer) --
The number of cores on the Dedicated Host.
InstanceType (string) --
The instance type supported by the Dedicated Host. For example, m5.large . If the host supports multiple instance types, no instanceType is returned.
InstanceFamily (string) --
The instance family supported by the Dedicated Host. For example, m5 .
Sockets (integer) --
The number of sockets on the Dedicated Host.
TotalVCpus (integer) --
The total number of vCPUs on the Dedicated Host.
HostReservationId (string) --
The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.
Instances (list) --
The IDs and instance type that are currently running on the Dedicated Host.
(dict) --
Describes an instance running on a Dedicated Host.
InstanceId (string) --
The ID of instance that is running on the Dedicated Host.
InstanceType (string) --
The instance type (for example, m3.medium ) of the running instance.
OwnerId (string) --
The ID of the account that owns the instance.
State (string) --
The Dedicated Host's state.
AllocationTime (datetime) --
The time that the Dedicated Host was allocated.
ReleaseTime (datetime) --
The time that the Dedicated Host was released.
Tags (list) --
Any tags assigned to the Dedicated Host.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
HostRecovery (string) --
Indicates whether host recovery is enabled or disabled for the Dedicated Host.
AllowsMultipleInstanceTypes (string) --
Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on , the Dedicated Host supports multiple instance types in the instance family. If the value is off , the Dedicated Host supports a single instance type only.
OwnerId (string) --
The ID of the account that owns the Dedicated Host.
AvailabilityZoneId (string) --
The ID of the Availability Zone in which the Dedicated Host is allocated.
MemberOfServiceLinkedResourceGroup (boolean) --
Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true , the host is in a host resource group; otherwise, it is not.
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.
Describes your IAM instance profile associations.
See also: AWS API Documentation
Request Syntax
response = client.describe_iam_instance_profile_associations(
AssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
The IAM instance profile associations.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'IamInstanceProfileAssociations': [
{
'AssociationId': 'string',
'InstanceId': 'string',
'IamInstanceProfile': {
'Arn': 'string',
'Id': 'string'
},
'State': 'associating'|'associated'|'disassociating'|'disassociated',
'Timestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IamInstanceProfileAssociations (list) --
Information about the IAM instance profile associations.
(dict) --
Describes an association between an IAM instance profile and an instance.
AssociationId (string) --
The ID of the association.
InstanceId (string) --
The ID of the instance.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Id (string) --
The ID of the instance profile.
State (string) --
The state of the association.
Timestamp (datetime) --
The time the IAM instance profile was associated with the instance.
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.
Examples
This example describes the specified IAM instance profile association.
response = client.describe_iam_instance_profile_associations(
AssociationIds=[
'iip-assoc-0db249b1f25fa24b8',
],
)
print(response)
Expected Output:
{
'IamInstanceProfileAssociations': [
{
'AssociationId': 'iip-assoc-0db249b1f25fa24b8',
'IamInstanceProfile': {
'Arn': 'arn:aws:iam::123456789012:instance-profile/admin-role',
'Id': 'AIPAJVQN4F5WVLGCJDRGM',
},
'InstanceId': 'i-09eb09efa73ec1dee',
'State': 'associated',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .
These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
See also: AWS API Documentation
Request Syntax
response = client.describe_id_format(
Resource='string'
)
{
'Statuses': [
{
'Deadline': datetime(2015, 1, 1),
'Resource': 'string',
'UseLongIds': True|False
},
]
}
Response Structure
Information about the ID format for the resource.
Describes the ID format for a resource.
The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
The type of resource.
Indicates whether longer IDs (17-character IDs) are enabled for the resource.
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide .
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
See also: AWS API Documentation
Request Syntax
response = client.describe_identity_id_format(
PrincipalArn='string',
Resource='string'
)
[REQUIRED]
The ARN of the principal, which can be an IAM role, IAM user, or the root user.
dict
Response Syntax
{
'Statuses': [
{
'Deadline': datetime(2015, 1, 1),
'Resource': 'string',
'UseLongIds': True|False
},
]
}
Response Structure
(dict) --
Statuses (list) --
Information about the ID format for the resources.
(dict) --
Describes the ID format for a resource.
Deadline (datetime) --
The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
Resource (string) --
The type of resource.
UseLongIds (boolean) --
Indicates whether longer IDs (17-character IDs) are enabled for the resource.
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = client.describe_image_attribute(
Attribute='description'|'kernel'|'ramdisk'|'launchPermission'|'productCodes'|'blockDeviceMapping'|'sriovNetSupport'|'bootMode',
ImageId='string',
DryRun=True|False
)
[REQUIRED]
The AMI attribute.
Note : The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.
[REQUIRED]
The ID of the AMI.
dict
Response Syntax
{
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'ImageId': 'string',
'LaunchPermissions': [
{
'Group': 'all',
'UserId': 'string'
},
],
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'Description': {
'Value': 'string'
},
'KernelId': {
'Value': 'string'
},
'RamdiskId': {
'Value': 'string'
},
'SriovNetSupport': {
'Value': 'string'
},
'BootMode': {
'Value': 'string'
}
}
Response Structure
(dict) --
Describes an image attribute.
BlockDeviceMappings (list) --
The block device mapping entries.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
ImageId (string) --
The ID of the AMI.
LaunchPermissions (list) --
The launch permissions.
(dict) --
Describes a launch permission.
Group (string) --
The name of the group.
UserId (string) --
The AWS account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
ProductCodes (list) --
The product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
Description (dict) --
A description for the AMI.
Value (string) --
The attribute value. The value is case-sensitive.
KernelId (dict) --
The kernel ID.
Value (string) --
The attribute value. The value is case-sensitive.
RamdiskId (dict) --
The RAM disk ID.
Value (string) --
The attribute value. The value is case-sensitive.
SriovNetSupport (dict) --
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Value (string) --
The attribute value. The value is case-sensitive.
BootMode (dict) --
Describes a value for a resource attribute that is a String.
Value (string) --
The attribute value. The value is case-sensitive.
Examples
This example describes the launch permissions for the specified AMI.
response = client.describe_image_attribute(
Attribute='launchPermission',
ImageId='ami-5731123e',
)
print(response)
Expected Output:
{
'ImageId': 'ami-5731123e',
'LaunchPermissions': [
{
'UserId': '123456789012',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
See also: AWS API Documentation
Request Syntax
response = client.describe_images(
ExecutableUsers=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ImageIds=[
'string',
],
Owners=[
'string',
],
IncludeDeprecated=True|False,
DryRun=True|False
)
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The image IDs.
Default: Describes all images available to you.
Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, self , amazon , and aws-marketplace . If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.
If true , all deprecated AMIs are included in the response. If false , no deprecated AMIs are included in the response. If no value is specified, the default value is false .
Note
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false ) that you set for this parameter.
dict
Response Syntax
{
'Images': [
{
'Architecture': 'i386'|'x86_64'|'arm64',
'CreationDate': 'string',
'ImageId': 'string',
'ImageLocation': 'string',
'ImageType': 'machine'|'kernel'|'ramdisk',
'Public': True|False,
'KernelId': 'string',
'OwnerId': 'string',
'Platform': 'Windows',
'PlatformDetails': 'string',
'UsageOperation': 'string',
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'RamdiskId': 'string',
'State': 'pending'|'available'|'invalid'|'deregistered'|'transient'|'failed'|'error',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'Description': 'string',
'EnaSupport': True|False,
'Hypervisor': 'ovm'|'xen',
'ImageOwnerAlias': 'string',
'Name': 'string',
'RootDeviceName': 'string',
'RootDeviceType': 'ebs'|'instance-store',
'SriovNetSupport': 'string',
'StateReason': {
'Code': 'string',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VirtualizationType': 'hvm'|'paravirtual',
'BootMode': 'legacy-bios'|'uefi',
'DeprecationTime': 'string'
},
]
}
Response Structure
(dict) --
Images (list) --
Information about the images.
(dict) --
Describes an image.
Architecture (string) --
The architecture of the image.
CreationDate (string) --
The date and time the image was created.
ImageId (string) --
The ID of the AMI.
ImageLocation (string) --
The location of the AMI.
ImageType (string) --
The type of image.
Public (boolean) --
Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
KernelId (string) --
The kernel associated with the image, if any. Only applicable for machine images.
OwnerId (string) --
The AWS account ID of the image owner.
Platform (string) --
This value is set to windows for Windows AMIs; otherwise, it is blank.
PlatformDetails (string) --
The platform details associated with the billing code of the AMI. For more information, see Obtaining Billing Information in the Amazon Elastic Compute Cloud User Guide .
UsageOperation (string) --
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your AWS Cost and Usage Report and in the AWS Price List API . For the list of UsageOperation codes, see Platform Details and Usage Operation Billing Codes in the Amazon Elastic Compute Cloud User Guide .
ProductCodes (list) --
Any product codes associated with the AMI.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
RamdiskId (string) --
The RAM disk associated with the image, if any. Only applicable for machine images.
State (string) --
The current state of the AMI. If the state is available , the image is successfully registered and can be used to launch an instance.
BlockDeviceMappings (list) --
Any block device mapping entries.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
Description (string) --
The description of the AMI that was provided during image creation.
EnaSupport (boolean) --
Specifies whether enhanced networking with ENA is enabled.
Hypervisor (string) --
The hypervisor type of the image.
ImageOwnerAlias (string) --
The AWS account alias (for example, amazon , self ) or the AWS account ID of the AMI owner.
Name (string) --
The name of the AMI that was provided during image creation.
RootDeviceName (string) --
The device name of the root device volume (for example, /dev/sda1 ).
RootDeviceType (string) --
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
SriovNetSupport (string) --
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason (dict) --
The reason for the state change.
Code (string) --
The reason code for the state change.
Message (string) --
The message for the state change.
Tags (list) --
Any tags assigned to the image.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VirtualizationType (string) --
The type of virtualization of the AMI.
BootMode (string) --
The boot mode of the image. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide .
DeprecationTime (string) --
The date and time to deprecate the AMI, in UTC, in the following format: YYYY -MM -DD T*HH* :MM :SS Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
Examples
This example describes the specified AMI.
response = client.describe_images(
ImageIds=[
'ami-5731123e',
],
)
print(response)
Expected Output:
{
'Images': [
{
'Architecture': 'x86_64',
'BlockDeviceMappings': [
{
'DeviceName': '/dev/sda1',
'Ebs': {
'DeleteOnTermination': True,
'SnapshotId': 'snap-1234567890abcdef0',
'VolumeSize': 8,
'VolumeType': 'standard',
},
},
],
'Description': 'An AMI for my server',
'Hypervisor': 'xen',
'ImageId': 'ami-5731123e',
'ImageLocation': '123456789012/My server',
'ImageType': 'machine',
'KernelId': 'aki-88aa75e1',
'Name': 'My server',
'OwnerId': '123456789012',
'Public': False,
'RootDeviceName': '/dev/sda1',
'RootDeviceType': 'ebs',
'State': 'available',
'VirtualizationType': 'paravirtual',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Displays details about an import virtual machine or import snapshot tasks that are already created.
See also: AWS API Documentation
Request Syntax
response = client.describe_import_image_tasks(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ImportTaskIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
Filter tasks using the task-state filter and one of the following values: active , completed , deleting , or deleted .
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the import image tasks.
dict
Response Syntax
{
'ImportImageTasks': [
{
'Architecture': 'string',
'Description': 'string',
'Encrypted': True|False,
'Hypervisor': 'string',
'ImageId': 'string',
'ImportTaskId': 'string',
'KmsKeyId': 'string',
'LicenseType': 'string',
'Platform': 'string',
'Progress': 'string',
'SnapshotDetails': [
{
'Description': 'string',
'DeviceName': 'string',
'DiskImageSize': 123.0,
'Format': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'Url': 'string',
'UserBucket': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
],
'Status': 'string',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ImportImageTasks (list) --
A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.
(dict) --
Describes an import image task.
Architecture (string) --
The architecture of the virtual machine.
Valid values: i386 | x86_64 | arm64
Description (string) --
A description of the import task.
Encrypted (boolean) --
Indicates whether the image is encrypted.
Hypervisor (string) --
The target hypervisor for the import task.
Valid values: xen
ImageId (string) --
The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
ImportTaskId (string) --
The ID of the import image task.
KmsKeyId (string) --
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted image.
LicenseType (string) --
The license type of the virtual machine.
Platform (string) --
The description string for the import image task.
Progress (string) --
The percentage of progress of the import image task.
SnapshotDetails (list) --
Information about the snapshots.
(dict) --
Describes the snapshot created from the imported disk.
Description (string) --
A description for the snapshot.
DeviceName (string) --
The block device mapping for the snapshot.
DiskImageSize (float) --
The size of the disk in the snapshot, in GiB.
Format (string) --
The format of the disk image from which the snapshot is created.
Progress (string) --
The percentage of progress for the task.
SnapshotId (string) --
The snapshot ID of the disk being imported.
Status (string) --
A brief status of the snapshot creation.
StatusMessage (string) --
A detailed status message for the snapshot creation.
Url (string) --
The URL used to access the disk image.
UserBucket (dict) --
The Amazon S3 bucket for the disk image.
S3Bucket (string) --
The Amazon S3 bucket from which the disk image was created.
S3Key (string) --
The file name of the disk image.
Status (string) --
A brief status for the import image task.
StatusMessage (string) --
A descriptive status message for the import image task.
Tags (list) --
The tags for the import image task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
LicenseSpecifications (list) --
The ARNs of the license configurations that are associated with the import image task.
(dict) --
The response information for license configurations.
LicenseConfigurationArn (string) --
The ARN of a license configuration.
NextToken (string) --
The token to use to get the next page of results. This value is null when there are no more results to return.
Describes your import snapshot tasks.
See also: AWS API Documentation
Request Syntax
response = client.describe_import_snapshot_tasks(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ImportTaskIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A list of import snapshot task IDs.
dict
Response Syntax
{
'ImportSnapshotTasks': [
{
'Description': 'string',
'ImportTaskId': 'string',
'SnapshotTaskDetail': {
'Description': 'string',
'DiskImageSize': 123.0,
'Encrypted': True|False,
'Format': 'string',
'KmsKeyId': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'Url': 'string',
'UserBucket': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ImportSnapshotTasks (list) --
A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
(dict) --
Describes an import snapshot task.
Description (string) --
A description of the import snapshot task.
ImportTaskId (string) --
The ID of the import snapshot task.
SnapshotTaskDetail (dict) --
Describes an import snapshot task.
Description (string) --
The description of the snapshot.
DiskImageSize (float) --
The size of the disk in the snapshot, in GiB.
Encrypted (boolean) --
Indicates whether the snapshot is encrypted.
Format (string) --
The format of the disk image from which the snapshot is created.
KmsKeyId (string) --
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted snapshot.
Progress (string) --
The percentage of completion for the import snapshot task.
SnapshotId (string) --
The snapshot ID of the disk being imported.
Status (string) --
A brief status for the import snapshot task.
StatusMessage (string) --
A detailed status message for the import snapshot task.
Url (string) --
The URL of the disk image from which the snapshot is created.
UserBucket (dict) --
The Amazon S3 bucket for the disk image.
S3Bucket (string) --
The Amazon S3 bucket from which the disk image was created.
S3Key (string) --
The file name of the disk image.
Tags (list) --
The tags for the import snapshot task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
NextToken (string) --
The token to use to get the next page of results. This value is null when there are no more results to return.
Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_attribute(
Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions',
DryRun=True|False,
InstanceId='string'
)
[REQUIRED]
The instance attribute.
Note: The enaSupport attribute is not supported at this time.
[REQUIRED]
The ID of the instance.
dict
Response Syntax
{
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'Ebs': {
'AttachTime': datetime(2015, 1, 1),
'DeleteOnTermination': True|False,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'VolumeId': 'string'
}
},
],
'DisableApiTermination': {
'Value': True|False
},
'EnaSupport': {
'Value': True|False
},
'EnclaveOptions': {
'Enabled': True|False
},
'EbsOptimized': {
'Value': True|False
},
'InstanceId': 'string',
'InstanceInitiatedShutdownBehavior': {
'Value': 'string'
},
'InstanceType': {
'Value': 'string'
},
'KernelId': {
'Value': 'string'
},
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'RamdiskId': {
'Value': 'string'
},
'RootDeviceName': {
'Value': 'string'
},
'SourceDestCheck': {
'Value': True|False
},
'SriovNetSupport': {
'Value': 'string'
},
'UserData': {
'Value': 'string'
}
}
Response Structure
(dict) --
Describes an instance attribute.
Groups (list) --
The security groups associated with the instance.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
BlockDeviceMappings (list) --
The block device mapping of the instance.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
AttachTime (datetime) --
The time stamp when the attachment initiated.
DeleteOnTermination (boolean) --
Indicates whether the volume is deleted on instance termination.
Status (string) --
The attachment state.
VolumeId (string) --
The ID of the EBS volume.
DisableApiTermination (dict) --
If the value is true , you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.
Value (boolean) --
The attribute value. The valid values are true or false .
EnaSupport (dict) --
Indicates whether enhanced networking with ENA is enabled.
Value (boolean) --
The attribute value. The valid values are true or false .
EnclaveOptions (dict) --
To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true ; otherwise, set it to false .
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
EbsOptimized (dict) --
Indicates whether the instance is optimized for Amazon EBS I/O.
Value (boolean) --
The attribute value. The valid values are true or false .
InstanceId (string) --
The ID of the instance.
InstanceInitiatedShutdownBehavior (dict) --
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Value (string) --
The attribute value. The value is case-sensitive.
InstanceType (dict) --
The instance type.
Value (string) --
The attribute value. The value is case-sensitive.
KernelId (dict) --
The kernel ID.
Value (string) --
The attribute value. The value is case-sensitive.
ProductCodes (list) --
A list of product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
RamdiskId (dict) --
The RAM disk ID.
Value (string) --
The attribute value. The value is case-sensitive.
RootDeviceName (dict) --
The device name of the root device volume (for example, /dev/sda1 ).
Value (string) --
The attribute value. The value is case-sensitive.
SourceDestCheck (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 .
SriovNetSupport (dict) --
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Value (string) --
The attribute value. The value is case-sensitive.
UserData (dict) --
The user data.
Value (string) --
The attribute value. The value is case-sensitive.
Examples
This example describes the instance type of the specified instance.
response = client.describe_instance_attribute(
Attribute='instanceType',
InstanceId='i-1234567890abcdef0',
)
print(response)
Expected Output:
{
'InstanceId': 'i-1234567890abcdef0',
'InstanceType': {
'Value': 't1.micro',
},
'ResponseMetadata': {
'...': '...',
},
}
This example describes the disableApiTermination attribute of the specified instance.
response = client.describe_instance_attribute(
Attribute='disableApiTermination',
InstanceId='i-1234567890abcdef0',
)
print(response)
Expected Output:
{
'DisableApiTermination': {
'Value': 'false',
},
'InstanceId': 'i-1234567890abcdef0',
'ResponseMetadata': {
'...': '...',
},
}
This example describes the blockDeviceMapping attribute of the specified instance.
response = client.describe_instance_attribute(
Attribute='blockDeviceMapping',
InstanceId='i-1234567890abcdef0',
)
print(response)
Expected Output:
{
'BlockDeviceMappings': [
{
'DeviceName': '/dev/sda1',
'Ebs': {
'AttachTime': datetime(2013, 5, 17, 22, 42, 34, 4, 137, 0),
'DeleteOnTermination': True,
'Status': 'attached',
'VolumeId': 'vol-049df61146c4d7901',
},
},
{
'DeviceName': '/dev/sdf',
'Ebs': {
'AttachTime': datetime(2013, 9, 10, 23, 7, 0, 1, 253, 0),
'DeleteOnTermination': False,
'Status': 'attached',
'VolumeId': 'vol-049df61146c4d7901',
},
},
],
'InstanceId': 'i-1234567890abcdef0',
'ResponseMetadata': {
'...': '...',
},
}
Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited .
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited , to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited ) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_credit_specifications(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
dict
Response Syntax
{
'InstanceCreditSpecifications': [
{
'InstanceId': 'string',
'CpuCredits': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceCreditSpecifications (list) --
Information about the credit option for CPU usage of an instance.
(dict) --
Describes the credit option for CPU usage of a burstable performance instance.
InstanceId (string) --
The ID of the instance.
CpuCredits (string) --
The credit option for CPU usage of the instance. Valid values are standard and unlimited .
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.
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_event_notification_attributes(
DryRun=True|False
)
{
'InstanceTagAttribute': {
'InstanceTagKeys': [
'string',
],
'IncludeAllTagsOfInstance': True|False
}
}
Response Structure
Information about the registered tag keys.
The registered tag keys.
Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_status(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
MaxResults=123,
NextToken='string',
DryRun=True|False,
IncludeAllInstances=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
When true , includes the health status for all instances. When false , includes the health status for running instances only.
Default: false
dict
Response Syntax
{
'InstanceStatuses': [
{
'AvailabilityZone': 'string',
'OutpostArn': 'string',
'Events': [
{
'InstanceEventId': 'string',
'Code': 'instance-reboot'|'system-reboot'|'system-maintenance'|'instance-retirement'|'instance-stop',
'Description': 'string',
'NotAfter': datetime(2015, 1, 1),
'NotBefore': datetime(2015, 1, 1),
'NotBeforeDeadline': datetime(2015, 1, 1)
},
],
'InstanceId': 'string',
'InstanceState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
},
'SystemStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceStatuses (list) --
Information about the status of the instances.
(dict) --
Describes the status of an instance.
AvailabilityZone (string) --
The Availability Zone of the instance.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Events (list) --
Any scheduled events associated with the instance.
(dict) --
Describes a scheduled event for an instance.
InstanceEventId (string) --
The ID of the event.
Code (string) --
The event code.
Description (string) --
A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
NotAfter (datetime) --
The latest scheduled end time for the event.
NotBefore (datetime) --
The earliest scheduled start time for the event.
NotBeforeDeadline (datetime) --
The deadline for starting the event.
InstanceId (string) --
The ID of the instance.
InstanceState (dict) --
The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceStatus (dict) --
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
Details (list) --
The system instance health or application instance health.
(dict) --
Describes the instance status.
ImpairedSince (datetime) --
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
Name (string) --
The type of instance status.
Status (string) --
The status.
Status (string) --
The status.
SystemStatus (dict) --
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
Details (list) --
The system instance health or application instance health.
(dict) --
Describes the instance status.
ImpairedSince (datetime) --
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
Name (string) --
The type of instance status.
Status (string) --
The status.
Status (string) --
The status.
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.
Examples
This example describes the current status of the specified instance.
response = client.describe_instance_status(
InstanceIds=[
'i-1234567890abcdef0',
],
)
print(response)
Expected Output:
{
'InstanceStatuses': [
{
'AvailabilityZone': 'us-east-1d',
'InstanceId': 'i-1234567890abcdef0',
'InstanceState': {
'Code': 16,
'Name': 'running',
},
'InstanceStatus': {
'Details': [
{
'Name': 'reachability',
'Status': 'passed',
},
],
'Status': 'ok',
},
'SystemStatus': {
'Details': [
{
'Name': 'reachability',
'Status': 'passed',
},
],
'Status': 'ok',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_type_offerings(
DryRun=True|False,
LocationType='region'|'availability-zone'|'availability-zone-id',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'InstanceTypeOfferings': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'LocationType': 'region'|'availability-zone'|'availability-zone-id',
'Location': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceTypeOfferings (list) --
The instance types offered.
(dict) --
The instance types offered.
InstanceType (string) --
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .
LocationType (string) --
The location type.
Location (string) --
The identifier for the location. This depends on the location type. For example, if the location type is region , the location is the Region code (for example, us-east-2 .)
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.
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
response = client.describe_instance_types(
DryRun=True|False,
InstanceTypes=[
'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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
The instance types. For more information, see Instance types in the Amazon EC2 User Guide .
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'InstanceTypes': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'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',
],
'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'
},
'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
}
},
'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.
SupportedRootDeviceTypes (list) --
The supported root device types.
SupportedVirtualizationTypes (list) --
The supported virtualization types.
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.
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.
ValidThreadsPerCore (list) --
The valid number of threads per core that can be configured for the instance type.
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 the 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 for instance store.
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.
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.
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 .
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.
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
See also: AWS API Documentation
Request Syntax
response = client.describe_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
dict
Response Syntax
{
'Reservations': [
{
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'Instances': [
{
'AmiLaunchIndex': 123,
'ImageId': 'string',
'InstanceId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'LaunchTime': datetime(2015, 1, 1),
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
},
'Platform': 'Windows',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'PublicDnsName': 'string',
'PublicIpAddress': 'string',
'RamdiskId': 'string',
'State': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'StateTransitionReason': 'string',
'SubnetId': 'string',
'VpcId': 'string',
'Architecture': 'i386'|'x86_64'|'arm64',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'Ebs': {
'AttachTime': datetime(2015, 1, 1),
'DeleteOnTermination': True|False,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'VolumeId': 'string'
}
},
],
'ClientToken': 'string',
'EbsOptimized': True|False,
'EnaSupport': True|False,
'Hypervisor': 'ovm'|'xen',
'IamInstanceProfile': {
'Arn': 'string',
'Id': 'string'
},
'InstanceLifecycle': 'spot'|'scheduled',
'ElasticGpuAssociations': [
{
'ElasticGpuId': 'string',
'ElasticGpuAssociationId': 'string',
'ElasticGpuAssociationState': 'string',
'ElasticGpuAssociationTime': 'string'
},
],
'ElasticInferenceAcceleratorAssociations': [
{
'ElasticInferenceAcceleratorArn': 'string',
'ElasticInferenceAcceleratorAssociationId': 'string',
'ElasticInferenceAcceleratorAssociationState': 'string',
'ElasticInferenceAcceleratorAssociationTime': datetime(2015, 1, 1)
},
],
'NetworkInterfaces': [
{
'Association': {
'CarrierIp': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string'
},
'Attachment': {
'AttachTime': datetime(2015, 1, 1),
'AttachmentId': 'string',
'DeleteOnTermination': True|False,
'DeviceIndex': 123,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'NetworkCardIndex': 123
},
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OwnerId': 'string',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Association': {
'CarrierIp': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string'
},
'Primary': True|False,
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string'
},
],
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'VpcId': 'string',
'InterfaceType': 'string'
},
],
'OutpostArn': 'string',
'RootDeviceName': 'string',
'RootDeviceType': 'ebs'|'instance-store',
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'SourceDestCheck': True|False,
'SpotInstanceRequestId': 'string',
'SriovNetSupport': 'string',
'StateReason': {
'Code': 'string',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VirtualizationType': 'hvm'|'paravirtual',
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationId': 'string',
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'HibernationOptions': {
'Configured': True|False
},
'Licenses': [
{
'LicenseConfigurationArn': 'string'
},
],
'MetadataOptions': {
'State': 'pending'|'applied',
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
},
'BootMode': 'legacy-bios'|'uefi'
},
],
'OwnerId': 'string',
'RequesterId': 'string',
'ReservationId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Reservations (list) --
Information about the reservations.
(dict) --
Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.
Groups (list) --
[EC2-Classic only] The security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
Instances (list) --
The instances.
(dict) --
Describes an instance.
AmiLaunchIndex (integer) --
The AMI launch index, which can be used to find this instance in the launch group.
ImageId (string) --
The ID of the AMI used to launch the instance.
InstanceId (string) --
The ID of the instance.
InstanceType (string) --
The instance type.
KernelId (string) --
The kernel associated with this instance, if applicable.
KeyName (string) --
The name of the key pair, if this instance was launched with an associated key pair.
LaunchTime (datetime) --
The time the instance was launched.
Monitoring (dict) --
The monitoring for the instance.
State (string) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Placement (dict) --
The location where the instance launched, if applicable.
AvailabilityZone (string) --
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
Affinity (string) --
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
GroupName (string) --
The name of the placement group the instance is in.
PartitionNumber (integer) --
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
HostId (string) --
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
SpreadDomain (string) --
Reserved for future use.
This parameter is not supported by CreateFleet .
HostResourceGroupArn (string) --
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
Platform (string) --
The value is Windows for Windows instances; otherwise blank.
PrivateDnsName (string) --
(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
PrivateIpAddress (string) --
The private IPv4 address assigned to the instance.
ProductCodes (list) --
The product codes attached to this instance, if applicable.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
PublicDnsName (string) --
(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.
PublicIpAddress (string) --
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
RamdiskId (string) --
The RAM disk associated with this instance, if applicable.
State (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
StateTransitionReason (string) --
The reason for the most recent state transition. This might be an empty string.
SubnetId (string) --
[EC2-VPC] The ID of the subnet in which the instance is running.
VpcId (string) --
[EC2-VPC] The ID of the VPC in which the instance is running.
Architecture (string) --
The architecture of the image.
BlockDeviceMappings (list) --
Any block device mapping entries for the instance.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
AttachTime (datetime) --
The time stamp when the attachment initiated.
DeleteOnTermination (boolean) --
Indicates whether the volume is deleted on instance termination.
Status (string) --
The attachment state.
VolumeId (string) --
The ID of the EBS volume.
ClientToken (string) --
The idempotency token you provided when you launched the instance, if applicable.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
EnaSupport (boolean) --
Specifies whether enhanced networking with ENA is enabled.
Hypervisor (string) --
The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.
IamInstanceProfile (dict) --
The IAM instance profile associated with the instance, if applicable.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Id (string) --
The ID of the instance profile.
InstanceLifecycle (string) --
Indicates whether this is a Spot Instance or a Scheduled Instance.
ElasticGpuAssociations (list) --
The Elastic GPU associated with the instance.
(dict) --
Describes the association between an instance and an Elastic Graphics accelerator.
ElasticGpuId (string) --
The ID of the Elastic Graphics accelerator.
ElasticGpuAssociationId (string) --
The ID of the association.
ElasticGpuAssociationState (string) --
The state of the association between the instance and the Elastic Graphics accelerator.
ElasticGpuAssociationTime (string) --
The time the Elastic Graphics accelerator was associated with the instance.
ElasticInferenceAcceleratorAssociations (list) --
The elastic inference accelerator associated with the instance.
(dict) --
Describes the association between an instance and an elastic inference accelerator.
ElasticInferenceAcceleratorArn (string) --
The Amazon Resource Name (ARN) of the elastic inference accelerator.
ElasticInferenceAcceleratorAssociationId (string) --
The ID of the association.
ElasticInferenceAcceleratorAssociationState (string) --
The state of the elastic inference accelerator.
ElasticInferenceAcceleratorAssociationTime (datetime) --
The time at which the elastic inference accelerator is associated with an instance.
NetworkInterfaces (list) --
[EC2-VPC] The network interfaces for the instance.
(dict) --
Describes a network interface.
Association (dict) --
The association information for an Elastic IPv4 associated with the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
IpOwnerId (string) --
The ID of the owner of the Elastic IP address.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The public IP address or Elastic IP address bound to the network interface.
Attachment (dict) --
The network interface attachment.
AttachTime (datetime) --
The time stamp 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 index of the device on the instance for the network interface attachment.
Status (string) --
The attachment state.
NetworkCardIndex (integer) --
The index of the network card.
Description (string) --
The description.
Groups (list) --
One or more security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
Ipv6Addresses (list) --
One or more IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OwnerId (string) --
The ID of the account that created the network interface.
PrivateDnsName (string) --
The private DNS name.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
PrivateIpAddresses (list) --
One or more private IPv4 addresses associated with the network interface.
(dict) --
Describes a private IPv4 address.
Association (dict) --
The association information for an Elastic IP address for the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
IpOwnerId (string) --
The ID of the owner of the Elastic IP address.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The public IP address or Elastic IP address bound to the network interface.
Primary (boolean) --
Indicates whether this IPv4 address is the primary private IP address of the network interface.
PrivateDnsName (string) --
The private IPv4 DNS name.
PrivateIpAddress (string) --
The private IPv4 address of the network interface.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
Status (string) --
The status of the network interface.
SubnetId (string) --
The ID of the subnet.
VpcId (string) --
The ID of the VPC.
InterfaceType (string) --
Describes the type of network interface.
Valid values: interface | efa | trunk
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
RootDeviceName (string) --
The device name of the root device volume (for example, /dev/sda1 ).
RootDeviceType (string) --
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
SecurityGroups (list) --
The security groups for the instance.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
SpotInstanceRequestId (string) --
If the request is a Spot Instance request, the ID of the request.
SriovNetSupport (string) --
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason (dict) --
The reason for the most recent state transition.
Code (string) --
The reason code for the state change.
Message (string) --
The message for the state change.
Tags (list) --
Any tags assigned to the instance.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VirtualizationType (string) --
The virtualization type of the instance.
CpuOptions (dict) --
The CPU options for the instance.
CoreCount (integer) --
The number of CPU cores for the instance.
ThreadsPerCore (integer) --
The number of threads per CPU core.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
CapacityReservationSpecification (dict) --
Information about the Capacity Reservation targeting option.
CapacityReservationPreference (string) --
Describes the instance's Capacity Reservation preferences. Possible preferences include:
CapacityReservationTarget (dict) --
Information about the targeted Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) --
The ID of the targeted Capacity Reservation.
CapacityReservationResourceGroupArn (string) --
The ARN of the targeted Capacity Reservation group.
HibernationOptions (dict) --
Indicates whether the instance is enabled for hibernation.
Configured (boolean) --
If this parameter is set to true , your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
Licenses (list) --
The license configurations.
(dict) --
Describes a license configuration.
LicenseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the license configuration.
MetadataOptions (dict) --
The metadata options for the instance.
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
EnclaveOptions (dict) --
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
BootMode (string) --
The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide .
OwnerId (string) --
The ID of the account that owns the reservation.
RequesterId (string) --
The ID of the requester that launched the instances on your behalf (for example, Management Console or Auto Scaling).
ReservationId (string) --
The ID of the reservation.
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.
Examples
This example describes the specified instance.
response = client.describe_instances(
InstanceIds=[
'i-1234567890abcdef0',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example describes the instances with the t2.micro instance type.
response = client.describe_instances(
Filters=[
{
'Name': 'instance-type',
'Values': [
't2.micro',
],
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example describes the instances with the Purpose=test tag.
response = client.describe_instances(
Filters=[
{
'Name': 'tag:Purpose',
'Values': [
'test',
],
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more of your internet gateways.
See also: AWS API Documentation
Request Syntax
response = client.describe_internet_gateways(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
InternetGatewayIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more internet gateway IDs.
Default: Describes all your internet gateways.
dict
Response Syntax
{
'InternetGateways': [
{
'Attachments': [
{
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
},
],
'InternetGatewayId': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InternetGateways (list) --
Information about one or more internet gateways.
(dict) --
Describes an internet gateway.
Attachments (list) --
Any VPCs attached to the internet gateway.
(dict) --
Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
State (string) --
The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
VpcId (string) --
The ID of the VPC.
InternetGatewayId (string) --
The ID of the internet gateway.
OwnerId (string) --
The ID of the AWS account that owns the internet gateway.
Tags (list) --
Any tags assigned to the internet gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Examples
This example describes the Internet gateway for the specified VPC.
response = client.describe_internet_gateways(
Filters=[
{
'Name': 'attachment.vpc-id',
'Values': [
'vpc-a01106c2',
],
},
],
)
print(response)
Expected Output:
{
'InternetGateways': [
{
'Attachments': [
{
'State': 'available',
'VpcId': 'vpc-a01106c2',
},
],
'InternetGatewayId': 'igw-c0a643a9',
'Tags': [
],
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes your IPv6 address pools.
See also: AWS API Documentation
Request Syntax
response = client.describe_ipv6_pools(
PoolIds=[
'string',
],
NextToken='string',
MaxResults=123,
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
The IDs of the IPv6 address pools.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'Ipv6Pools': [
{
'PoolId': 'string',
'Description': 'string',
'PoolCidrBlocks': [
{
'Cidr': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Ipv6Pools (list) --
Information about the IPv6 address pools.
(dict) --
Describes an IPv6 address pool.
PoolId (string) --
The ID of the address pool.
Description (string) --
The description for the address pool.
PoolCidrBlocks (list) --
The CIDR blocks for the address pool.
(dict) --
Describes a CIDR block for an address pool.
Cidr (string) --
The CIDR block.
Tags (list) --
Any tags for the address pool.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_key_pairs(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
KeyNames=[
'string',
],
KeyPairIds=[
'string',
],
DryRun=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The key pair names.
Default: Describes all of your key pairs.
The IDs of the key pairs.
dict
Response Syntax
{
'KeyPairs': [
{
'KeyPairId': 'string',
'KeyFingerprint': 'string',
'KeyName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
KeyPairs (list) --
Information about the key pairs.
(dict) --
Describes a key pair.
KeyPairId (string) --
The ID of the key pair.
KeyFingerprint (string) --
If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide Amazon Web Services the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
KeyName (string) --
The name of the key pair.
Tags (list) --
Any tags applied to the key pair.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example displays the fingerprint for the specified key.
response = client.describe_key_pairs(
KeyNames=[
'my-key-pair',
],
)
print(response)
Expected Output:
{
'KeyPairs': [
{
'KeyFingerprint': '1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f',
'KeyName': 'my-key-pair',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_launch_template_versions(
DryRun=True|False,
LaunchTemplateId='string',
LaunchTemplateName='string',
Versions=[
'string',
],
MinVersion='string',
MaxVersion='string',
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest , $Default , and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest . To describe all launch templates in your account that are defined as the default version, the valid value is $Default . You can specify $Latest and $Default in the same call. You cannot specify numbers.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LaunchTemplateVersions': [
{
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'VersionNumber': 123,
'VersionDescription': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersion': True|False,
'LaunchTemplateData': {
'KernelId': 'string',
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'Encrypted': True|False,
'DeleteOnTermination': True|False,
'Iops': 123,
'KmsKeyId': 'string',
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'Throughput': 123
},
'NoDevice': 'string'
},
],
'NetworkInterfaces': [
{
'AssociateCarrierIpAddress': True|False,
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'InterfaceType': 'string',
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'NetworkCardIndex': 123
},
],
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string',
'PartitionNumber': 123
},
'RamDiskId': 'string',
'DisableApiTermination': True|False,
'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
'UserData': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ElasticGpuSpecifications': [
{
'Type': 'string'
},
],
'ElasticInferenceAccelerators': [
{
'Type': 'string',
'Count': 123
},
],
'SecurityGroupIds': [
'string',
],
'SecurityGroups': [
'string',
],
'InstanceMarketOptions': {
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
'CreditSpecification': {
'CpuCredits': 'string'
},
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
'HibernationOptions': {
'Configured': True|False
},
'MetadataOptions': {
'State': 'pending'|'applied',
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LaunchTemplateVersions (list) --
Information about the launch template versions.
(dict) --
Describes a launch template version.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
VersionNumber (integer) --
The version number.
VersionDescription (string) --
The description for the version.
CreateTime (datetime) --
The time the version was created.
CreatedBy (string) --
The principal that created the version.
DefaultVersion (boolean) --
Indicates whether the version is the default version.
LaunchTemplateData (dict) --
Information about the launch template.
KernelId (string) --
The ID of the kernel, if applicable.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for Amazon EBS I/O.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
BlockDeviceMappings (list) --
The block device mappings.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name.
VirtualName (string) --
The virtual device name (ephemeralN).
Ebs (dict) --
Information about the block device for an EBS volume.
Encrypted (boolean) --
Indicates whether the EBS volume is encrypted.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports.
KmsKeyId (string) --
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiB.
VolumeType (string) --
The volume type.
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
NetworkInterfaces (list) --
The network interfaces.
(dict) --
Describes a network interface.
AssociateCarrierIpAddress (boolean) --
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide .
AssociatePublicIpAddress (boolean) --
Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
DeleteOnTermination (boolean) --
Indicates whether the network interface is deleted when the instance is terminated.
Description (string) --
A description for the network interface.
DeviceIndex (integer) --
The device index for the network interface attachment.
Groups (list) --
The IDs of one or more security groups.
InterfaceType (string) --
The type of network interface.
Ipv6AddressCount (integer) --
The number of IPv6 addresses for the network interface.
Ipv6Addresses (list) --
The IPv6 addresses for the network interface.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
PrivateIpAddress (string) --
The primary private IPv4 address of the network interface.
PrivateIpAddresses (list) --
One or more private IPv4 addresses.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses for the network interface.
SubnetId (string) --
The ID of the subnet for the network interface.
NetworkCardIndex (integer) --
The index of the network card.
ImageId (string) --
The ID of the AMI that was used to launch the instance.
InstanceType (string) --
The instance type.
KeyName (string) --
The name of the key pair.
Monitoring (dict) --
The monitoring for the instance.
Enabled (boolean) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Placement (dict) --
The placement of the instance.
AvailabilityZone (string) --
The Availability Zone of the instance.
Affinity (string) --
The affinity setting for the instance on the Dedicated Host.
GroupName (string) --
The name of the placement group for the instance.
HostId (string) --
The ID of the Dedicated Host for the instance.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
SpreadDomain (string) --
Reserved for future use.
HostResourceGroupArn (string) --
The ARN of the host resource group in which to launch the instances.
PartitionNumber (integer) --
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .
RamDiskId (string) --
The ID of the RAM disk, if applicable.
DisableApiTermination (boolean) --
If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
InstanceInitiatedShutdownBehavior (string) --
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
UserData (string) --
The user data for the instance.
TagSpecifications (list) --
The tags.
(dict) --
The tag specification for the launch template.
ResourceType (string) --
The type of resource.
Tags (list) --
The tags for the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ElasticGpuSpecifications (list) --
The elastic GPU specification.
(dict) --
Describes an elastic GPU.
Type (string) --
The elastic GPU type.
ElasticInferenceAccelerators (list) --
The elastic inference accelerator for the instance.
(dict) --
Describes an elastic inference accelerator.
Type (string) --
The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
Count (integer) --
The number of elastic inference accelerators to attach to the instance.
Default: 1
SecurityGroupIds (list) --
The security group IDs.
SecurityGroups (list) --
The security group names.
InstanceMarketOptions (dict) --
The market (purchasing) option for the instances.
MarketType (string) --
The market type.
SpotOptions (dict) --
The options for Spot Instances.
MaxPrice (string) --
The maximum hourly price you're willing to pay for the Spot Instances.
SpotInstanceType (string) --
The Spot Instance request type.
BlockDurationMinutes (integer) --
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
ValidUntil (datetime) --
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted.
CreditSpecification (dict) --
The credit option for CPU usage of the instance.
CpuCredits (string) --
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
CpuOptions (dict) --
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide .
CoreCount (integer) --
The number of CPU cores for the instance.
ThreadsPerCore (integer) --
The number of threads per CPU core.
CapacityReservationSpecification (dict) --
Information about the Capacity Reservation targeting option.
CapacityReservationPreference (string) --
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
CapacityReservationTarget (dict) --
Information about the target Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) --
The ID of the targeted Capacity Reservation.
CapacityReservationResourceGroupArn (string) --
The ARN of the targeted Capacity Reservation group.
LicenseSpecifications (list) --
The license configurations.
(dict) --
Describes a license configuration.
LicenseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the license configuration.
HibernationOptions (dict) --
Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide .
Configured (boolean) --
If this parameter is set to true , the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
MetadataOptions (dict) --
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide .
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
EnclaveOptions (dict) --
Indicates whether the instance is enabled for AWS Nitro Enclaves.
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.
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.
Examples
This example describes the versions for the specified launch template.
response = client.describe_launch_template_versions(
LaunchTemplateId='068f72b72934aff71',
)
print(response)
Expected Output:
{
'LaunchTemplateVersions': [
{
'CreateTime': datetime(2017, 11, 20, 13, 12, 32, 0, 324, 0),
'CreatedBy': 'arn:aws:iam::123456789102:root',
'DefaultVersion': False,
'LaunchTemplateData': {
'ImageId': 'ami-6057e21a',
'InstanceType': 't2.medium',
'KeyName': 'kp-us-east',
'NetworkInterfaces': [
{
'DeviceIndex': 0,
'Groups': [
'sg-7c227019',
],
'SubnetId': 'subnet-1a2b3c4d',
},
],
},
'LaunchTemplateId': 'lt-068f72b72934aff71',
'LaunchTemplateName': 'Webservers',
'VersionNumber': 2,
},
{
'CreateTime': datetime(2017, 11, 20, 12, 52, 33, 0, 324, 0),
'CreatedBy': 'arn:aws:iam::123456789102:root',
'DefaultVersion': True,
'LaunchTemplateData': {
'ImageId': 'ami-aabbcc11',
'InstanceType': 't2.medium',
'KeyName': 'kp-us-east',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True,
'DeleteOnTermination': False,
'DeviceIndex': 0,
'Groups': [
'sg-7c227019',
],
'SubnetId': 'subnet-7b16de0c',
},
],
'UserData': '',
},
'LaunchTemplateId': 'lt-068f72b72934aff71',
'LaunchTemplateName': 'Webservers',
'VersionNumber': 1,
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more launch templates.
See also: AWS API Documentation
Request Syntax
response = client.describe_launch_templates(
DryRun=True|False,
LaunchTemplateIds=[
'string',
],
LaunchTemplateNames=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
One or more launch template IDs.
One or more launch template names.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LaunchTemplates': [
{
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersionNumber': 123,
'LatestVersionNumber': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LaunchTemplates (list) --
Information about the launch templates.
(dict) --
Describes a launch template.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
CreateTime (datetime) --
The time launch template was created.
CreatedBy (string) --
The principal that created the launch template.
DefaultVersionNumber (integer) --
The version number of the default version of the launch template.
LatestVersionNumber (integer) --
The version number of the latest version of the launch template.
Tags (list) --
The tags for the launch template.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Examples
This example describes the specified launch template.
response = client.describe_launch_templates(
LaunchTemplateIds=[
'lt-01238c059e3466abc',
],
)
print(response)
Expected Output:
{
'LaunchTemplates': [
{
'CreateTime': datetime(2018, 1, 16, 4, 32, 57, 1, 16, 0),
'CreatedBy': 'arn:aws:iam::123456789012:root',
'DefaultVersionNumber': 1,
'LatestVersionNumber': 1,
'LaunchTemplateId': 'lt-01238c059e3466abc',
'LaunchTemplateName': 'my-template',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the associations between virtual interface groups and local gateway route tables.
See also: AWS API Documentation
Request Syntax
response = client.describe_local_gateway_route_table_virtual_interface_group_associations(
LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the associations.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LocalGatewayRouteTableVirtualInterfaceGroupAssociations': [
{
'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayRouteTableVirtualInterfaceGroupAssociations (list) --
Information about the associations.
(dict) --
Describes an association between a local gateway route table and a virtual interface group.
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId (string) --
The ID of the association.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
LocalGatewayId (string) --
The ID of the local gateway.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
OwnerId (string) --
The AWS account ID that owns the local gateway virtual interface group association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 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.
Describes the specified associations between VPCs and local gateway route tables.
See also: AWS API Documentation
Request Syntax
response = client.describe_local_gateway_route_table_vpc_associations(
LocalGatewayRouteTableVpcAssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the associations.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LocalGatewayRouteTableVpcAssociations': [
{
'LocalGatewayRouteTableVpcAssociationId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayRouteTableVpcAssociations (list) --
Information about the associations.
(dict) --
Describes an association between a local gateway route table and a VPC.
LocalGatewayRouteTableVpcAssociationId (string) --
The ID of the association.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the association.
LocalGatewayId (string) --
The ID of the local gateway.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The AWS account ID that owns the local gateway route table for the association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 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.
Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
See also: AWS API Documentation
Request Syntax
response = client.describe_local_gateway_route_tables(
LocalGatewayRouteTableIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the local gateway route tables.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LocalGatewayRouteTables': [
{
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayRouteTables (list) --
Information about the local gateway route tables.
(dict) --
Describes a local gateway route table.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
LocalGatewayId (string) --
The ID of the local gateway.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The AWS account ID that owns the local gateway route table.
State (string) --
The state of the local gateway route table.
Tags (list) --
The tags assigned to the local gateway route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the specified local gateway virtual interface groups.
See also: AWS API Documentation
Request Syntax
response = client.describe_local_gateway_virtual_interface_groups(
LocalGatewayVirtualInterfaceGroupIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the virtual interface groups.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LocalGatewayVirtualInterfaceGroups': [
{
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayVirtualInterfaceIds': [
'string',
],
'LocalGatewayId': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayVirtualInterfaceGroups (list) --
The virtual interface groups.
(dict) --
Describes a local gateway virtual interface group.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
LocalGatewayVirtualInterfaceIds (list) --
The IDs of the virtual interfaces.
LocalGatewayId (string) --
The ID of the local gateway.
OwnerId (string) --
The AWS account ID that owns the local gateway virtual interface group.
Tags (list) --
The tags assigned to the virtual interface group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the specified local gateway virtual interfaces.
See also: AWS API Documentation
Request Syntax
response = client.describe_local_gateway_virtual_interfaces(
LocalGatewayVirtualInterfaceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the virtual interfaces.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LocalGatewayVirtualInterfaces': [
{
'LocalGatewayVirtualInterfaceId': 'string',
'LocalGatewayId': 'string',
'Vlan': 123,
'LocalAddress': 'string',
'PeerAddress': 'string',
'LocalBgpAsn': 123,
'PeerBgpAsn': 123,
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGatewayVirtualInterfaces (list) --
Information about the virtual interfaces.
(dict) --
Describes a local gateway virtual interface.
LocalGatewayVirtualInterfaceId (string) --
The ID of the virtual interface.
LocalGatewayId (string) --
The ID of the local gateway.
Vlan (integer) --
The ID of the VLAN.
LocalAddress (string) --
The local address.
PeerAddress (string) --
The peer address.
LocalBgpAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
PeerBgpAsn (integer) --
The peer BGP ASN.
OwnerId (string) --
The AWS account ID that owns the local gateway virtual interface.
Tags (list) --
The tags assigned to the virtual interface.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
See also: AWS API Documentation
Request Syntax
response = client.describe_local_gateways(
LocalGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
One or more filters.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LocalGateways': [
{
'LocalGatewayId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LocalGateways (list) --
Information about the local gateways.
(dict) --
Describes a local gateway.
LocalGatewayId (string) --
The ID of the local gateway.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The AWS account ID that owns the local gateway.
State (string) --
The state of the local gateway.
Tags (list) --
The tags assigned to the local gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries .
See also: AWS API Documentation
Request Syntax
response = client.describe_managed_prefix_lists(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
PrefixListIds=[
'string',
]
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more prefix list IDs.
dict
Response Syntax
{
'NextToken': 'string',
'PrefixLists': [
{
'PrefixListId': 'string',
'AddressFamily': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'PrefixListArn': 'string',
'PrefixListName': 'string',
'MaxEntries': 123,
'Version': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string'
},
]
}
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.
PrefixLists (list) --
Information about the prefix lists.
(dict) --
Describes a managed prefix list.
PrefixListId (string) --
The ID of the prefix list.
AddressFamily (string) --
The IP address version.
State (string) --
The state of the prefix list.
StateMessage (string) --
The state message.
PrefixListArn (string) --
The Amazon Resource Name (ARN) for the prefix list.
PrefixListName (string) --
The name of the prefix list.
MaxEntries (integer) --
The maximum number of entries for the prefix list.
Version (integer) --
The version of the prefix list.
Tags (list) --
The tags for the prefix list.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the owner of the prefix list.
Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_moving_addresses(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
MaxResults=123,
NextToken='string',
PublicIps=[
'string',
]
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
One or more Elastic IP addresses.
dict
Response Syntax
{
'MovingAddressStatuses': [
{
'MoveStatus': 'movingToVpc'|'restoringToClassic',
'PublicIp': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MovingAddressStatuses (list) --
The status for each Elastic IP address.
(dict) --
Describes the status of a moving Elastic IP address.
MoveStatus (string) --
The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.
PublicIp (string) --
The Elastic IP address.
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.
Examples
This example describes all of your moving Elastic IP addresses.
response = client.describe_moving_addresses(
)
print(response)
Expected Output:
{
'MovingAddressStatuses': [
{
'MoveStatus': 'MovingToVpc',
'PublicIp': '198.51.100.0',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more of your NAT gateways.
See also: AWS API Documentation
Request Syntax
response = client.describe_nat_gateways(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NatGatewayIds=[
'string',
],
NextToken='string'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more NAT gateway IDs.
dict
Response Syntax
{
'NatGateways': [
{
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'FailureCode': 'string',
'FailureMessage': 'string',
'NatGatewayAddresses': [
{
'AllocationId': 'string',
'NetworkInterfaceId': 'string',
'PrivateIp': 'string',
'PublicIp': 'string'
},
],
'NatGatewayId': 'string',
'ProvisionedBandwidth': {
'ProvisionTime': datetime(2015, 1, 1),
'Provisioned': 'string',
'RequestTime': datetime(2015, 1, 1),
'Requested': 'string',
'Status': 'string'
},
'State': 'pending'|'failed'|'available'|'deleting'|'deleted',
'SubnetId': 'string',
'VpcId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConnectivityType': 'private'|'public'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NatGateways (list) --
Information about the NAT gateways.
(dict) --
Describes a NAT gateway.
CreateTime (datetime) --
The date and time the NAT gateway was created.
DeleteTime (datetime) --
The date and time the NAT gateway was deleted, if applicable.
FailureCode (string) --
If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound )
FailureMessage (string) --
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
NatGatewayAddresses (list) --
Information about the IP addresses and network interface associated with the NAT gateway.
(dict) --
Describes the IP addresses and network interface associated with a NAT gateway.
AllocationId (string) --
[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
NetworkInterfaceId (string) --
The ID of the network interface associated with the NAT gateway.
PrivateIp (string) --
The private IP address associated with the NAT gateway.
PublicIp (string) --
[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
NatGatewayId (string) --
The ID of the NAT gateway.
ProvisionedBandwidth (dict) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
ProvisionTime (datetime) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Provisioned (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
RequestTime (datetime) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Requested (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Status (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
State (string) --
The state of the NAT gateway.
SubnetId (string) --
The ID of the subnet in which the NAT gateway is located.
VpcId (string) --
The ID of the VPC in which the NAT gateway is located.
Tags (list) --
The tags for the NAT gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ConnectivityType (string) --
Indicates whether the NAT gateway supports public or private connectivity.
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.
Examples
This example describes the NAT gateway for the specified VPC.
response = client.describe_nat_gateways(
Filter=[
{
'Name': 'vpc-id',
'Values': [
'vpc-1a2b3c4d',
],
},
],
)
print(response)
Expected Output:
{
'NatGateways': [
{
'CreateTime': datetime(2015, 12, 1, 12, 26, 55, 1, 335, 0),
'NatGatewayAddresses': [
{
'AllocationId': 'eipalloc-89c620ec',
'NetworkInterfaceId': 'eni-9dec76cd',
'PrivateIp': '10.0.0.149',
'PublicIp': '198.11.222.333',
},
],
'NatGatewayId': 'nat-05dba92075d71c408',
'State': 'available',
'SubnetId': 'subnet-847e4dc2',
'VpcId': 'vpc-1a2b3c4d',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_network_acls(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NetworkAclIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more network ACL IDs.
Default: Describes all your network ACLs.
dict
Response Syntax
{
'NetworkAcls': [
{
'Associations': [
{
'NetworkAclAssociationId': 'string',
'NetworkAclId': 'string',
'SubnetId': 'string'
},
],
'Entries': [
{
'CidrBlock': 'string',
'Egress': True|False,
'IcmpTypeCode': {
'Code': 123,
'Type': 123
},
'Ipv6CidrBlock': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'allow'|'deny',
'RuleNumber': 123
},
],
'IsDefault': True|False,
'NetworkAclId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string',
'OwnerId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkAcls (list) --
Information about one or more network ACLs.
(dict) --
Describes a network ACL.
Associations (list) --
Any associations between the network ACL and one or more subnets
(dict) --
Describes an association between a network ACL and a subnet.
NetworkAclAssociationId (string) --
The ID of the association between a network ACL and a subnet.
NetworkAclId (string) --
The ID of the network ACL.
SubnetId (string) --
The ID of the subnet.
Entries (list) --
One or more entries (rules) in the network ACL.
(dict) --
Describes an entry in a network ACL.
CidrBlock (string) --
The IPv4 network range to allow or deny, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
IcmpTypeCode (dict) --
ICMP protocol: The ICMP type and code.
Code (integer) --
The ICMP code. A value of -1 means all codes for the specified ICMP type.
Type (integer) --
The ICMP type. A value of -1 means all types.
Ipv6CidrBlock (string) --
The IPv6 network range to allow or deny, in CIDR notation.
PortRange (dict) --
TCP or UDP protocols: The range of ports the rule applies to.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol number. A value of "-1" means all protocols.
RuleAction (string) --
Indicates whether to allow or deny the traffic that matches the rule.
RuleNumber (integer) --
The rule number for the entry. ACL entries are processed in ascending order by rule number.
IsDefault (boolean) --
Indicates whether this is the default network ACL for the VPC.
NetworkAclId (string) --
The ID of the network ACL.
Tags (list) --
Any tags assigned to the network ACL.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC for the network ACL.
OwnerId (string) --
The ID of the AWS account that owns the network ACL.
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.
Examples
This example describes the specified network ACL.
response = client.describe_network_acls(
NetworkAclIds=[
'acl-5fb85d36',
],
)
print(response)
Expected Output:
{
'NetworkAcls': [
{
'Associations': [
{
'NetworkAclAssociationId': 'aclassoc-66ea5f0b',
'NetworkAclId': 'acl-9aeb5ef7',
'SubnetId': 'subnet-65ea5f08',
},
],
'Entries': [
{
'CidrBlock': '0.0.0.0/0',
'Egress': True,
'Protocol': '-1',
'RuleAction': 'deny',
'RuleNumber': 32767,
},
{
'CidrBlock': '0.0.0.0/0',
'Egress': False,
'Protocol': '-1',
'RuleAction': 'deny',
'RuleNumber': 32767,
},
],
'IsDefault': False,
'NetworkAclId': 'acl-5fb85d36',
'Tags': [
],
'VpcId': 'vpc-a01106c2',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more of your network insights analyses.
See also: AWS API Documentation
Request Syntax
response = 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'
)
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
The filters. The following are possible values:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'NetworkInsightsAnalyses': [
{
'NetworkInsightsAnalysisId': 'string',
'NetworkInsightsAnalysisArn': 'string',
'NetworkInsightsPathId': 'string',
'FilterInArns': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'Status': 'running'|'succeeded'|'failed',
'StatusMessage': 'string',
'NetworkPathFound': True|False,
'ForwardPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Component': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': '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'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
}
},
],
'ReturnPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Component': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': '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'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
}
},
],
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': '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'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string'
}
},
],
'AlternatePathHints': [
{
'ComponentId': 'string',
'ComponentArn': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkInsightsAnalyses (list) --
Information about the network insights analyses.
(dict) --
Describes a network insights analysis.
NetworkInsightsAnalysisId (string) --
The ID of the network insights analysis.
NetworkInsightsAnalysisArn (string) --
The Amazon Resource Name (ARN) of the network insights analysis.
NetworkInsightsPathId (string) --
The ID of the path.
FilterInArns (list) --
The Amazon Resource Names (ARN) of the AWS resources that the path must traverse.
StartDate (datetime) --
The time the analysis started.
Status (string) --
The status of the network insights analysis.
StatusMessage (string) --
The status message, if the status is failed .
NetworkPathFound (boolean) --
Indicates whether the destination is reachable from the source.
ForwardPathComponents (list) --
The components in the path from source to destination.
(dict) --
Describes a path component.
SequenceNumber (integer) --
The sequence number.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
OutboundHeader (dict) --
The outbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
InboundHeader (dict) --
The inbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
ReturnPathComponents (list) --
The components in the path from destination to source.
(dict) --
Describes a path component.
SequenceNumber (integer) --
The sequence number.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
OutboundHeader (dict) --
The outbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
InboundHeader (dict) --
The inbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Explanations (list) --
The explanations. For more information, see Reachability Analyzer explanation codes .
(dict) --
Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes .
Acl (dict) --
The network ACL.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Address (string) --
The IPv4 address, in CIDR notation.
Addresses (list) --
The IPv4 addresses, in CIDR notation.
AttachedTo (dict) --
The resource to which the component is attached.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AvailabilityZones (list) --
The Availability Zones.
Cidrs (list) --
The CIDR ranges.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
CustomerGateway (dict) --
The customer gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Destination (dict) --
The destination.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Direction (string) --
The direction. The following are possible values:
ExplanationCode (string) --
The explanation code.
IngressRouteTable (dict) --
The route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
InternetGateway (dict) --
The internet gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
ClassicLoadBalancerListener (dict) --
The listener for a Classic Load Balancer.
LoadBalancerPort (integer) --
The port on which the load balancer is listening.
InstancePort (integer) --
[Classic Load Balancers] The back-end port for the listener.
LoadBalancerListenerPort (integer) --
The listener port of the load balancer.
LoadBalancerTarget (dict) --
The target.
Address (string) --
The IP address.
AvailabilityZone (string) --
The Availability Zone.
Instance (dict) --
Information about the instance.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Port (integer) --
The port on which the target is listening.
LoadBalancerTargetGroup (dict) --
The target group.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerTargetGroups (list) --
The target groups.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerTargetPort (integer) --
The target port.
ElasticLoadBalancerListener (dict) --
The load balancer listener.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
MissingComponent (string) --
The missing component.
NatGateway (dict) --
The NAT gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
NetworkInterface (dict) --
The network interface.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
PacketField (string) --
The packet field.
VpcPeeringConnection (dict) --
The VPC peering connection.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Port (integer) --
The port.
PortRanges (list) --
The port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixList (dict) --
The prefix list.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Protocols (list) --
The protocols.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
RouteTable (dict) --
The route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SecurityGroup (dict) --
The security group.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SecurityGroups (list) --
The security groups.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
State (string) --
The state.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SubnetRouteTable (dict) --
The route table for the subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpcEndpoint (dict) --
The VPC endpoint.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpnConnection (dict) --
The VPN connection.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpnGateway (dict) --
The VPN gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AlternatePathHints (list) --
Potential intermediate components.
(dict) --
Describes an potential intermediate component of a feasible path.
ComponentId (string) --
The ID of the component.
ComponentArn (string) --
The Amazon Resource Name (ARN) of the component.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more of your paths.
See also: AWS API Documentation
Request Syntax
response = client.describe_network_insights_paths(
NetworkInsightsPathIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
DryRun=True|False,
NextToken='string'
)
The IDs of the paths.
The filters. The following are possible values:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'NetworkInsightsPaths': [
{
'NetworkInsightsPathId': 'string',
'NetworkInsightsPathArn': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Source': 'string',
'Destination': '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 AWS resource that is the source of the path.
Destination (string) --
The AWS resource that is the destination of the path.
SourceIp (string) --
The IP address of the AWS resource that is the source of the path.
DestinationIp (string) --
The IP address of the AWS 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 255 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.
Describes a network interface attribute. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = client.describe_network_interface_attribute(
Attribute='description'|'groupSet'|'sourceDestCheck'|'attachment',
DryRun=True|False,
NetworkInterfaceId='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'
},
'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 account ID of the owner of the instance.
Status (string) --
The attachment state.
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 .
Examples
This example describes the attachment attribute of the specified network interface.
response = client.describe_network_interface_attribute(
Attribute='attachment',
NetworkInterfaceId='eni-686ea200',
)
print(response)
Expected Output:
{
'Attachment': {
'AttachTime': datetime(2015, 5, 21, 20, 2, 20, 3, 141, 0),
'AttachmentId': 'eni-attach-43348162',
'DeleteOnTermination': True,
'DeviceIndex': 0,
'InstanceId': 'i-1234567890abcdef0',
'InstanceOwnerId': '123456789012',
'Status': 'attached',
},
'NetworkInterfaceId': 'eni-686ea200',
'ResponseMetadata': {
'...': '...',
},
}
This example describes the description attribute of the specified network interface.
response = client.describe_network_interface_attribute(
Attribute='description',
NetworkInterfaceId='eni-686ea200',
)
print(response)
Expected Output:
{
'Description': {
'Value': 'My description',
},
'NetworkInterfaceId': 'eni-686ea200',
'ResponseMetadata': {
'...': '...',
},
}
This example describes the groupSet attribute of the specified network interface.
response = client.describe_network_interface_attribute(
Attribute='groupSet',
NetworkInterfaceId='eni-686ea200',
)
print(response)
Expected Output:
{
'Groups': [
{
'GroupId': 'sg-903004f8',
'GroupName': 'my-security-group',
},
],
'NetworkInterfaceId': 'eni-686ea200',
'ResponseMetadata': {
'...': '...',
},
}
This example describes the sourceDestCheck attribute of the specified network interface.
response = client.describe_network_interface_attribute(
Attribute='sourceDestCheck',
NetworkInterfaceId='eni-686ea200',
)
print(response)
Expected Output:
{
'NetworkInterfaceId': 'eni-686ea200',
'SourceDestCheck': {
'Value': True,
},
'ResponseMetadata': {
'...': '...',
},
}
Describes the permissions for your network interfaces.
See also: AWS API Documentation
Request Syntax
response = client.describe_network_interface_permissions(
NetworkInterfacePermissionIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
One or more network interface permission IDs.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'NetworkInterfacePermissions': [
{
'NetworkInterfacePermissionId': 'string',
'NetworkInterfaceId': 'string',
'AwsAccountId': 'string',
'AwsService': 'string',
'Permission': 'INSTANCE-ATTACH'|'EIP-ASSOCIATE',
'PermissionState': {
'State': 'pending'|'granted'|'revoking'|'revoked',
'StatusMessage': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output for DescribeNetworkInterfacePermissions.
NetworkInterfacePermissions (list) --
The network interface permissions.
(dict) --
Describes a permission for a network interface.
NetworkInterfacePermissionId (string) --
The ID of the network interface permission.
NetworkInterfaceId (string) --
The ID of the network interface.
AwsAccountId (string) --
The account ID.
AwsService (string) --
The Amazon Web Service.
Permission (string) --
The type of permission.
PermissionState (dict) --
Information about the state of the permission.
State (string) --
The state of the permission.
StatusMessage (string) --
A status message, if applicable.
NextToken (string) --
The token to use to retrieve the next page of results.
Describes one or more of your network interfaces.
See also: AWS API Documentation
Request Syntax
response = client.describe_network_interfaces(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NetworkInterfaceIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more network interface IDs.
Default: Describes all your network interfaces.
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'
},
'AvailabilityZone': 'string',
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa'|'trunk',
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Association': {
'AllocationId': 'string',
'AssociationId': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string',
'CustomerOwnedIp': 'string',
'CarrierIp': 'string'
},
'Primary': True|False,
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string'
},
],
'RequesterId': 'string',
'RequesterManaged': True|False,
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'TagSet': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeNetworkInterfaces.
NetworkInterfaces (list) --
Information about one or more network interfaces.
(dict) --
Describes a network interface.
Association (dict) --
The association information for an Elastic IP address (IPv4) associated with the network interface.
AllocationId (string) --
The allocation ID.
AssociationId (string) --
The association ID.
IpOwnerId (string) --
The ID of the Elastic IP address owner.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The address of the Elastic IP address 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 account ID of the owner of the instance.
Status (string) --
The attachment state.
AvailabilityZone (string) --
The Availability Zone.
Description (string) --
A description.
Groups (list) --
Any security groups for the network interface.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
InterfaceType (string) --
The type of network interface.
Ipv6Addresses (list) --
The IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address associated with a network interface.
Ipv6Address (string) --
The IPv6 address.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The 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.
RequesterId (string) --
The alias or 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 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Examples
response = client.describe_network_interfaces(
NetworkInterfaceIds=[
'eni-e5aa89a3',
],
)
print(response)
Expected Output:
{
'NetworkInterfaces': [
{
'Association': {
'AssociationId': 'eipassoc-0fbb766a',
'IpOwnerId': '123456789012',
'PublicDnsName': 'ec2-203-0-113-12.compute-1.amazonaws.com',
'PublicIp': '203.0.113.12',
},
'Attachment': {
'AttachTime': datetime(2013, 11, 30, 23, 36, 42, 5, 334, 0),
'AttachmentId': 'eni-attach-66c4350a',
'DeleteOnTermination': False,
'DeviceIndex': 1,
'InstanceId': 'i-1234567890abcdef0',
'InstanceOwnerId': '123456789012',
'Status': 'attached',
},
'AvailabilityZone': 'us-east-1d',
'Description': 'my network interface',
'Groups': [
{
'GroupId': 'sg-8637d3e3',
'GroupName': 'default',
},
],
'MacAddress': '02:2f:8f:b0:cf:75',
'NetworkInterfaceId': 'eni-e5aa89a3',
'OwnerId': '123456789012',
'PrivateDnsName': 'ip-10-0-1-17.ec2.internal',
'PrivateIpAddress': '10.0.1.17',
'PrivateIpAddresses': [
{
'Association': {
'AssociationId': 'eipassoc-0fbb766a',
'IpOwnerId': '123456789012',
'PublicDnsName': 'ec2-203-0-113-12.compute-1.amazonaws.com',
'PublicIp': '203.0.113.12',
},
'Primary': True,
'PrivateDnsName': 'ip-10-0-1-17.ec2.internal',
'PrivateIpAddress': '10.0.1.17',
},
],
'RequesterManaged': False,
'SourceDestCheck': True,
'Status': 'in-use',
'SubnetId': 'subnet-b61f49f0',
'TagSet': [
],
'VpcId': 'vpc-a01106c2',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_placement_groups(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
GroupNames=[
'string',
],
GroupIds=[
'string',
]
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
The IDs of the placement groups.
dict
Response Syntax
{
'PlacementGroups': [
{
'GroupName': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Strategy': 'cluster'|'spread'|'partition',
'PartitionCount': 123,
'GroupId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
PlacementGroups (list) --
Information about the placement groups.
(dict) --
Describes a placement group.
GroupName (string) --
The name of the placement group.
State (string) --
The state of the placement group.
Strategy (string) --
The placement strategy.
PartitionCount (integer) --
The number of partitions. Valid only if strategy is set to partition .
GroupId (string) --
The ID of the placement group.
Tags (list) --
Any tags applied to the placement group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
See also: AWS API Documentation
Request Syntax
response = client.describe_prefix_lists(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
PrefixListIds=[
'string',
]
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more prefix list IDs.
dict
Response Syntax
{
'NextToken': 'string',
'PrefixLists': [
{
'Cidrs': [
'string',
],
'PrefixListId': 'string',
'PrefixListName': 'string'
},
]
}
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.
PrefixLists (list) --
All available prefix lists.
(dict) --
Describes prefixes for Amazon Web Services services.
Cidrs (list) --
The IP address range of the Amazon Web Service.
PrefixListId (string) --
The ID of the prefix.
PrefixListName (string) --
The name of the prefix.
Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .
See also: AWS API Documentation
Request Syntax
response = client.describe_principal_id_format(
DryRun=True|False,
Resources=[
'string',
],
MaxResults=123,
NextToken='string'
)
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway
dict
Response Syntax
{
'Principals': [
{
'Arn': 'string',
'Statuses': [
{
'Deadline': datetime(2015, 1, 1),
'Resource': 'string',
'UseLongIds': True|False
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Principals (list) --
Information about the ID format settings for the ARN.
(dict) --
PrincipalIdFormat description
Arn (string) --
PrincipalIdFormatARN description
Statuses (list) --
PrincipalIdFormatStatuses description
(dict) --
Describes the ID format for a resource.
Deadline (datetime) --
The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
Resource (string) --
The type of resource.
UseLongIds (boolean) --
Indicates whether longer IDs (17-character IDs) are enabled for the resource.
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.
Describes the specified IPv4 address pools.
See also: AWS API Documentation
Request Syntax
response = client.describe_public_ipv4_pools(
PoolIds=[
'string',
],
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
The IDs of the address pools.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'PublicIpv4Pools': [
{
'PoolId': 'string',
'Description': 'string',
'PoolAddressRanges': [
{
'FirstAddress': 'string',
'LastAddress': 'string',
'AddressCount': 123,
'AvailableAddressCount': 123
},
],
'TotalAddressCount': 123,
'TotalAvailableAddressCount': 123,
'NetworkBorderGroup': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PublicIpv4Pools (list) --
Information about the address pools.
(dict) --
Describes an IPv4 address pool.
PoolId (string) --
The ID of the address pool.
Description (string) --
A description of the address pool.
PoolAddressRanges (list) --
The address ranges.
(dict) --
Describes an address range of an IPv4 address pool.
FirstAddress (string) --
The first IP address in the range.
LastAddress (string) --
The last IP address in the range.
AddressCount (integer) --
The number of addresses in the range.
AvailableAddressCount (integer) --
The number of available addresses in the range.
TotalAddressCount (integer) --
The total number of addresses.
TotalAvailableAddressCount (integer) --
The total number of available addresses.
NetworkBorderGroup (string) --
The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.
Tags (list) --
Any tags for the address pool.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Regions and Endpoints .
For information about enabling and disabling Regions for your account, see Managing AWS Regions in the AWS General Reference .
See also: AWS API Documentation
Request Syntax
response = client.describe_regions(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
RegionNames=[
'string',
],
DryRun=True|False,
AllRegions=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
dict
Response Syntax
{
'Regions': [
{
'Endpoint': 'string',
'RegionName': 'string',
'OptInStatus': 'string'
},
]
}
Response Structure
(dict) --
Regions (list) --
Information about the Regions.
(dict) --
Describes a Region.
Endpoint (string) --
The Region service endpoint.
RegionName (string) --
The name of the Region.
OptInStatus (string) --
The Region opt-in status. The possible values are opt-in-not-required , opted-in , and not-opted-in .
Examples
This example describes all the regions that are available to you.
response = client.describe_regions(
)
print(response)
Expected Output:
{
'Regions': [
{
'Endpoint': 'ec2.ap-south-1.amazonaws.com',
'RegionName': 'ap-south-1',
},
{
'Endpoint': 'ec2.eu-west-1.amazonaws.com',
'RegionName': 'eu-west-1',
},
{
'Endpoint': 'ec2.ap-southeast-1.amazonaws.com',
'RegionName': 'ap-southeast-1',
},
{
'Endpoint': 'ec2.ap-southeast-2.amazonaws.com',
'RegionName': 'ap-southeast-2',
},
{
'Endpoint': 'ec2.eu-central-1.amazonaws.com',
'RegionName': 'eu-central-1',
},
{
'Endpoint': 'ec2.ap-northeast-2.amazonaws.com',
'RegionName': 'ap-northeast-2',
},
{
'Endpoint': 'ec2.ap-northeast-1.amazonaws.com',
'RegionName': 'ap-northeast-1',
},
{
'Endpoint': 'ec2.us-east-1.amazonaws.com',
'RegionName': 'us-east-1',
},
{
'Endpoint': 'ec2.sa-east-1.amazonaws.com',
'RegionName': 'sa-east-1',
},
{
'Endpoint': 'ec2.us-west-1.amazonaws.com',
'RegionName': 'us-west-1',
},
{
'Endpoint': 'ec2.us-west-2.amazonaws.com',
'RegionName': 'us-west-2',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_replace_root_volume_tasks(
ReplaceRootVolumeTaskIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The ID of the root volume replacement task to view.
Filter to use:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ReplaceRootVolumeTasks': [
{
'ReplaceRootVolumeTaskId': 'string',
'InstanceId': 'string',
'TaskState': 'pending'|'in-progress'|'failing'|'succeeded'|'failed'|'failed-detached',
'StartTime': 'string',
'CompleteTime': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReplaceRootVolumeTasks (list) --
Information about the root volume replacement task.
(dict) --
Information about a root volume replacement task.
ReplaceRootVolumeTaskId (string) --
The ID of the root volume replacement task.
InstanceId (string) --
The ID of the instance for which the root volume replacement task was created.
TaskState (string) --
The state of the task. The task can be in one of the following states:
StartTime (string) --
The time the task was started.
CompleteTime (string) --
The time the task completed.
Tags (list) --
The tags assigned to the task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
OfferingClass='standard'|'convertible',
ReservedInstancesIds=[
'string',
],
DryRun=True|False,
OfferingType='Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
dict
Response Syntax
{
'ReservedInstances': [
{
'AvailabilityZone': 'string',
'Duration': 123,
'End': datetime(2015, 1, 1),
'FixedPrice': ...,
'InstanceCount': 123,
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
'ReservedInstancesId': 'string',
'Start': datetime(2015, 1, 1),
'State': 'payment-pending'|'active'|'payment-failed'|'retired'|'queued'|'queued-deleted',
'UsagePrice': ...,
'CurrencyCode': 'USD',
'InstanceTenancy': 'default'|'dedicated'|'host',
'OfferingClass': 'standard'|'convertible',
'OfferingType': 'Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront',
'RecurringCharges': [
{
'Amount': 123.0,
'Frequency': 'Hourly'
},
],
'Scope': 'Availability Zone'|'Region',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output for DescribeReservedInstances.
ReservedInstances (list) --
A list of Reserved Instances.
(dict) --
Describes a Reserved Instance.
AvailabilityZone (string) --
The Availability Zone in which the Reserved Instance can be used.
Duration (integer) --
The duration of the Reserved Instance, in seconds.
End (datetime) --
The time when the Reserved Instance expires.
FixedPrice (float) --
The purchase price of the Reserved Instance.
InstanceCount (integer) --
The number of reservations purchased.
InstanceType (string) --
The instance type on which the Reserved Instance can be used.
ProductDescription (string) --
The Reserved Instance product platform description.
ReservedInstancesId (string) --
The ID of the Reserved Instance.
Start (datetime) --
The date and time the Reserved Instance started.
State (string) --
The state of the Reserved Instance purchase.
UsagePrice (float) --
The usage price of the Reserved Instance, per hour.
CurrencyCode (string) --
The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD .
InstanceTenancy (string) --
The tenancy of the instance.
OfferingClass (string) --
The offering class of the Reserved Instance.
OfferingType (string) --
The Reserved Instance offering type.
RecurringCharges (list) --
The recurring charge tag assigned to the resource.
(dict) --
Describes a recurring charge.
Amount (float) --
The amount of the recurring charge.
Frequency (string) --
The frequency of the recurring charge.
Scope (string) --
The scope of the Reserved Instance.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_instances_listings(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ReservedInstancesId='string',
ReservedInstancesListingId='string'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ReservedInstancesListings': [
{
'ClientToken': 'string',
'CreateDate': datetime(2015, 1, 1),
'InstanceCounts': [
{
'InstanceCount': 123,
'State': 'available'|'sold'|'cancelled'|'pending'
},
],
'PriceSchedules': [
{
'Active': True|False,
'CurrencyCode': 'USD',
'Price': 123.0,
'Term': 123
},
],
'ReservedInstancesId': 'string',
'ReservedInstancesListingId': 'string',
'Status': 'active'|'pending'|'cancelled'|'closed',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'UpdateDate': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Contains the output of DescribeReservedInstancesListings.
ReservedInstancesListings (list) --
Information about the Reserved Instance listing.
(dict) --
Describes a Reserved Instance listing.
ClientToken (string) --
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency .
CreateDate (datetime) --
The time the listing was created.
InstanceCounts (list) --
The number of instances in this state.
(dict) --
Describes a Reserved Instance listing state.
InstanceCount (integer) --
The number of listed Reserved Instances in the state specified by the state .
State (string) --
The states of the listed Reserved Instances.
PriceSchedules (list) --
The price of the Reserved Instance listing.
(dict) --
Describes the price for a Reserved Instance.
Active (boolean) --
The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
CurrencyCode (string) --
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD .
Price (float) --
The fixed price for the term.
Term (integer) --
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
ReservedInstancesId (string) --
The ID of the Reserved Instance.
ReservedInstancesListingId (string) --
The ID of the Reserved Instance listing.
Status (string) --
The status of the Reserved Instance listing.
StatusMessage (string) --
The reason for the current status of the Reserved Instance listing. The response can be blank.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
UpdateDate (datetime) --
The last modified timestamp of the listing.
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_instances_modifications(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ReservedInstancesModificationIds=[
'string',
],
NextToken='string'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
IDs for the submitted modification request.
dict
Response Syntax
{
'NextToken': 'string',
'ReservedInstancesModifications': [
{
'ClientToken': 'string',
'CreateDate': datetime(2015, 1, 1),
'EffectiveDate': datetime(2015, 1, 1),
'ModificationResults': [
{
'ReservedInstancesId': 'string',
'TargetConfiguration': {
'AvailabilityZone': 'string',
'InstanceCount': 123,
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'Platform': 'string',
'Scope': 'Availability Zone'|'Region'
}
},
],
'ReservedInstancesIds': [
{
'ReservedInstancesId': 'string'
},
],
'ReservedInstancesModificationId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'UpdateDate': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Contains the output of DescribeReservedInstancesModifications.
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.
ReservedInstancesModifications (list) --
The Reserved Instance modification information.
(dict) --
Describes a Reserved Instance modification.
ClientToken (string) --
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency .
CreateDate (datetime) --
The time when the modification request was created.
EffectiveDate (datetime) --
The time for the modification to become effective.
ModificationResults (list) --
Contains target configurations along with their corresponding new Reserved Instance IDs.
(dict) --
Describes the modification request/s.
ReservedInstancesId (string) --
The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
TargetConfiguration (dict) --
The target Reserved Instances configurations supplied as part of the modification request.
AvailabilityZone (string) --
The Availability Zone for the modified Reserved Instances.
InstanceCount (integer) --
The number of modified Reserved Instances.
Note
This is a required field for a request.
InstanceType (string) --
The instance type for the modified Reserved Instances.
Platform (string) --
The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
Scope (string) --
Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
ReservedInstancesIds (list) --
The IDs of one or more Reserved Instances.
(dict) --
Describes the ID of a Reserved Instance.
ReservedInstancesId (string) --
The ID of the Reserved Instance.
ReservedInstancesModificationId (string) --
A unique ID for the Reserved Instance modification.
Status (string) --
The status of the Reserved Instances modification request.
StatusMessage (string) --
The reason for the status.
UpdateDate (datetime) --
The time when the modification request was last updated.
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_instances_offerings(
AvailabilityZone='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeMarketplace=True|False,
InstanceType='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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
MaxDuration=123,
MaxInstanceCount=123,
MinDuration=123,
OfferingClass='standard'|'convertible',
ProductDescription='Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
ReservedInstancesOfferingIds=[
'string',
],
DryRun=True|False,
InstanceTenancy='default'|'dedicated'|'host',
MaxResults=123,
NextToken='string',
OfferingType='Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
The maximum number of instances to filter when searching for offerings.
Default: 20
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
One or more Reserved Instances offering IDs.
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
dict
Response Syntax
{
'ReservedInstancesOfferings': [
{
'AvailabilityZone': 'string',
'Duration': 123,
'FixedPrice': ...,
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
'ReservedInstancesOfferingId': 'string',
'UsagePrice': ...,
'CurrencyCode': 'USD',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Marketplace': True|False,
'OfferingClass': 'standard'|'convertible',
'OfferingType': 'Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront',
'PricingDetails': [
{
'Count': 123,
'Price': 123.0
},
],
'RecurringCharges': [
{
'Amount': 123.0,
'Frequency': 'Hourly'
},
],
'Scope': 'Availability Zone'|'Region'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeReservedInstancesOfferings.
ReservedInstancesOfferings (list) --
A list of Reserved Instances offerings.
(dict) --
Describes a Reserved Instance offering.
AvailabilityZone (string) --
The Availability Zone in which the Reserved Instance can be used.
Duration (integer) --
The duration of the Reserved Instance, in seconds.
FixedPrice (float) --
The purchase price of the Reserved Instance.
InstanceType (string) --
The instance type on which the Reserved Instance can be used.
ProductDescription (string) --
The Reserved Instance product platform description.
ReservedInstancesOfferingId (string) --
The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
UsagePrice (float) --
The usage price of the Reserved Instance, per hour.
CurrencyCode (string) --
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD .
InstanceTenancy (string) --
The tenancy of the instance.
Marketplace (boolean) --
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is true .
OfferingClass (string) --
If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard , it is not possible to perform an exchange.
OfferingType (string) --
The Reserved Instance offering type.
PricingDetails (list) --
The pricing details of the Reserved Instance offering.
(dict) --
Describes a Reserved Instance offering.
Count (integer) --
The number of reservations available for the price.
Price (float) --
The price per instance.
RecurringCharges (list) --
The recurring charge tag assigned to the resource.
(dict) --
Describes a recurring charge.
Amount (float) --
The amount of the recurring charge.
Frequency (string) --
The frequency of the recurring charge.
Scope (string) --
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
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.
Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_route_tables(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
RouteTableIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more route table IDs.
Default: Describes all your route tables.
dict
Response Syntax
{
'RouteTables': [
{
'Associations': [
{
'Main': True|False,
'RouteTableAssociationId': 'string',
'RouteTableId': 'string',
'SubnetId': 'string',
'GatewayId': 'string',
'AssociationState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failed',
'StatusMessage': 'string'
}
},
],
'PropagatingVgws': [
{
'GatewayId': 'string'
},
],
'RouteTableId': 'string',
'Routes': [
{
'DestinationCidrBlock': 'string',
'DestinationIpv6CidrBlock': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'NatGatewayId': 'string',
'TransitGatewayId': 'string',
'LocalGatewayId': 'string',
'CarrierGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'CreateRouteTable'|'CreateRoute'|'EnableVgwRoutePropagation',
'State': 'active'|'blackhole',
'VpcPeeringConnectionId': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string',
'OwnerId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeRouteTables.
RouteTables (list) --
Information about one or more route tables.
(dict) --
Describes a route table.
Associations (list) --
The associations between the route table and one or more subnets or a gateway.
(dict) --
Describes an association between a route table and a subnet or gateway.
Main (boolean) --
Indicates whether this is the main route table.
RouteTableAssociationId (string) --
The ID of the association.
RouteTableId (string) --
The ID of the route table.
SubnetId (string) --
The ID of the subnet. A subnet ID is not returned for an implicit association.
GatewayId (string) --
The ID of the internet gateway or virtual private gateway.
AssociationState (dict) --
The state of the association.
State (string) --
The state of the association.
StatusMessage (string) --
The status message, if applicable.
PropagatingVgws (list) --
Any virtual private gateway (VGW) propagating routes.
(dict) --
Describes a virtual private gateway propagating route.
GatewayId (string) --
The ID of the virtual private gateway.
RouteTableId (string) --
The ID of the route table.
Routes (list) --
The routes in the route table.
(dict) --
Describes a route in a route table.
DestinationCidrBlock (string) --
The IPv4 CIDR block used for the destination match.
DestinationIpv6CidrBlock (string) --
The IPv6 CIDR block used for the destination match.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of the egress-only internet gateway.
GatewayId (string) --
The ID of a gateway attached to your VPC.
InstanceId (string) --
The ID of a NAT instance in your VPC.
InstanceOwnerId (string) --
The AWS account ID of the owner of the instance.
NatGatewayId (string) --
The ID of a NAT gateway.
TransitGatewayId (string) --
The ID of a transit gateway.
LocalGatewayId (string) --
The ID of the local gateway.
CarrierGatewayId (string) --
The ID of the carrier gateway.
NetworkInterfaceId (string) --
The ID of the network interface.
Origin (string) --
Describes how the route was created.
State (string) --
The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
Tags (list) --
Any tags assigned to the route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The ID of the AWS account that owns the route table.
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.
Examples
This example describes the specified route table.
response = client.describe_route_tables(
RouteTableIds=[
'rtb-1f382e7d',
],
)
print(response)
Expected Output:
{
'RouteTables': [
{
'Associations': [
{
'Main': True,
'RouteTableAssociationId': 'rtbassoc-d8ccddba',
'RouteTableId': 'rtb-1f382e7d',
},
],
'PropagatingVgws': [
],
'RouteTableId': 'rtb-1f382e7d',
'Routes': [
{
'DestinationCidrBlock': '10.0.0.0/16',
'GatewayId': 'local',
'State': 'active',
},
],
'Tags': [
],
'VpcId': 'vpc-a01106c2',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
See also: AWS API Documentation
Request Syntax
response = client.describe_scheduled_instance_availability(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
FirstSlotStartTimeRange={
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
MaxResults=123,
MaxSlotDurationInHours=123,
MinSlotDurationInHours=123,
NextToken='string',
Recurrence={
'Frequency': 'string',
'Interval': 123,
'OccurrenceDays': [
123,
],
'OccurrenceRelativeToEnd': True|False,
'OccurrenceUnit': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
[REQUIRED]
The time period for the first schedule to start.
The earliest date and time, in UTC, for the Scheduled Instance to start.
The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
[REQUIRED]
The schedule recurrence.
The frequency (Daily , Weekly , or Monthly ).
The interval quantity. The interval unit depends on the value of Frequency . For example, every 2 weeks or every 2 months.
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
The unit for OccurrenceDays (DayOfWeek or DayOfMonth ). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
dict
Response Syntax
{
'NextToken': 'string',
'ScheduledInstanceAvailabilitySet': [
{
'AvailabilityZone': 'string',
'AvailableInstanceCount': 123,
'FirstSlotStartTime': datetime(2015, 1, 1),
'HourlyPrice': 'string',
'InstanceType': 'string',
'MaxTermDurationInDays': 123,
'MinTermDurationInDays': 123,
'NetworkPlatform': 'string',
'Platform': 'string',
'PurchaseToken': 'string',
'Recurrence': {
'Frequency': 'string',
'Interval': 123,
'OccurrenceDaySet': [
123,
],
'OccurrenceRelativeToEnd': True|False,
'OccurrenceUnit': 'string'
},
'SlotDurationInHours': 123,
'TotalScheduledInstanceHours': 123
},
]
}
Response Structure
(dict) --
Contains the output of DescribeScheduledInstanceAvailability.
NextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
ScheduledInstanceAvailabilitySet (list) --
Information about the available Scheduled Instances.
(dict) --
Describes a schedule that is available for your Scheduled Instances.
AvailabilityZone (string) --
The Availability Zone.
AvailableInstanceCount (integer) --
The number of available instances.
FirstSlotStartTime (datetime) --
The time period for the first schedule to start.
HourlyPrice (string) --
The hourly price for a single instance.
InstanceType (string) --
The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
MaxTermDurationInDays (integer) --
The maximum term. The only possible value is 365 days.
MinTermDurationInDays (integer) --
The minimum term. The only possible value is 365 days.
NetworkPlatform (string) --
The network platform (EC2-Classic or EC2-VPC ).
Platform (string) --
The platform (Linux/UNIX or Windows ).
PurchaseToken (string) --
The purchase token. This token expires in two hours.
Recurrence (dict) --
The schedule recurrence.
Frequency (string) --
The frequency (Daily , Weekly , or Monthly ).
Interval (integer) --
The interval quantity. The interval unit depends on the value of frequency . For example, every 2 weeks or every 2 months.
OccurrenceDaySet (list) --
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
OccurrenceRelativeToEnd (boolean) --
Indicates whether the occurrence is relative to the end of the specified week or month.
OccurrenceUnit (string) --
The unit for occurrenceDaySet (DayOfWeek or DayOfMonth ).
SlotDurationInHours (integer) --
The number of hours in the schedule.
TotalScheduledInstanceHours (integer) --
The total number of hours for a single instance for the entire term.
Examples
This example describes a schedule that occurs every week on Sunday, starting on the specified date. Note that the output contains a single schedule as an example.
response = client.describe_scheduled_instance_availability(
FirstSlotStartTimeRange={
'EarliestTime': datetime(2016, 1, 31, 0, 0, 0, 6, 31, 0),
'LatestTime': datetime(2016, 1, 31, 4, 0, 0, 6, 31, 0),
},
Recurrence={
'Frequency': 'Weekly',
'Interval': 1,
'OccurrenceDays': [
1,
],
},
)
print(response)
Expected Output:
{
'ScheduledInstanceAvailabilitySet': [
{
'AvailabilityZone': 'us-west-2b',
'AvailableInstanceCount': 20,
'FirstSlotStartTime': datetime(2016, 1, 31, 0, 0, 0, 6, 31, 0),
'HourlyPrice': '0.095',
'InstanceType': 'c4.large',
'MaxTermDurationInDays': 366,
'MinTermDurationInDays': 366,
'NetworkPlatform': 'EC2-VPC',
'Platform': 'Linux/UNIX',
'PurchaseToken': 'eyJ2IjoiMSIsInMiOjEsImMiOi...',
'Recurrence': {
'Frequency': 'Weekly',
'Interval': 1,
'OccurrenceDaySet': [
1,
],
'OccurrenceRelativeToEnd': False,
},
'SlotDurationInHours': 23,
'TotalScheduledInstanceHours': 1219,
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified Scheduled Instances or all your Scheduled Instances.
See also: AWS API Documentation
Request Syntax
response = client.describe_scheduled_instances(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
ScheduledInstanceIds=[
'string',
],
SlotStartTimeRange={
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The Scheduled Instance IDs.
The time period for the first schedule to start.
The earliest date and time, in UTC, for the Scheduled Instance to start.
The latest date and time, in UTC, for the Scheduled Instance to start.
dict
Response Syntax
{
'NextToken': 'string',
'ScheduledInstanceSet': [
{
'AvailabilityZone': 'string',
'CreateDate': datetime(2015, 1, 1),
'HourlyPrice': 'string',
'InstanceCount': 123,
'InstanceType': 'string',
'NetworkPlatform': 'string',
'NextSlotStartTime': datetime(2015, 1, 1),
'Platform': 'string',
'PreviousSlotEndTime': datetime(2015, 1, 1),
'Recurrence': {
'Frequency': 'string',
'Interval': 123,
'OccurrenceDaySet': [
123,
],
'OccurrenceRelativeToEnd': True|False,
'OccurrenceUnit': 'string'
},
'ScheduledInstanceId': 'string',
'SlotDurationInHours': 123,
'TermEndDate': datetime(2015, 1, 1),
'TermStartDate': datetime(2015, 1, 1),
'TotalScheduledInstanceHours': 123
},
]
}
Response Structure
(dict) --
Contains the output of DescribeScheduledInstances.
NextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
ScheduledInstanceSet (list) --
Information about the Scheduled Instances.
(dict) --
Describes a Scheduled Instance.
AvailabilityZone (string) --
The Availability Zone.
CreateDate (datetime) --
The date when the Scheduled Instance was purchased.
HourlyPrice (string) --
The hourly price for a single instance.
InstanceCount (integer) --
The number of instances.
InstanceType (string) --
The instance type.
NetworkPlatform (string) --
The network platform (EC2-Classic or EC2-VPC ).
NextSlotStartTime (datetime) --
The time for the next schedule to start.
Platform (string) --
The platform (Linux/UNIX or Windows ).
PreviousSlotEndTime (datetime) --
The time that the previous schedule ended or will end.
Recurrence (dict) --
The schedule recurrence.
Frequency (string) --
The frequency (Daily , Weekly , or Monthly ).
Interval (integer) --
The interval quantity. The interval unit depends on the value of frequency . For example, every 2 weeks or every 2 months.
OccurrenceDaySet (list) --
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
OccurrenceRelativeToEnd (boolean) --
Indicates whether the occurrence is relative to the end of the specified week or month.
OccurrenceUnit (string) --
The unit for occurrenceDaySet (DayOfWeek or DayOfMonth ).
ScheduledInstanceId (string) --
The Scheduled Instance ID.
SlotDurationInHours (integer) --
The number of hours in the schedule.
TermEndDate (datetime) --
The end date for the Scheduled Instance.
TermStartDate (datetime) --
The start date for the Scheduled Instance.
TotalScheduledInstanceHours (integer) --
The total number of hours for a single instance for the entire term.
Examples
This example describes the specified Scheduled Instance.
response = client.describe_scheduled_instances(
ScheduledInstanceIds=[
'sci-1234-1234-1234-1234-123456789012',
],
)
print(response)
Expected Output:
{
'ScheduledInstanceSet': [
{
'AvailabilityZone': 'us-west-2b',
'CreateDate': datetime(2016, 1, 25, 21, 43, 38, 0, 25, 0),
'HourlyPrice': '0.095',
'InstanceCount': 1,
'InstanceType': 'c4.large',
'NetworkPlatform': 'EC2-VPC',
'NextSlotStartTime': datetime(2016, 1, 31, 9, 0, 0, 6, 31, 0),
'Platform': 'Linux/UNIX',
'Recurrence': {
'Frequency': 'Weekly',
'Interval': 1,
'OccurrenceDaySet': [
1,
],
'OccurrenceRelativeToEnd': False,
'OccurrenceUnit': '',
},
'ScheduledInstanceId': 'sci-1234-1234-1234-1234-123456789012',
'SlotDurationInHours': 32,
'TermEndDate': datetime(2017, 1, 31, 9, 0, 0, 1, 31, 0),
'TermStartDate': datetime(2016, 1, 31, 9, 0, 0, 6, 31, 0),
'TotalScheduledInstanceHours': 1696,
},
],
'ResponseMetadata': {
'...': '...',
},
}
[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
See also: AWS API Documentation
Request Syntax
response = client.describe_security_group_references(
DryRun=True|False,
GroupId=[
'string',
]
)
[REQUIRED]
The IDs of the security groups in your account.
dict
Response Syntax
{
'SecurityGroupReferenceSet': [
{
'GroupId': 'string',
'ReferencingVpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
}
Response Structure
(dict) --
SecurityGroupReferenceSet (list) --
Information about the VPCs with the referencing security groups.
(dict) --
Describes a VPC with a security group that references your security group.
GroupId (string) --
The ID of your security group.
ReferencingVpcId (string) --
The ID of the VPC with the referencing security group.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Examples
This example describes the security group references for the specified security group.
response = client.describe_security_group_references(
GroupId=[
'sg-903004f8',
],
)
print(response)
Expected Output:
{
'SecurityGroupReferenceSet': [
{
'GroupId': 'sg-903004f8',
'ReferencingVpcId': 'vpc-1a2b3c4d',
'VpcPeeringConnectionId': 'pcx-b04deed9',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more of your security group rules.
See also: AWS API Documentation
Request Syntax
response = client.describe_security_group_rules(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
SecurityGroupRuleIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the security group rules.
dict
Response Syntax
{
'SecurityGroupRules': [
{
'SecurityGroupRuleId': 'string',
'GroupId': 'string',
'GroupOwnerId': 'string',
'IsEgress': True|False,
'IpProtocol': 'string',
'FromPort': 123,
'ToPort': 123,
'CidrIpv4': 'string',
'CidrIpv6': 'string',
'PrefixListId': 'string',
'ReferencedGroupInfo': {
'GroupId': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityGroupRules (list) --
Information about security group rules.
(dict) --
Describes a security group rule.
SecurityGroupRuleId (string) --
The ID of the security group rule.
GroupId (string) --
The ID of the security group.
GroupOwnerId (string) --
The ID of the account that owns the security group.
IsEgress (boolean) --
Indicates whether the security group rule is an outbound rule.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
Use -1 to specify all protocols.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
CidrIpv4 (string) --
The IPv4 CIDR range.
CidrIpv6 (string) --
The IPv6 CIDR range.
PrefixListId (string) --
The ID of the prefix list.
ReferencedGroupInfo (dict) --
Describes the security group that is referenced in the rule.
GroupId (string) --
The ID of the security group.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The account ID.
VpcId (string) --
The ID of the VPC.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Description (string) --
The security group rule description.
Tags (list) --
The tags applied to the security group rule.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_security_groups(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
GroupIds=[
'string',
],
GroupNames=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
dict
Response Syntax
{
'SecurityGroups': [
{
'Description': 'string',
'GroupName': 'string',
'IpPermissions': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
'OwnerId': 'string',
'GroupId': 'string',
'IpPermissionsEgress': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityGroups (list) --
Information about the security groups.
(dict) --
Describes a security group.
Description (string) --
A description of the security group.
GroupName (string) --
The name of the security group.
IpPermissions (list) --
The inbound rules associated with the security group.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the security group.
GroupId (string) --
The ID of the security group.
IpPermissionsEgress (list) --
[VPC only] The outbound rules associated with the security group.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
Tags (list) --
Any tags assigned to the security group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
[VPC only] The ID of the VPC for the security group.
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.
Examples
This example describes the specified security group.
response = client.describe_security_groups(
GroupIds=[
'sg-903004f8',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example describes the security groups that include the specified tag (Purpose=test).
response = client.describe_security_groups(
Filters=[
{
'Name': 'tag:Purpose',
'Values': [
'test',
],
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_snapshot_attribute(
Attribute='productCodes'|'createVolumePermission',
SnapshotId='string',
DryRun=True|False
)
[REQUIRED]
The snapshot attribute you would like to view.
[REQUIRED]
The ID of the EBS snapshot.
dict
Response Syntax
{
'CreateVolumePermissions': [
{
'Group': 'all',
'UserId': 'string'
},
],
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'SnapshotId': 'string'
}
Response Structure
(dict) --
CreateVolumePermissions (list) --
The users and groups that have the permissions for creating volumes from the snapshot.
(dict) --
Describes the user or group to be added or removed from the list of create volume permissions for a volume.
Group (string) --
The group to be added or removed. The possible value is all .
UserId (string) --
The AWS account ID to be added or removed.
ProductCodes (list) --
The product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
SnapshotId (string) --
The ID of the EBS snapshot.
Examples
This example describes the createVolumePermission attribute on a snapshot with the snapshot ID of snap-066877671789bd71b.
response = client.describe_snapshot_attribute(
Attribute='createVolumePermission',
SnapshotId='snap-066877671789bd71b',
)
print(response)
Expected Output:
{
'CreateVolumePermissions': [
],
'SnapshotId': 'snap-066877671789bd71b',
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other AWS accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores .
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_snapshots(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
OwnerIds=[
'string',
],
RestorableByUserIds=[
'string',
],
SnapshotIds=[
'string',
],
DryRun=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self , and amazon .
The IDs of the AWS accounts that can create volumes from the snapshot.
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
dict
Response Syntax
{
'Snapshots': [
{
'DataEncryptionKeyId': 'string',
'Description': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'OwnerId': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'StartTime': datetime(2015, 1, 1),
'State': 'pending'|'completed'|'error',
'StateMessage': 'string',
'VolumeId': 'string',
'VolumeSize': 123,
'OwnerAlias': 'string',
'OutpostArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Snapshots (list) --
Information about the snapshots.
(dict) --
Describes a snapshot.
DataEncryptionKeyId (string) --
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots .
Description (string) --
The description for the snapshot.
Encrypted (boolean) --
Indicates whether the snapshot is encrypted.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
OwnerId (string) --
The AWS account ID of the EBS snapshot owner.
Progress (string) --
The progress of the snapshot, as a percentage.
SnapshotId (string) --
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
StartTime (datetime) --
The time stamp when the snapshot was initiated.
State (string) --
The snapshot state.
StateMessage (string) --
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots .
VolumeId (string) --
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
VolumeSize (integer) --
The size of the volume, in GiB.
OwnerAlias (string) --
The AWS owner alias, from an Amazon-maintained list (amazon ). This is not the user-configured AWS account alias set using the IAM console.
OutpostArn (string) --
The ARN of the AWS Outpost on which the snapshot is stored. For more information, see EBS Local Snapshot on Outposts in the Amazon Elastic Compute Cloud User Guide .
Tags (list) --
Any tags assigned to the snapshot.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
NextToken (string) --
The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Examples
This example describes a snapshot with the snapshot ID of snap-1234567890abcdef0.
response = client.describe_snapshots(
SnapshotIds=[
'snap-1234567890abcdef0',
],
)
print(response)
Expected Output:
{
'NextToken': '',
'Snapshots': [
{
'Description': 'This is my snapshot.',
'OwnerId': '012345678910',
'Progress': '100%',
'SnapshotId': 'snap-1234567890abcdef0',
'StartTime': datetime(2014, 2, 28, 21, 28, 32, 4, 59, 0),
'State': 'completed',
'VolumeId': 'vol-049df61146c4d7901',
'VolumeSize': 8,
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example describes all snapshots owned by the ID 012345678910 that are in the pending status.
response = client.describe_snapshots(
Filters=[
{
'Name': 'status',
'Values': [
'pending',
],
},
],
OwnerIds=[
'012345678910',
],
)
print(response)
Expected Output:
{
'NextToken': '',
'Snapshots': [
{
'Description': 'This is my copied snapshot.',
'OwnerId': '012345678910',
'Progress': '87%',
'SnapshotId': 'snap-066877671789bd71b',
'StartTime': datetime(2014, 2, 28, 21, 37, 27, 4, 59, 0),
'State': 'pending',
'VolumeId': 'vol-1234567890abcdef0',
'VolumeSize': 8,
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances .
See also: AWS API Documentation
Request Syntax
response = client.describe_spot_datafeed_subscription(
DryRun=True|False
)
{
'SpotDatafeedSubscription': {
'Bucket': 'string',
'Fault': {
'Code': 'string',
'Message': 'string'
},
'OwnerId': 'string',
'Prefix': 'string',
'State': 'Active'|'Inactive'
}
}
Response Structure
Contains the output of DescribeSpotDatafeedSubscription.
The Spot Instance data feed subscription.
The name of the Amazon S3 bucket where the Spot Instance data feed is located.
The fault codes for the Spot Instance request, if any.
The reason code for the Spot Instance state change.
The message for the Spot Instance state change.
The account ID of the account.
The prefix for the data feed files.
The state of the Spot Instance data feed subscription.
Examples
This example describes the Spot Instance datafeed subscription for your AWS account.
response = client.describe_spot_datafeed_subscription(
)
print(response)
Expected Output:
{
'SpotDatafeedSubscription': {
'Bucket': 'my-s3-bucket',
'OwnerId': '123456789012',
'Prefix': 'spotdata',
'State': 'Active',
},
'ResponseMetadata': {
'...': '...',
},
}
Describes the running instances for the specified Spot Fleet.
See also: AWS API Documentation
Request Syntax
response = client.describe_spot_fleet_instances(
DryRun=True|False,
MaxResults=123,
NextToken='string',
SpotFleetRequestId='string'
)
[REQUIRED]
The ID of the Spot Fleet request.
dict
Response Syntax
{
'ActiveInstances': [
{
'InstanceId': 'string',
'InstanceType': 'string',
'SpotInstanceRequestId': 'string',
'InstanceHealth': 'healthy'|'unhealthy'
},
],
'NextToken': 'string',
'SpotFleetRequestId': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeSpotFleetInstances.
ActiveInstances (list) --
The running instances. This list is refreshed periodically and might be out of date.
(dict) --
Describes a running instance in a Spot Fleet.
InstanceId (string) --
The ID of the instance.
InstanceType (string) --
The instance type.
SpotInstanceRequestId (string) --
The ID of the Spot Instance request.
InstanceHealth (string) --
The health status of the instance. If the status of either the instance status check or the system status check is impaired , the health status of the instance is unhealthy . Otherwise, the health status is healthy .
NextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
SpotFleetRequestId (string) --
The ID of the Spot Fleet request.
Examples
This example lists the Spot Instances associated with the specified Spot fleet.
response = client.describe_spot_fleet_instances(
SpotFleetRequestId='sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
)
print(response)
Expected Output:
{
'ActiveInstances': [
{
'InstanceId': 'i-1234567890abcdef0',
'InstanceType': 'm3.medium',
'SpotInstanceRequestId': 'sir-08b93456',
},
],
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
'ResponseMetadata': {
'...': '...',
},
}
Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
See also: AWS API Documentation
Request Syntax
response = client.describe_spot_fleet_request_history(
DryRun=True|False,
EventType='instanceChange'|'fleetRequestChange'|'error'|'information',
MaxResults=123,
NextToken='string',
SpotFleetRequestId='string',
StartTime=datetime(2015, 1, 1)
)
[REQUIRED]
The ID of the Spot Fleet request.
[REQUIRED]
The starting date and time for the events, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
dict
Response Syntax
{
'HistoryRecords': [
{
'EventInformation': {
'EventDescription': 'string',
'EventSubType': 'string',
'InstanceId': 'string'
},
'EventType': 'instanceChange'|'fleetRequestChange'|'error'|'information',
'Timestamp': datetime(2015, 1, 1)
},
],
'LastEvaluatedTime': datetime(2015, 1, 1),
'NextToken': 'string',
'SpotFleetRequestId': 'string',
'StartTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Contains the output of DescribeSpotFleetRequestHistory.
HistoryRecords (list) --
Information about the events in the history of the Spot Fleet request.
(dict) --
Describes an event in the history of the Spot Fleet request.
EventInformation (dict) --
Information about the event.
EventDescription (string) --
The description of the event.
EventSubType (string) --
The event.
The following are the error events:
The following are the fleetRequestChange events:
The following are the instanceChange events:
The following are the Information events:
InstanceId (string) --
The ID of the instance. This information is available only for instanceChange events.
EventType (string) --
The event type.
Timestamp (datetime) --
The date and time of the event, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
LastEvaluatedTime (datetime) --
The last date and time for the events, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
NextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
SpotFleetRequestId (string) --
The ID of the Spot Fleet request.
StartTime (datetime) --
The starting date and time for the events, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Examples
This example returns the history for the specified Spot fleet starting at the specified time.
response = client.describe_spot_fleet_request_history(
SpotFleetRequestId='sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
StartTime=datetime(2015, 5, 26, 0, 0, 0, 1, 146, 0),
)
print(response)
Expected Output:
{
'HistoryRecords': [
{
'EventInformation': {
'EventSubType': 'submitted',
},
'EventType': 'fleetRequestChange',
'Timestamp': datetime(2015, 5, 26, 23, 17, 20, 1, 146, 0),
},
{
'EventInformation': {
'EventSubType': 'active',
},
'EventType': 'fleetRequestChange',
'Timestamp': datetime(2015, 5, 26, 23, 17, 20, 1, 146, 0),
},
{
'EventInformation': {
'EventSubType': 'launched',
'InstanceId': 'i-1234567890abcdef0',
},
'EventType': 'instanceChange',
'Timestamp': datetime(2015, 5, 26, 23, 21, 21, 1, 146, 0),
},
{
'EventInformation': {
'EventSubType': 'launched',
'InstanceId': 'i-1234567890abcdef1',
},
'EventType': 'instanceChange',
'Timestamp': datetime(2015, 5, 26, 23, 21, 21, 1, 146, 0),
},
],
'NextToken': 'CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=',
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
'StartTime': datetime(2015, 5, 26, 0, 0, 0, 1, 146, 0),
'ResponseMetadata': {
'...': '...',
},
}
Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
See also: AWS API Documentation
Request Syntax
response = client.describe_spot_fleet_requests(
DryRun=True|False,
MaxResults=123,
NextToken='string',
SpotFleetRequestIds=[
'string',
]
)
The IDs of the Spot Fleet requests.
dict
Response Syntax
{
'NextToken': 'string',
'SpotFleetRequestConfigs': [
{
'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled',
'CreateTime': datetime(2015, 1, 1),
'SpotFleetRequestConfig': {
'AllocationStrategy': 'lowestPrice'|'diversified'|'capacityOptimized'|'capacityOptimizedPrioritized',
'OnDemandAllocationStrategy': 'lowestPrice'|'prioritized',
'SpotMaintenanceStrategies': {
'CapacityRebalance': {
'ReplacementStrategy': 'launch'
}
},
'ClientToken': 'string',
'ExcessCapacityTerminationPolicy': 'noTermination'|'default',
'FulfilledCapacity': 123.0,
'OnDemandFulfilledCapacity': 123.0,
'IamFleetRole': 'string',
'LaunchSpecifications': [
{
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'AddressingType': 'string',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'RamdiskId': 'string',
'SpotPrice': 'string',
'SubnetId': 'string',
'UserData': 'string',
'WeightedCapacity': 123.0,
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
],
'LaunchTemplateConfigs': [
{
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'SpotPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0
},
]
},
],
'SpotPrice': 'string',
'TargetCapacity': 123,
'OnDemandTargetCapacity': 123,
'OnDemandMaxTotalPrice': 'string',
'SpotMaxTotalPrice': 'string',
'TerminateInstancesWithExpiration': True|False,
'Type': 'request'|'maintain'|'instant',
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'ReplaceUnhealthyInstances': True|False,
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
'LoadBalancersConfig': {
'ClassicLoadBalancersConfig': {
'ClassicLoadBalancers': [
{
'Name': 'string'
},
]
},
'TargetGroupsConfig': {
'TargetGroups': [
{
'Arn': 'string'
},
]
}
},
'InstancePoolsToUseCount': 123,
'Context': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'SpotFleetRequestId': 'string',
'SpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output of DescribeSpotFleetRequests.
NextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
SpotFleetRequestConfigs (list) --
Information about the configuration of your Spot Fleet.
(dict) --
Describes a Spot Fleet request.
ActivityStatus (string) --
The progress of the Spot Fleet request. If there is an error, the status is error . After all requests are placed, the status is pending_fulfillment . If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.
CreateTime (datetime) --
The creation date and time of the request.
SpotFleetRequestConfig (dict) --
The configuration of the Spot Fleet request.
AllocationStrategy (string) --
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.
If the allocation strategy is lowestPrice , Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified , Spot Fleet launches instances from all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.
OnDemandAllocationStrategy (string) --
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice .
SpotMaintenanceStrategies (dict) --
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
CapacityRebalance (dict) --
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
ReplacementStrategy (string) --
The replacement strategy to use. Only available for fleets of type maintain . You must specify a value, otherwise you get an error.
To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for a Spot Instance in the fleet, specify launch .
Note
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
ClientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency .
ExcessCapacityTerminationPolicy (string) --
Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
FulfilledCapacity (float) --
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
OnDemandFulfilledCapacity (float) --
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
IamFleetRole (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration .
LaunchSpecifications (list) --
The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications , you can't specify LaunchTemplateConfigs . If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs .
(dict) --
Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use SpotFleetLaunchSpecification ; you must use LaunchTemplateConfig .
SecurityGroups (list) --
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
AddressingType (string) --
Deprecated.
BlockDeviceMappings (list) --
One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
EbsOptimized (boolean) --
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
ImageId (string) --
The ID of the AMI.
InstanceType (string) --
The instance type.
KernelId (string) --
The ID of the kernel.
KeyName (string) --
The name of the key pair.
Monitoring (dict) --
Enable or disable monitoring for the instances.
Enabled (boolean) --
Enables monitoring for the instance.
Default: false
NetworkInterfaces (list) --
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
Note
SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig .
(dict) --
Describes a network interface.
AssociatePublicIpAddress (boolean) --
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
DeleteOnTermination (boolean) --
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
Description (string) --
The description of the network interface. Applies only if creating a network interface when launching an instance.
DeviceIndex (integer) --
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
Groups (list) --
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
Ipv6AddressCount (integer) --
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
Ipv6Addresses (list) --
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
PrivateIpAddress (string) --
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
PrivateIpAddresses (list) --
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
SubnetId (string) --
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
AssociateCarrierIpAddress (boolean) --
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
InterfaceType (string) --
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
NetworkCardIndex (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.
Placement (dict) --
The placement information.
AvailabilityZone (string) --
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
GroupName (string) --
The name of the placement group.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
RamdiskId (string) --
The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
SpotPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity .
SubnetId (string) --
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
UserData (string) --
The Base64-encoded user data that instances use when starting up.
WeightedCapacity (float) --
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
TagSpecifications (list) --
The tags to apply during creation.
(dict) --
The tags for a Spot Fleet resource.
ResourceType (string) --
The type of resource. Currently, the only resource type that is supported is instance . To tag the Spot Fleet request on creation, use the TagSpecifications parameter in ` SpotFleetRequestConfigData https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html`__ .
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
LaunchTemplateConfigs (list) --
The launch template and overrides. If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications . If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs .
(dict) --
Describes a launch template and overrides.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (list) --
Any parameters that you specify override the same parameters in the launch template.
(dict) --
Describes overrides for a launch template.
InstanceType (string) --
The instance type.
SpotPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized , Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized , Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
SpotPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
TargetCapacity (integer) --
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
OnDemandTargetCapacity (integer) --
The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
OnDemandMaxTotalPrice (string) --
The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
SpotMaxTotalPrice (string) --
The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
TerminateInstancesWithExpiration (boolean) --
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
Type (string) --
The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain . instant is listed but is not used by Spot Fleet.
ValidFrom (datetime) --
The start date and time of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). By default, Amazon EC2 starts fulfilling the request immediately.
ValidUntil (datetime) --
The end date and time of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
ReplaceUnhealthyInstances (boolean) --
Indicates whether Spot Fleet should replace unhealthy instances.
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted. The default is terminate .
LoadBalancersConfig (dict) --
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
ClassicLoadBalancersConfig (dict) --
The Classic Load Balancers.
ClassicLoadBalancers (list) --
One or more Classic Load Balancers.
(dict) --
Describes a Classic Load Balancer.
Name (string) --
The name of the load balancer.
TargetGroupsConfig (dict) --
The target groups.
TargetGroups (list) --
One or more target groups.
(dict) --
Describes a load balancer target group.
Arn (string) --
The Amazon Resource Name (ARN) of the target group.
InstancePoolsToUseCount (integer) --
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
Context (string) --
Reserved.
TagSpecifications (list) --
The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs ) or in the ` SpotFleetTagSpecification https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html`__ (valid only if you use LaunchSpecifications ). For information about tagging after launch, see Tagging Your Resources .
(dict) --
The tags to apply to a resource when the resource is being created.
ResourceType (string) --
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
SpotFleetRequestId (string) --
The ID of the Spot Fleet request.
SpotFleetRequestState (string) --
The state of the Spot Fleet request.
Tags (list) --
The tags for a Spot Fleet resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example describes the specified Spot fleet request.
response = client.describe_spot_fleet_requests(
SpotFleetRequestIds=[
'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
],
)
print(response)
Expected Output:
{
'SpotFleetRequestConfigs': [
{
'SpotFleetRequestConfig': {
'IamFleetRole': 'arn:aws:iam::123456789012:role/my-spot-fleet-role',
'LaunchSpecifications': [
{
'EbsOptimized': False,
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'cc2.8xlarge',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True,
'DeleteOnTermination': False,
'DeviceIndex': 0,
'SecondaryPrivateIpAddressCount': 0,
'SubnetId': 'subnet-a61dafcf',
},
],
},
{
'EbsOptimized': False,
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'r3.8xlarge',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True,
'DeleteOnTermination': False,
'DeviceIndex': 0,
'SecondaryPrivateIpAddressCount': 0,
'SubnetId': 'subnet-a61dafcf',
},
],
},
],
'SpotPrice': '0.05',
'TargetCapacity': 20,
},
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
'SpotFleetRequestState': 'active',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled , the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot .
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
See also: AWS API Documentation
Request Syntax
response = client.describe_spot_instance_requests(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
SpotInstanceRequestIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more Spot Instance request IDs.
dict
Response Syntax
{
'SpotInstanceRequests': [
{
'ActualBlockHourlyPrice': 'string',
'AvailabilityZoneGroup': 'string',
'BlockDurationMinutes': 123,
'CreateTime': datetime(2015, 1, 1),
'Fault': {
'Code': 'string',
'Message': 'string'
},
'InstanceId': 'string',
'LaunchGroup': 'string',
'LaunchSpecification': {
'UserData': 'string',
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'AddressingType': 'string',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'RamdiskId': 'string',
'SubnetId': 'string',
'Monitoring': {
'Enabled': True|False
}
},
'LaunchedAvailabilityZone': 'string',
'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
'SpotInstanceRequestId': 'string',
'SpotPrice': 'string',
'State': 'open'|'active'|'closed'|'cancelled'|'failed',
'Status': {
'Code': 'string',
'Message': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Type': 'one-time'|'persistent',
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeSpotInstanceRequests.
SpotInstanceRequests (list) --
One or more Spot Instance requests.
(dict) --
Describes a Spot Instance request.
ActualBlockHourlyPrice (string) --
Deprecated.
AvailabilityZoneGroup (string) --
The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
BlockDurationMinutes (integer) --
Deprecated.
CreateTime (datetime) --
The date and time when the Spot Instance request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Fault (dict) --
The fault codes for the Spot Instance request, if any.
Code (string) --
The reason code for the Spot Instance state change.
Message (string) --
The message for the Spot Instance state change.
InstanceId (string) --
The instance ID, if an instance has been launched to fulfill the Spot Instance request.
LaunchGroup (string) --
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
LaunchSpecification (dict) --
Additional information for launching instances.
UserData (string) --
The Base64-encoded user data for the instance.
SecurityGroups (list) --
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
AddressingType (string) --
Deprecated.
BlockDeviceMappings (list) --
One or more block device mapping entries.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
ImageId (string) --
The ID of the AMI.
InstanceType (string) --
The instance type.
KernelId (string) --
The ID of the kernel.
KeyName (string) --
The name of the key pair.
NetworkInterfaces (list) --
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
(dict) --
Describes a network interface.
AssociatePublicIpAddress (boolean) --
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
DeleteOnTermination (boolean) --
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
Description (string) --
The description of the network interface. Applies only if creating a network interface when launching an instance.
DeviceIndex (integer) --
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
Groups (list) --
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
Ipv6AddressCount (integer) --
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
Ipv6Addresses (list) --
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
PrivateIpAddress (string) --
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
PrivateIpAddresses (list) --
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
SubnetId (string) --
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
AssociateCarrierIpAddress (boolean) --
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
InterfaceType (string) --
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
NetworkCardIndex (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.
Placement (dict) --
The placement information for the instance.
AvailabilityZone (string) --
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
GroupName (string) --
The name of the placement group.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
RamdiskId (string) --
The ID of the RAM disk.
SubnetId (string) --
The ID of the subnet in which to launch the instance.
Monitoring (dict) --
Describes the monitoring of an instance.
Enabled (boolean) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
LaunchedAvailabilityZone (string) --
The Availability Zone in which the request is launched.
ProductDescription (string) --
The product description associated with the Spot Instance.
SpotInstanceRequestId (string) --
The ID of the Spot Instance request.
SpotPrice (string) --
The maximum price per hour that you are willing to pay for a Spot Instance.
State (string) --
The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot status in the Amazon EC2 User Guide for Linux Instances .
Status (dict) --
The status code and status message describing the Spot Instance request.
Code (string) --
The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances .
Message (string) --
The description for the status code.
UpdateTime (datetime) --
The date and time of the most recent status update, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Type (string) --
The Spot Instance request type.
ValidFrom (datetime) --
The start date of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The request becomes active at this date and time.
ValidUntil (datetime) --
The end date of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z).
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted.
NextToken (string) --
The token to use to retrieve the next set of results. This value is null when there are no more results to return.
Examples
This example describes the specified Spot Instance request.
response = client.describe_spot_instance_requests(
SpotInstanceRequestIds=[
'sir-08b93456',
],
)
print(response)
Expected Output:
{
'SpotInstanceRequests': [
{
'CreateTime': datetime(2014, 4, 30, 18, 14, 55, 2, 120, 0),
'InstanceId': 'i-1234567890abcdef0',
'LaunchSpecification': {
'BlockDeviceMappings': [
{
'DeviceName': '/dev/sda1',
'Ebs': {
'DeleteOnTermination': True,
'VolumeSize': 8,
'VolumeType': 'standard',
},
},
],
'EbsOptimized': False,
'ImageId': 'ami-7aba833f',
'InstanceType': 'm1.small',
'KeyName': 'my-key-pair',
'SecurityGroups': [
{
'GroupId': 'sg-e38f24a7',
'GroupName': 'my-security-group',
},
],
},
'LaunchedAvailabilityZone': 'us-west-1b',
'ProductDescription': 'Linux/UNIX',
'SpotInstanceRequestId': 'sir-08b93456',
'SpotPrice': '0.010000',
'State': 'active',
'Status': {
'Code': 'fulfilled',
'Message': 'Your Spot request is fulfilled.',
'UpdateTime': datetime(2014, 4, 30, 18, 16, 21, 2, 120, 0),
},
'Type': 'one-time',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances .
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
See also: AWS API Documentation
Request Syntax
response = client.describe_spot_price_history(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
AvailabilityZone='string',
DryRun=True|False,
EndTime=datetime(2015, 1, 1),
InstanceTypes=[
'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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
],
MaxResults=123,
NextToken='string',
ProductDescriptions=[
'string',
],
StartTime=datetime(2015, 1, 1)
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
Filters the results by the specified instance types.
Filters the results by the specified basic product descriptions.
dict
Response Syntax
{
'NextToken': 'string',
'SpotPriceHistory': [
{
'AvailabilityZone': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
'SpotPrice': 'string',
'Timestamp': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Contains the output of DescribeSpotPriceHistory.
NextToken (string) --
The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.
SpotPriceHistory (list) --
The historical Spot prices.
(dict) --
Describes the maximum price per hour that you are willing to pay for a Spot Instance.
AvailabilityZone (string) --
The Availability Zone.
InstanceType (string) --
The instance type.
ProductDescription (string) --
A general description of the AMI.
SpotPrice (string) --
The maximum price per hour that you are willing to pay for a Spot Instance.
Timestamp (datetime) --
The date and time the request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Examples
This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.
response = client.describe_spot_price_history(
EndTime=datetime(2014, 1, 6, 8, 9, 10, 0, 6, -1),
InstanceTypes=[
'm1.xlarge',
],
ProductDescriptions=[
'Linux/UNIX (Amazon VPC)',
],
StartTime=datetime(2014, 1, 6, 7, 8, 9, 0, 6, -1),
)
print(response)
Expected Output:
{
'SpotPriceHistory': [
{
'AvailabilityZone': 'us-west-1a',
'InstanceType': 'm1.xlarge',
'ProductDescription': 'Linux/UNIX (Amazon VPC)',
'SpotPrice': '0.080000',
'Timestamp': datetime(2014, 1, 6, 4, 32, 53, 0, 6, 0),
},
{
'AvailabilityZone': 'us-west-1c',
'InstanceType': 'm1.xlarge',
'ProductDescription': 'Linux/UNIX (Amazon VPC)',
'SpotPrice': '0.080000',
'Timestamp': datetime(2014, 1, 5, 11, 28, 26, 6, 5, 0),
},
],
'ResponseMetadata': {
'...': '...',
},
}
[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.
See also: AWS API Documentation
Request Syntax
response = client.describe_stale_security_groups(
DryRun=True|False,
MaxResults=123,
NextToken='string',
VpcId='string'
)
[REQUIRED]
The ID of the VPC.
dict
Response Syntax
{
'NextToken': 'string',
'StaleSecurityGroupSet': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'StaleIpPermissions': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
'string',
],
'PrefixListIds': [
'string',
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
'StaleIpPermissionsEgress': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
'string',
],
'PrefixListIds': [
'string',
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
'VpcId': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
StaleSecurityGroupSet (list) --
Information about the stale security groups.
(dict) --
Describes a stale security group (a security group that contains stale rules).
Description (string) --
The description of the security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
StaleIpPermissions (list) --
Information about the stale inbound rules in the security group.
(dict) --
Describes a stale rule in a security group.
FromPort (integer) --
The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
IpProtocol (string) --
The IP protocol name (for tcp , udp , and icmp ) or number (see Protocol Numbers) .
IpRanges (list) --
The IP ranges. Not applicable for stale security group rules.
PrefixListIds (list) --
The prefix list IDs. Not applicable for stale security group rules.
ToPort (integer) --
The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
UserIdGroupPairs (list) --
The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
StaleIpPermissionsEgress (list) --
Information about the stale outbound rules in the security group.
(dict) --
Describes a stale rule in a security group.
FromPort (integer) --
The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
IpProtocol (string) --
The IP protocol name (for tcp , udp , and icmp ) or number (see Protocol Numbers) .
IpRanges (list) --
The IP ranges. Not applicable for stale security group rules.
PrefixListIds (list) --
The prefix list IDs. Not applicable for stale security group rules.
ToPort (integer) --
The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
UserIdGroupPairs (list) --
The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
VpcId (string) --
The ID of the VPC for the security group.
Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress , Completed , or Failed . For tasks InProgress , the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using S3 in the Amazon Elastic Compute Cloud User Guide .
For more information, see Store and restore an AMI using S3 in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_store_image_tasks(
ImageIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'StoreImageTaskResults': [
{
'AmiId': 'string',
'TaskStartTime': datetime(2015, 1, 1),
'Bucket': 'string',
'S3objectKey': 'string',
'ProgressPercentage': 123,
'StoreTaskState': 'string',
'StoreTaskFailureReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StoreImageTaskResults (list) --
The information about the AMI store tasks.
(dict) --
The information about the AMI store task, including the progress of the task.
AmiId (string) --
The ID of the AMI that is being stored.
TaskStartTime (datetime) --
The time the task started.
Bucket (string) --
The name of the S3 bucket that contains the stored AMI object.
S3objectKey (string) --
The name of the stored AMI object in the bucket.
ProgressPercentage (integer) --
The progress of the task as a percentage.
StoreTaskState (string) --
The state of the store task (InProgress , Completed , or Failed ).
StoreTaskFailureReason (string) --
If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.
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.
Describes one or more of your subnets.
For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_subnets(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
SubnetIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more subnet IDs.
Default: Describes all your subnets.
dict
Response Syntax
{
'Subnets': [
{
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'AvailableIpAddressCount': 123,
'CidrBlock': 'string',
'DefaultForAz': True|False,
'MapPublicIpOnLaunch': True|False,
'MapCustomerOwnedIpOnLaunch': True|False,
'CustomerOwnedIpv4Pool': 'string',
'State': 'pending'|'available',
'SubnetId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'AssignIpv6AddressOnCreation': True|False,
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SubnetArn': 'string',
'OutpostArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Subnets (list) --
Information about one or more subnets.
(dict) --
Describes a subnet.
AvailabilityZone (string) --
The Availability Zone of the subnet.
AvailabilityZoneId (string) --
The AZ ID of the subnet.
AvailableIpAddressCount (integer) --
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
CidrBlock (string) --
The IPv4 CIDR block assigned to the subnet.
DefaultForAz (boolean) --
Indicates whether this is the default subnet for the Availability Zone.
MapPublicIpOnLaunch (boolean) --
Indicates whether instances launched in this subnet receive a public IPv4 address.
MapCustomerOwnedIpOnLaunch (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives a customer-owned IPv4 address.
CustomerOwnedIpv4Pool (string) --
The customer-owned IPv4 address pool associated with the subnet.
State (string) --
The current state of the subnet.
SubnetId (string) --
The ID of the subnet.
VpcId (string) --
The ID of the VPC the subnet is in.
OwnerId (string) --
The ID of the AWS account that owns the subnet.
AssignIpv6AddressOnCreation (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives an IPv6 address.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the subnet.
(dict) --
Describes an IPv6 CIDR block associated with a subnet.
AssociationId (string) --
The association ID for the CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of a CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
Tags (list) --
Any tags assigned to the subnet.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
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.
Examples
This example describes the subnets for the specified VPC.
response = client.describe_subnets(
Filters=[
{
'Name': 'vpc-id',
'Values': [
'vpc-a01106c2',
],
},
],
)
print(response)
Expected Output:
{
'Subnets': [
{
'AvailabilityZone': 'us-east-1c',
'AvailableIpAddressCount': 251,
'CidrBlock': '10.0.1.0/24',
'DefaultForAz': False,
'MapPublicIpOnLaunch': False,
'State': 'available',
'SubnetId': 'subnet-9d4a7b6c',
'VpcId': 'vpc-a01106c2',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'NextToken': 'string',
'Tags': [
{
'Key': 'string',
'ResourceId': 'string',
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Value': 'string'
},
]
}
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.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type.
Value (string) --
The tag value.
Examples
This example describes the tags for the specified instance.
response = client.describe_tags(
Filters=[
{
'Name': 'resource-id',
'Values': [
'i-1234567890abcdef8',
],
},
],
)
print(response)
Expected Output:
{
'Tags': [
{
'Key': 'Stack',
'ResourceId': 'i-1234567890abcdef8',
'ResourceType': 'instance',
'Value': 'test',
},
{
'Key': 'Name',
'ResourceId': 'i-1234567890abcdef8',
'ResourceType': 'instance',
'Value': 'Beta Server',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more Traffic Mirror filters.
See also: AWS API Documentation
Request Syntax
response = client.describe_traffic_mirror_filters(
TrafficMirrorFilterIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
The ID of the Traffic Mirror filter.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TrafficMirrorFilters': [
{
'TrafficMirrorFilterId': 'string',
'IngressFilterRules': [
{
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
],
'EgressFilterRules': [
{
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
],
'NetworkServices': [
'amazon-dns',
],
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TrafficMirrorFilters (list) --
Information about one or more Traffic Mirror filters.
(dict) --
Describes the Traffic Mirror filter.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
IngressFilterRules (list) --
Information about the ingress rules that are associated with the Traffic Mirror filter.
(dict) --
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
EgressFilterRules (list) --
Information about the egress rules that are associated with the Traffic Mirror filter.
(dict) --
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
NetworkServices (list) --
The network service traffic that is associated with the Traffic Mirror filter.
Description (string) --
The description of the Traffic Mirror filter.
Tags (list) --
The tags assigned to the Traffic Mirror filter.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
NextToken (string) --
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
See also: AWS API Documentation
Request Syntax
response = client.describe_traffic_mirror_sessions(
TrafficMirrorSessionIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
The ID of the Traffic Mirror session.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TrafficMirrorSessions': [
{
'TrafficMirrorSessionId': 'string',
'TrafficMirrorTargetId': 'string',
'TrafficMirrorFilterId': 'string',
'NetworkInterfaceId': 'string',
'OwnerId': 'string',
'PacketLength': 123,
'SessionNumber': 123,
'VirtualNetworkId': 123,
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TrafficMirrorSessions (list) --
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
(dict) --
Describes a Traffic Mirror session.
TrafficMirrorSessionId (string) --
The ID for the Traffic Mirror session.
TrafficMirrorTargetId (string) --
The ID of the Traffic Mirror target.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
NetworkInterfaceId (string) --
The ID of the Traffic Mirror session's network interface.
OwnerId (string) --
The ID of the account that owns the Traffic Mirror session.
PacketLength (integer) --
The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet
SessionNumber (integer) --
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
VirtualNetworkId (integer) --
The virtual network ID associated with the Traffic Mirror session.
Description (string) --
The description of the Traffic Mirror session.
Tags (list) --
The tags assigned to the Traffic Mirror session.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
NextToken (string) --
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
Information about one or more Traffic Mirror targets.
See also: AWS API Documentation
Request Syntax
response = client.describe_traffic_mirror_targets(
TrafficMirrorTargetIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
The ID of the Traffic Mirror targets.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TrafficMirrorTargets': [
{
'TrafficMirrorTargetId': 'string',
'NetworkInterfaceId': 'string',
'NetworkLoadBalancerArn': 'string',
'Type': 'network-interface'|'network-load-balancer',
'Description': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TrafficMirrorTargets (list) --
Information about one or more Traffic Mirror targets.
(dict) --
Describes a Traffic Mirror target.
TrafficMirrorTargetId (string) --
The ID of the Traffic Mirror target.
NetworkInterfaceId (string) --
The network interface ID that is attached to the target.
NetworkLoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the Network Load Balancer.
Type (string) --
The type of Traffic Mirror target.
Description (string) --
Information about the Traffic Mirror target.
OwnerId (string) --
The ID of the account that owns the Traffic Mirror target.
Tags (list) --
The tags assigned to the Traffic Mirror target.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
NextToken (string) --
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
See also: AWS API Documentation
Request Syntax
response = client.describe_transit_gateway_attachments(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the attachments.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayOwnerId': 'string',
'ResourceOwnerId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'Association': {
'TransitGatewayRouteTableId': 'string',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
},
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayAttachments (list) --
Information about the attachments.
(dict) --
Describes an attachment between a resource and a transit gateway.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayOwnerId (string) --
The ID of the AWS account that owns the transit gateway.
ResourceOwnerId (string) --
The ID of the AWS account that owns the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
State (string) --
The attachment state. Note that the initiating state has been deprecated.
Association (dict) --
The association.
TransitGatewayRouteTableId (string) --
The ID of the route table for the transit gateway.
State (string) --
The state of the association.
CreationTime (datetime) --
The creation time.
Tags (list) --
The tags for the attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more Connect peers.
See also: AWS API Documentation
Request Syntax
response = client.describe_transit_gateway_connect_peers(
TransitGatewayConnectPeerIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the Connect peers.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayConnectPeers': [
{
'TransitGatewayAttachmentId': 'string',
'TransitGatewayConnectPeerId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CreationTime': datetime(2015, 1, 1),
'ConnectPeerConfiguration': {
'TransitGatewayAddress': 'string',
'PeerAddress': 'string',
'InsideCidrBlocks': [
'string',
],
'Protocol': 'gre',
'BgpConfigurations': [
{
'TransitGatewayAsn': 123,
'PeerAsn': 123,
'TransitGatewayAddress': 'string',
'PeerAddress': 'string',
'BgpStatus': 'up'|'down'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayConnectPeers (list) --
Information about the Connect peers.
(dict) --
Describes a transit gateway Connect peer.
TransitGatewayAttachmentId (string) --
The ID of the Connect attachment.
TransitGatewayConnectPeerId (string) --
The ID of the Connect peer.
State (string) --
The state of the Connect peer.
CreationTime (datetime) --
The creation time.
ConnectPeerConfiguration (dict) --
The Connect peer details.
TransitGatewayAddress (string) --
The Connect peer IP address on the transit gateway side of the tunnel.
PeerAddress (string) --
The Connect peer IP address on the appliance side of the tunnel.
InsideCidrBlocks (list) --
The range of interior BGP peer IP addresses.
Protocol (string) --
The tunnel protocol.
BgpConfigurations (list) --
The BGP configuration details.
(dict) --
The BGP configuration information.
TransitGatewayAsn (integer) --
The transit gateway Autonomous System Number (ASN).
PeerAsn (integer) --
The peer Autonomous System Number (ASN).
TransitGatewayAddress (string) --
The interior BGP peer IP address for the transit gateway.
PeerAddress (string) --
The interior BGP peer IP address for the appliance.
BgpStatus (string) --
The BGP status.
Tags (list) --
The tags for the Connect peer.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more Connect attachments.
See also: AWS API Documentation
Request Syntax
response = client.describe_transit_gateway_connects(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the attachments.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayConnects': [
{
'TransitGatewayAttachmentId': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'Protocol': 'gre'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayConnects (list) --
Information about the Connect attachments.
(dict) --
Describes a transit gateway Connect attachment.
TransitGatewayAttachmentId (string) --
The ID of the Connect attachment.
TransportTransitGatewayAttachmentId (string) --
The ID of the attachment from which the Connect attachment was created.
TransitGatewayId (string) --
The ID of the transit gateway.
State (string) --
The state of the attachment.
CreationTime (datetime) --
The creation time.
Options (dict) --
The Connect attachment options.
Protocol (string) --
The tunnel protocol.
Tags (list) --
The tags for the attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more transit gateway multicast domains.
See also: AWS API Documentation
Request Syntax
response = client.describe_transit_gateway_multicast_domains(
TransitGatewayMulticastDomainIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The ID of the transit gateway multicast domain.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayMulticastDomains': [
{
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayMulticastDomainArn': 'string',
'OwnerId': 'string',
'Options': {
'Igmpv2Support': 'enable'|'disable',
'StaticSourcesSupport': 'enable'|'disable',
'AutoAcceptSharedAssociations': 'enable'|'disable'
},
'State': 'pending'|'available'|'deleting'|'deleted',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayMulticastDomains (list) --
Information about the transit gateway multicast domains.
(dict) --
Describes the transit gateway multicast domain.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayMulticastDomainArn (string) --
The Amazon Resource Name (ARN) of the transit gateway multicast domain.
OwnerId (string) --
The ID of the AWS account that owns the transit gateway multiicast domain.
Options (dict) --
The options for the transit gateway multicast domain.
Igmpv2Support (string) --
Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
StaticSourcesSupport (string) --
Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
AutoAcceptSharedAssociations (string) --
Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
State (string) --
The state of the transit gateway multicast domain.
CreationTime (datetime) --
The time the transit gateway multicast domain was created.
Tags (list) --
The tags for the transit gateway multicast domain.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes your transit gateway peering attachments.
See also: AWS API Documentation
Request Syntax
response = client.describe_transit_gateway_peering_attachments(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
One or more IDs of the transit gateway peering attachments.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayPeeringAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayPeeringAttachments (list) --
The transit gateway peering attachments.
(dict) --
Describes the transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.
See also: AWS API Documentation
Request Syntax
response = client.describe_transit_gateway_route_tables(
TransitGatewayRouteTableIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the transit gateway route tables.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayRouteTables': [
{
'TransitGatewayRouteTableId': 'string',
'TransitGatewayId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'DefaultAssociationRouteTable': True|False,
'DefaultPropagationRouteTable': True|False,
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayRouteTables (list) --
Information about the transit gateway route tables.
(dict) --
Describes a transit gateway route table.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
TransitGatewayId (string) --
The ID of the transit gateway.
State (string) --
The state of the transit gateway route table.
DefaultAssociationRouteTable (boolean) --
Indicates whether this is the default association route table for the transit gateway.
DefaultPropagationRouteTable (boolean) --
Indicates whether this is the default propagation route table for the transit gateway.
CreationTime (datetime) --
The creation time.
Tags (list) --
Any tags assigned to the route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
See also: AWS API Documentation
Request Syntax
response = client.describe_transit_gateway_vpc_attachments(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the attachments.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayVpcAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'VpcId': 'string',
'VpcOwnerId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'SubnetIds': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Options': {
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayVpcAttachments (list) --
Information about the VPC attachments.
(dict) --
Describes a VPC attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
VpcId (string) --
The ID of the VPC.
VpcOwnerId (string) --
The ID of the AWS account that owns the VPC.
State (string) --
The state of the VPC attachment. Note that the initiating state has been deprecated.
SubnetIds (list) --
The IDs of the subnets.
CreationTime (datetime) --
The creation time.
Options (dict) --
The VPC attachment options.
DnsSupport (string) --
Indicates whether DNS support is enabled.
Ipv6Support (string) --
Indicates whether IPv6 support is disabled.
ApplianceModeSupport (string) --
Indicates whether appliance mode support is enabled.
Tags (list) --
The tags for the VPC attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
See also: AWS API Documentation
Request Syntax
response = client.describe_transit_gateways(
TransitGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The IDs of the transit gateways.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGateways': [
{
'TransitGatewayId': 'string',
'TransitGatewayArn': 'string',
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'OwnerId': 'string',
'Description': 'string',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'AmazonSideAsn': 123,
'TransitGatewayCidrBlocks': [
'string',
],
'AutoAcceptSharedAttachments': 'enable'|'disable',
'DefaultRouteTableAssociation': 'enable'|'disable',
'AssociationDefaultRouteTableId': 'string',
'DefaultRouteTablePropagation': 'enable'|'disable',
'PropagationDefaultRouteTableId': 'string',
'VpnEcmpSupport': 'enable'|'disable',
'DnsSupport': 'enable'|'disable',
'MulticastSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGateways (list) --
Information about the transit gateways.
(dict) --
Describes a transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (string) --
The state of the transit gateway.
OwnerId (string) --
The ID of the AWS account ID that owns the transit gateway.
Description (string) --
The description of the transit gateway.
CreationTime (datetime) --
The creation time.
Options (dict) --
The transit gateway options.
AmazonSideAsn (integer) --
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
TransitGatewayCidrBlocks (list) --
The transit gateway CIDR blocks.
AutoAcceptSharedAttachments (string) --
Indicates whether attachment requests are automatically accepted.
DefaultRouteTableAssociation (string) --
Indicates whether resource attachments are automatically associated with the default association route table.
AssociationDefaultRouteTableId (string) --
The ID of the default association route table.
DefaultRouteTablePropagation (string) --
Indicates whether resource attachments automatically propagate routes to the default propagation route table.
PropagationDefaultRouteTableId (string) --
The ID of the default propagation route table.
VpnEcmpSupport (string) --
Indicates whether Equal Cost Multipath Protocol support is enabled.
DnsSupport (string) --
Indicates whether DNS support is enabled.
MulticastSupport (string) --
Indicates whether multicast is enabled on the transit gateway
Tags (list) --
The tags for the transit gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes one or more network interface trunk associations.
See also: AWS API Documentation
Request Syntax
response = client.describe_trunk_interface_associations(
AssociationIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
The IDs of the associations.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'InterfaceAssociations': [
{
'AssociationId': 'string',
'BranchInterfaceId': 'string',
'TrunkInterfaceId': 'string',
'InterfaceProtocol': 'VLAN'|'GRE',
'VlanId': 123,
'GreKey': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InterfaceAssociations (list) --
Information about the trunk associations.
(dict) --
Information about an association between a branch network interface with a trunk network interface.
AssociationId (string) --
The ID of the association.
BranchInterfaceId (string) --
The ID of the branch network interface.
TrunkInterfaceId (string) --
The ID of the trunk network interface.
InterfaceProtocol (string) --
The interface protocol. Valid values are VLAN and GRE .
VlanId (integer) --
The ID of the VLAN when you use the VLAN protocol.
GreKey (integer) --
The application key when you use the GRE protocol.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_volume_attribute(
Attribute='autoEnableIO'|'productCodes',
VolumeId='string',
DryRun=True|False
)
[REQUIRED]
The attribute of the volume. This parameter is required.
[REQUIRED]
The ID of the volume.
dict
Response Syntax
{
'AutoEnableIO': {
'Value': True|False
},
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'VolumeId': 'string'
}
Response Structure
(dict) --
AutoEnableIO (dict) --
The state of autoEnableIO attribute.
Value (boolean) --
The attribute value. The valid values are true or false .
ProductCodes (list) --
A list of product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
VolumeId (string) --
The ID of the volume.
Examples
This example describes the autoEnableIo attribute of the volume with the ID vol-049df61146c4d7901.
response = client.describe_volume_attribute(
Attribute='autoEnableIO',
VolumeId='vol-049df61146c4d7901',
)
print(response)
Expected Output:
{
'AutoEnableIO': {
'Value': False,
},
'VolumeId': 'vol-049df61146c4d7901',
'ResponseMetadata': {
'...': '...',
},
}
Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status : Reflects the current status of the volume. The possible values are ok , impaired , warning , or insufficient-data . If all checks pass, the overall status of the volume is ok . If the check fails, the overall status is impaired . If the status is insufficient-data , then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the status of your volumes in the Amazon Elastic Compute Cloud User Guide .
Events : Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency . This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions : Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency , then the action shows enable-volume-io . This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
See also: AWS API Documentation
Request Syntax
response = client.describe_volume_status(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
VolumeIds=[
'string',
],
DryRun=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the volumes.
Default: Describes all your volumes.
dict
Response Syntax
{
'NextToken': 'string',
'VolumeStatuses': [
{
'Actions': [
{
'Code': 'string',
'Description': 'string',
'EventId': 'string',
'EventType': 'string'
},
],
'AvailabilityZone': 'string',
'OutpostArn': 'string',
'Events': [
{
'Description': 'string',
'EventId': 'string',
'EventType': 'string',
'NotAfter': datetime(2015, 1, 1),
'NotBefore': datetime(2015, 1, 1),
'InstanceId': 'string'
},
],
'VolumeId': 'string',
'VolumeStatus': {
'Details': [
{
'Name': 'io-enabled'|'io-performance',
'Status': 'string'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'
},
'AttachmentStatuses': [
{
'IoPerformance': 'string',
'InstanceId': 'string'
},
]
},
]
}
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.
VolumeStatuses (list) --
Information about the status of the volumes.
(dict) --
Describes the volume status.
Actions (list) --
The details of the operation.
(dict) --
Describes a volume status operation code.
Code (string) --
The code identifying the operation, for example, enable-volume-io .
Description (string) --
A description of the operation.
EventId (string) --
The ID of the event associated with this operation.
EventType (string) --
The event type associated with this operation.
AvailabilityZone (string) --
The Availability Zone of the volume.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Events (list) --
A list of events associated with the volume.
(dict) --
Describes a volume status event.
Description (string) --
A description of the event.
EventId (string) --
The ID of this event.
EventType (string) --
The type of this event.
NotAfter (datetime) --
The latest end time of the event.
NotBefore (datetime) --
The earliest start time of the event.
InstanceId (string) --
The ID of the instance associated with the event.
VolumeId (string) --
The volume ID.
VolumeStatus (dict) --
The volume status.
Details (list) --
The details of the volume status.
(dict) --
Describes a volume status.
Name (string) --
The name of the volume status.
Status (string) --
The intended status of the volume status.
Status (string) --
The status of the volume.
AttachmentStatuses (list) --
Information about the instances to which the volume is attached.
(dict) --
Information about the instances to which the volume is attached.
IoPerformance (string) --
The maximum IOPS supported by the attached instance.
InstanceId (string) --
The ID of the attached instance.
Examples
This example describes the status for the volume vol-1234567890abcdef0.
response = client.describe_volume_status(
VolumeIds=[
'vol-1234567890abcdef0',
],
)
print(response)
Expected Output:
{
'VolumeStatuses': [
{
'Actions': [
],
'AvailabilityZone': 'us-east-1a',
'Events': [
],
'VolumeId': 'vol-1234567890abcdef0',
'VolumeStatus': {
'Details': [
{
'Name': 'io-enabled',
'Status': 'passed',
},
{
'Name': 'io-performance',
'Status': 'not-applicable',
},
],
'Status': 'ok',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.
response = client.describe_volume_status(
Filters=[
{
'Name': 'volume-status.status',
'Values': [
'impaired',
],
},
],
)
print(response)
Expected Output:
{
'VolumeStatuses': [
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_volumes(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VolumeIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The volume IDs.
dict
Response Syntax
{
'Volumes': [
{
'Attachments': [
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
},
],
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Encrypted': True|False,
'KmsKeyId': 'string',
'OutpostArn': 'string',
'Size': 123,
'SnapshotId': 'string',
'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
'VolumeId': 'string',
'Iops': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'FastRestored': True|False,
'MultiAttachEnabled': True|False,
'Throughput': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Volumes (list) --
Information about the volumes.
(dict) --
Describes a volume.
Attachments (list) --
Information about the volume attachments.
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
AvailabilityZone (string) --
The Availability Zone for the volume.
CreateTime (datetime) --
The time stamp when volume creation was initiated.
Encrypted (boolean) --
Indicates whether the volume is encrypted.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Size (integer) --
The size of the volume, in GiBs.
SnapshotId (string) --
The snapshot from which the volume was created, if applicable.
State (string) --
The volume state.
VolumeId (string) --
The ID of the volume.
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
Tags (list) --
Any tags assigned to the volume.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VolumeType (string) --
The volume type.
FastRestored (boolean) --
Indicates whether the volume was created using fast snapshot restore.
MultiAttachEnabled (boolean) --
Indicates whether Amazon EBS Multi-Attach is enabled.
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
NextToken (string) --
The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Examples
This example describes all of your volumes in the default region.
response = client.describe_volumes(
)
print(response)
Expected Output:
{
'NextToken': '',
'Volumes': [
{
'Attachments': [
{
'AttachTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0),
'DeleteOnTermination': True,
'Device': '/dev/sda1',
'InstanceId': 'i-1234567890abcdef0',
'State': 'attached',
'VolumeId': 'vol-049df61146c4d7901',
},
],
'AvailabilityZone': 'us-east-1a',
'CreateTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0),
'Size': 8,
'SnapshotId': 'snap-1234567890abcdef0',
'State': 'in-use',
'VolumeId': 'vol-049df61146c4d7901',
'VolumeType': 'standard',
},
],
'ResponseMetadata': {
'...': '...',
},
}
This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.
response = client.describe_volumes(
Filters=[
{
'Name': 'attachment.instance-id',
'Values': [
'i-1234567890abcdef0',
],
},
{
'Name': 'attachment.delete-on-termination',
'Values': [
'true',
],
},
],
)
print(response)
Expected Output:
{
'Volumes': [
{
'Attachments': [
{
'AttachTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0),
'DeleteOnTermination': True,
'Device': '/dev/sda1',
'InstanceId': 'i-1234567890abcdef0',
'State': 'attached',
'VolumeId': 'vol-049df61146c4d7901',
},
],
'AvailabilityZone': 'us-east-1a',
'CreateTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0),
'Size': 8,
'SnapshotId': 'snap-1234567890abcdef0',
'State': 'in-use',
'VolumeId': 'vol-049df61146c4d7901',
'VolumeType': 'standard',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide . For more information, see Monitoring volume modifications in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_volumes_modifications(
DryRun=True|False,
VolumeIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
The IDs of the volumes.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'VolumesModifications': [
{
'VolumeId': 'string',
'ModificationState': 'modifying'|'optimizing'|'completed'|'failed',
'StatusMessage': 'string',
'TargetSize': 123,
'TargetIops': 123,
'TargetVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'TargetThroughput': 123,
'TargetMultiAttachEnabled': True|False,
'OriginalSize': 123,
'OriginalIops': 123,
'OriginalVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'OriginalThroughput': 123,
'OriginalMultiAttachEnabled': True|False,
'Progress': 123,
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VolumesModifications (list) --
Information about the volume modifications.
(dict) --
Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
VolumeId (string) --
The ID of the volume.
ModificationState (string) --
The current modification state. The modification state is null for unmodified volumes.
StatusMessage (string) --
A status message about the modification progress or failure.
TargetSize (integer) --
The target size of the volume, in GiB.
TargetIops (integer) --
The target IOPS rate of the volume.
TargetVolumeType (string) --
The target EBS volume type of the volume.
TargetThroughput (integer) --
The target throughput of the volume, in MiB/s.
TargetMultiAttachEnabled (boolean) --
The target setting for Amazon EBS Multi-Attach.
OriginalSize (integer) --
The original size of the volume, in GiB.
OriginalIops (integer) --
The original IOPS rate of the volume.
OriginalVolumeType (string) --
The original EBS volume type of the volume.
OriginalThroughput (integer) --
The original throughput of the volume, in MiB/s.
OriginalMultiAttachEnabled (boolean) --
The original setting for Amazon EBS Multi-Attach.
Progress (integer) --
The modification progress, from 0 to 100 percent complete.
StartTime (datetime) --
The modification start time.
EndTime (datetime) --
The modification completion or failure time.
NextToken (string) --
Token for pagination, null if there are no more results
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_attribute(
Attribute='enableDnsSupport'|'enableDnsHostnames',
VpcId='string',
DryRun=True|False
)
[REQUIRED]
The VPC attribute.
[REQUIRED]
The ID of the VPC.
dict
Response Syntax
{
'VpcId': 'string',
'EnableDnsHostnames': {
'Value': True|False
},
'EnableDnsSupport': {
'Value': True|False
}
}
Response Structure
(dict) --
VpcId (string) --
The ID of the VPC.
EnableDnsHostnames (dict) --
Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true , instances in the VPC get DNS hostnames; otherwise, they do not.
Value (boolean) --
The attribute value. The valid values are true or false .
EnableDnsSupport (dict) --
Indicates whether DNS resolution is enabled for the VPC. If this attribute is true , the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
Value (boolean) --
The attribute value. The valid values are true or false .
Examples
This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
response = client.describe_vpc_attribute(
Attribute='enableDnsSupport',
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'EnableDnsSupport': {
'Value': True,
},
'VpcId': 'vpc-a01106c2',
'ResponseMetadata': {
'...': '...',
},
}
This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
response = client.describe_vpc_attribute(
Attribute='enableDnsHostnames',
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'EnableDnsHostnames': {
'Value': True,
},
'VpcId': 'vpc-a01106c2',
'ResponseMetadata': {
'...': '...',
},
}
Describes the ClassicLink status of one or more VPCs.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_classic_link(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
VpcIds=[
'string',
]
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPCs for which you want to describe the ClassicLink status.
dict
Response Syntax
{
'Vpcs': [
{
'ClassicLinkEnabled': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
]
}
Response Structure
(dict) --
Vpcs (list) --
The ClassicLink status of one or more VPCs.
(dict) --
Describes whether a VPC is enabled for ClassicLink.
ClassicLinkEnabled (boolean) --
Indicates whether the VPC is enabled for ClassicLink.
Tags (list) --
Any tags assigned to the VPC.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_classic_link_dns_support(
MaxResults=123,
NextToken='string',
VpcIds=[
'string',
]
)
One or more VPC IDs.
dict
Response Syntax
{
'NextToken': 'string',
'Vpcs': [
{
'ClassicLinkDnsSupported': True|False,
'VpcId': 'string'
},
]
}
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.
Vpcs (list) --
Information about the ClassicLink DNS support status of the VPCs.
(dict) --
Describes the ClassicLink DNS support status of a VPC.
ClassicLinkDnsSupported (boolean) --
Indicates whether ClassicLink DNS support is enabled for the VPC.
VpcId (string) --
The ID of the VPC.
Describes the connection notifications for VPC endpoints and VPC endpoint services.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_endpoint_connection_notifications(
DryRun=True|False,
ConnectionNotificationId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ConnectionNotificationSet': [
{
'ConnectionNotificationId': 'string',
'ServiceId': 'string',
'VpcEndpointId': 'string',
'ConnectionNotificationType': 'Topic',
'ConnectionNotificationArn': 'string',
'ConnectionEvents': [
'string',
],
'ConnectionNotificationState': 'Enabled'|'Disabled'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConnectionNotificationSet (list) --
One or more notifications.
(dict) --
Describes a connection notification for a VPC endpoint or VPC endpoint service.
ConnectionNotificationId (string) --
The ID of the notification.
ServiceId (string) --
The ID of the endpoint service.
VpcEndpointId (string) --
The ID of the VPC endpoint.
ConnectionNotificationType (string) --
The type of notification.
ConnectionNotificationArn (string) --
The ARN of the SNS topic for the notification.
ConnectionEvents (list) --
The events for the notification. Valid values are Accept , Connect , Delete , and Reject .
ConnectionNotificationState (string) --
The state of the notification.
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.
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_endpoint_connections(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'VpcEndpointConnections': [
{
'ServiceId': 'string',
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'VpcEndpointState': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'CreationTimestamp': datetime(2015, 1, 1),
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'NetworkLoadBalancerArns': [
'string',
],
'GatewayLoadBalancerArns': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VpcEndpointConnections (list) --
Information about one or more VPC endpoint connections.
(dict) --
Describes a VPC endpoint connection to a service.
ServiceId (string) --
The ID of the service to which the endpoint is connected.
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcEndpointOwner (string) --
The AWS account ID of the owner of the VPC endpoint.
VpcEndpointState (string) --
The state of the VPC endpoint.
CreationTimestamp (datetime) --
The date and time that the VPC endpoint was created.
DnsEntries (list) --
The DNS entries for the VPC endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
NetworkLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the network load balancers for the service.
GatewayLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
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.
Describes the VPC endpoint service configurations in your account (your services).
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_endpoint_service_configurations(
DryRun=True|False,
ServiceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
The IDs of one or more services.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'ServiceConfigurations': [
{
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
},
],
'ServiceId': 'string',
'ServiceName': 'string',
'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
'AvailabilityZones': [
'string',
],
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'NetworkLoadBalancerArns': [
'string',
],
'GatewayLoadBalancerArns': [
'string',
],
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'PrivateDnsNameConfiguration': {
'State': 'pendingVerification'|'verified'|'failed',
'Type': 'string',
'Value': 'string',
'Name': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServiceConfigurations (list) --
Information about one or more services.
(dict) --
Describes a service configuration for a VPC endpoint service.
ServiceType (list) --
The type of service.
(dict) --
Describes the type of service for a VPC endpoint.
ServiceType (string) --
The type of service.
ServiceId (string) --
The ID of the service.
ServiceName (string) --
The name of the service.
ServiceState (string) --
The service state.
AvailabilityZones (list) --
The Availability Zones in which the service is available.
AcceptanceRequired (boolean) --
Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
ManagesVpcEndpoints (boolean) --
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
NetworkLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
GatewayLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
BaseEndpointDnsNames (list) --
The DNS names for the service.
PrivateDnsName (string) --
The private DNS name for the service.
PrivateDnsNameConfiguration (dict) --
Information about the endpoint service private DNS name configuration.
State (string) --
The verification state of the VPC endpoint service.
>Consumers of the endpoint service can use the private name only when the state is verified .
Type (string) --
The endpoint service verification type, for example TXT.
Value (string) --
The value the service provider adds to the private DNS name domain record before verification.
Name (string) --
The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name .
Tags (list) --
Any tags assigned to the service.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_endpoint_service_permissions(
DryRun=True|False,
ServiceId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the service.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'AllowedPrincipals': [
{
'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role',
'Principal': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AllowedPrincipals (list) --
Information about one or more allowed principals.
(dict) --
Describes a principal.
PrincipalType (string) --
The type of principal.
Principal (string) --
The Amazon Resource Name (ARN) of the principal.
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.
Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b , the response includes the VPC endpoint services in the common Availability Zone, us-east-1a .
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_endpoint_services(
DryRun=True|False,
ServiceNames=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
One or more service names.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
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.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
dict
Response Syntax
{
'ServiceNames': [
'string',
],
'ServiceDetails': [
{
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
},
],
'AvailabilityZones': [
'string',
],
'Owner': 'string',
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'PrivateDnsNames': [
{
'PrivateDnsName': 'string'
},
],
'VpcEndpointPolicySupported': True|False,
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PrivateDnsNameVerificationState': 'pendingVerification'|'verified'|'failed'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeVpcEndpointServices.
ServiceNames (list) --
A list of supported services.
ServiceDetails (list) --
Information about the service.
(dict) --
Describes a VPC endpoint service.
ServiceName (string) --
The Amazon Resource Name (ARN) of the service.
ServiceId (string) --
The ID of the endpoint service.
ServiceType (list) --
The type of service.
(dict) --
Describes the type of service for a VPC endpoint.
ServiceType (string) --
The type of service.
AvailabilityZones (list) --
The Availability Zones in which the service is available.
Owner (string) --
The AWS account ID of the service owner.
BaseEndpointDnsNames (list) --
The DNS names for the service.
PrivateDnsName (string) --
The private DNS name for the service.
PrivateDnsNames (list) --
The private DNS names assigned to the VPC endpoint service.
(dict) --
Information about the Private DNS name for interface endpoints.
PrivateDnsName (string) --
The private DNS name assigned to the VPC endpoint service.
VpcEndpointPolicySupported (boolean) --
Indicates whether the service supports endpoint policies.
AcceptanceRequired (boolean) --
Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
ManagesVpcEndpoints (boolean) --
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
Tags (list) --
Any tags assigned to the service.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
PrivateDnsNameVerificationState (string) --
The verification state of the VPC endpoint service.
Consumers of the endpoint service cannot use the private name when the state is not verified .
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Describes one or more of your VPC endpoints.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_endpoints(
DryRun=True|False,
VpcEndpointIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
One or more endpoint IDs.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
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.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
dict
Response Syntax
{
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string',
'LastError': {
'Message': 'string',
'Code': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeVpcEndpoints.
VpcEndpoints (list) --
Information about the endpoints.
(dict) --
Describes a VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcEndpointType (string) --
The type of endpoint.
VpcId (string) --
The ID of the VPC to which the endpoint is associated.
ServiceName (string) --
The name of the service to which the endpoint is associated.
State (string) --
The state of the VPC endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) One or more route tables associated with the endpoint.
SubnetIds (list) --
(Interface endpoint) One or more subnets in which the endpoint is located.
Groups (list) --
(Interface endpoint) Information about the security groups that are associated with the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the VPC endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) One or more network interfaces for the endpoint.
DnsEntries (list) --
(Interface endpoint) The DNS entries for the endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
CreationTimestamp (datetime) --
The date and time that the VPC endpoint was created.
Tags (list) --
Any tags assigned to the VPC endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the AWS account that owns the VPC endpoint.
LastError (dict) --
The last error that occurred for VPC endpoint.
Message (string) --
The error message for the VPC endpoint error.
Code (string) --
The error code for the VPC endpoint error.
NextToken (string) --
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Describes one or more of your VPC peering connections.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_peering_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
VpcPeeringConnectionIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
dict
Response Syntax
{
'VpcPeeringConnections': [
{
'AccepterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'ExpirationTime': datetime(2015, 1, 1),
'RequesterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcPeeringConnectionId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VpcPeeringConnections (list) --
Information about the VPC peering connections.
(dict) --
Describes a VPC peering connection.
AccepterVpcInfo (dict) --
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
ExpirationTime (datetime) --
The time that an unaccepted VPC peering connection will expire.
RequesterVpcInfo (dict) --
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
Status (dict) --
The status of the VPC peering connection.
Code (string) --
The status of the VPC peering connection.
Message (string) --
A message that provides more information about the status, if applicable.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
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.
Describes one or more of your VPCs.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpcs(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpcIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC IDs.
Default: Describes all your VPCs.
dict
Response Syntax
{
'Vpcs': [
{
'CidrBlock': 'string',
'DhcpOptionsId': 'string',
'State': 'pending'|'available',
'VpcId': 'string',
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Vpcs (list) --
Information about one or more VPCs.
(dict) --
Describes a VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.
State (string) --
The current state of the VPC.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The ID of the AWS account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1 .
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
Tags (list) --
Any tags assigned to the VPC.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
Examples
This example describes the specified VPC.
response = client.describe_vpcs(
VpcIds=[
'vpc-a01106c2',
],
)
print(response)
Expected Output:
{
'Vpcs': [
{
'CidrBlock': '10.0.0.0/16',
'DhcpOptionsId': 'dopt-7a8b9c2d',
'InstanceTenancy': 'default',
'IsDefault': False,
'State': 'available',
'Tags': [
{
'Key': 'Name',
'Value': 'MyVPC',
},
],
'VpcId': 'vpc-a01106c2',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes one or more of your VPN connections.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_vpn_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpnConnectionIds=[
'string',
],
DryRun=True|False
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPN connection IDs.
Default: Describes your VPN connections.
dict
Response Syntax
{
'VpnConnections': [
{
'CustomerGatewayConfiguration': 'string',
'CustomerGatewayId': 'string',
'Category': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Type': 'ipsec.1',
'VpnConnectionId': 'string',
'VpnGatewayId': 'string',
'TransitGatewayId': 'string',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string'
},
]
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output of DescribeVpnConnections.
VpnConnections (list) --
Information about one or more VPN connections.
(dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
Describes one or more of your virtual private gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_vpn_gateways(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpnGatewayIds=[
'string',
],
DryRun=True|False
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
dict
Response Syntax
{
'VpnGateways': [
{
'AvailabilityZone': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Type': 'ipsec.1',
'VpcAttachments': [
{
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
},
],
'VpnGatewayId': 'string',
'AmazonSideAsn': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output of DescribeVpnGateways.
VpnGateways (list) --
Information about one or more virtual private gateways.
(dict) --
Describes a virtual private gateway.
AvailabilityZone (string) --
The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
State (string) --
The current state of the virtual private gateway.
Type (string) --
The type of VPN connection the virtual private gateway supports.
VpcAttachments (list) --
Any VPCs attached to the virtual private gateway.
(dict) --
Describes an attachment between a virtual private gateway and a VPC.
State (string) --
The current state of the attachment.
VpcId (string) --
The ID of the VPC.
VpnGatewayId (string) --
The ID of the virtual private gateway.
AmazonSideAsn (integer) --
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
Tags (list) --
Any tags assigned to the virtual private gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
See also: AWS API Documentation
Request Syntax
response = client.detach_classic_link_vpc(
DryRun=True|False,
InstanceId='string',
VpcId='string'
)
[REQUIRED]
The ID of the instance to unlink from the VPC.
[REQUIRED]
The ID of the VPC to which the instance is linked.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.
See also: AWS API Documentation
Request Syntax
response = client.detach_internet_gateway(
DryRun=True|False,
InternetGatewayId='string',
VpcId='string'
)
[REQUIRED]
The ID of the internet gateway.
[REQUIRED]
The ID of the VPC.
None
Examples
This example detaches the specified Internet gateway from the specified VPC.
response = client.detach_internet_gateway(
InternetGatewayId='igw-c0a643a9',
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Detaches a network interface from an instance.
See also: AWS API Documentation
Request Syntax
response = client.detach_network_interface(
AttachmentId='string',
DryRun=True|False,
Force=True|False
)
[REQUIRED]
The ID of the attachment.
Specifies whether to force a detachment.
Note
None
Examples
This example detaches the specified network interface from its attached instance.
response = client.detach_network_interface(
AttachmentId='eni-attach-66c4350a',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detaching an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.detach_volume(
Device='string',
Force=True|False,
InstanceId='string',
VolumeId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the volume.
dict
Response Syntax
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
}
Response Structure
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Examples
This example detaches the volume (vol-049df61146c4d7901) from the instance it is attached to.
response = client.detach_volume(
VolumeId='vol-1234567890abcdef0',
)
print(response)
Expected Output:
{
'AttachTime': datetime(2014, 2, 27, 19, 23, 6, 3, 58, 0),
'Device': '/dev/sdb',
'InstanceId': 'i-1234567890abcdef0',
'State': 'detaching',
'VolumeId': 'vol-049df61146c4d7901',
'ResponseMetadata': {
'...': '...',
},
}
Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.
See also: AWS API Documentation
Request Syntax
response = client.detach_vpn_gateway(
VpcId='string',
VpnGatewayId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the VPC.
[REQUIRED]
The ID of the virtual private gateway.
None
Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.disable_ebs_encryption_by_default(
DryRun=True|False
)
{
'EbsEncryptionByDefault': True|False
}
Response Structure
The updated status of encryption by default.
Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
See also: AWS API Documentation
Request Syntax
response = client.disable_fast_snapshot_restores(
AvailabilityZones=[
'string',
],
SourceSnapshotIds=[
'string',
],
DryRun=True|False
)
[REQUIRED]
One or more Availability Zones. For example, us-east-2a .
[REQUIRED]
The IDs of one or more snapshots. For example, snap-1234567890abcdef0 .
dict
Response Syntax
{
'Successful': [
{
'SnapshotId': 'string',
'AvailabilityZone': 'string',
'State': 'enabling'|'optimizing'|'enabled'|'disabling'|'disabled',
'StateTransitionReason': 'string',
'OwnerId': 'string',
'OwnerAlias': 'string',
'EnablingTime': datetime(2015, 1, 1),
'OptimizingTime': datetime(2015, 1, 1),
'EnabledTime': datetime(2015, 1, 1),
'DisablingTime': datetime(2015, 1, 1),
'DisabledTime': datetime(2015, 1, 1)
},
],
'Unsuccessful': [
{
'SnapshotId': 'string',
'FastSnapshotRestoreStateErrors': [
{
'AvailabilityZone': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
},
]
},
]
}
Response Structure
(dict) --
Successful (list) --
Information about the snapshots for which fast snapshot restores were successfully disabled.
(dict) --
Describes fast snapshot restores that were successfully disabled.
SnapshotId (string) --
The ID of the snapshot.
AvailabilityZone (string) --
The Availability Zone.
State (string) --
The state of fast snapshot restores for the snapshot.
StateTransitionReason (string) --
The reason for the state transition. The possible values are as follows:
OwnerId (string) --
The ID of the AWS account that enabled fast snapshot restores on the snapshot.
OwnerAlias (string) --
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
EnablingTime (datetime) --
The time at which fast snapshot restores entered the enabling state.
OptimizingTime (datetime) --
The time at which fast snapshot restores entered the optimizing state.
EnabledTime (datetime) --
The time at which fast snapshot restores entered the enabled state.
DisablingTime (datetime) --
The time at which fast snapshot restores entered the disabling state.
DisabledTime (datetime) --
The time at which fast snapshot restores entered the disabled state.
Unsuccessful (list) --
Information about the snapshots for which fast snapshot restores could not be disabled.
(dict) --
Contains information about the errors that occurred when disabling fast snapshot restores.
SnapshotId (string) --
The ID of the snapshot.
FastSnapshotRestoreStateErrors (list) --
The errors.
(dict) --
Contains information about an error that occurred when disabling fast snapshot restores.
AvailabilityZone (string) --
The Availability Zone.
Error (dict) --
The error.
Code (string) --
The error code.
Message (string) --
The error message.
Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.disable_image_deprecation(
ImageId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the AMI.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.disable_serial_console_access(
DryRun=True|False
)
{
'SerialConsoleAccessEnabled': True|False
}
Response Structure
If true , access to the EC2 serial console of all instances is enabled for your account. If false , access to the EC2 serial console of all instances is disabled for your account.
Disables the specified resource attachment from propagating routes to the specified propagation route table.
See also: AWS API Documentation
Request Syntax
response = client.disable_transit_gateway_route_table_propagation(
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the propagation route table.
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'Propagation': {
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'TransitGatewayRouteTableId': 'string',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
}
}
Response Structure
(dict) --
Propagation (dict) --
Information about route propagation.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
State (string) --
The state.
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
See also: AWS API Documentation
Request Syntax
response = client.disable_vgw_route_propagation(
GatewayId='string',
RouteTableId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the virtual private gateway.
[REQUIRED]
The ID of the route table.
None
Examples
This example disables the specified virtual private gateway from propagating static routes to the specified route table.
response = client.disable_vgw_route_propagation(
GatewayId='vgw-9a4cacf3',
RouteTableId='rtb-22574640',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
See also: AWS API Documentation
Request Syntax
response = client.disable_vpc_classic_link(
DryRun=True|False,
VpcId='string'
)
[REQUIRED]
The ID of the VPC.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide .
You must specify a VPC ID in the request.
See also: AWS API Documentation
Request Syntax
response = client.disable_vpc_classic_link_dns_support(
VpcId='string'
)
{
'Return': True|False
}
Response Structure
Returns true if the request succeeds; otherwise, it returns an error.
Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_address(
AssociationId='string',
PublicIp='string',
DryRun=True|False
)
None
Examples
This example disassociates an Elastic IP address from an instance in a VPC.
response = client.disassociate_address(
AssociationId='eipassoc-2bebb745',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example disassociates an Elastic IP address from an instance in EC2-Classic.
response = client.disassociate_address(
PublicIp='198.51.100.0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
See also: AWS API Documentation
Request Syntax
response = client.disassociate_client_vpn_target_network(
ClientVpnEndpointId='string',
AssociationId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint from which to disassociate the target network.
[REQUIRED]
The ID of the target network association.
dict
Response Syntax
{
'AssociationId': 'string',
'Status': {
'Code': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated',
'Message': 'string'
}
}
Response Structure
(dict) --
AssociationId (string) --
The ID of the target network association.
Status (dict) --
The current state of the target network association.
Code (string) --
The state of the target network association.
Message (string) --
A message about the status of the target network association, if applicable.
Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_enclave_certificate_iam_role(
CertificateArn='string',
RoleArn='string',
DryRun=True|False
)
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_iam_instance_profile(
AssociationId='string'
)
[REQUIRED]
The ID of the IAM instance profile association.
{
'IamInstanceProfileAssociation': {
'AssociationId': 'string',
'InstanceId': 'string',
'IamInstanceProfile': {
'Arn': 'string',
'Id': 'string'
},
'State': 'associating'|'associated'|'disassociating'|'disassociated',
'Timestamp': datetime(2015, 1, 1)
}
}
Response Structure
Information about the IAM instance profile association.
The ID of the association.
The ID of the instance.
The IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The ID of the instance profile.
The state of the association.
The time the IAM instance profile was associated with the instance.
Examples
This example disassociates the specified IAM instance profile from an instance.
response = client.disassociate_iam_instance_profile(
AssociationId='iip-assoc-05020b59952902f5f',
)
print(response)
Expected Output:
{
'IamInstanceProfileAssociation': {
'AssociationId': 'iip-assoc-05020b59952902f5f',
'IamInstanceProfile': {
'Arn': 'arn:aws:iam::123456789012:instance-profile/admin-role',
'Id': 'AIPAI5IVIHMFFYY2DKV5Y',
},
'InstanceId': 'i-123456789abcde123',
'State': 'disassociating',
},
'ResponseMetadata': {
'...': '...',
},
}
Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.disassociate_route_table(
AssociationId='string',
DryRun=True|False
)
[REQUIRED]
The association ID representing the current association between the route table and subnet or gateway.
None
Examples
This example disassociates the specified route table from its associated subnet.
response = client.disassociate_route_table(
AssociationId='rtbassoc-781d0d1a',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_subnet_cidr_block(
AssociationId='string'
)
[REQUIRED]
The association ID for the CIDR block.
{
'Ipv6CidrBlockAssociation': {
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
'SubnetId': 'string'
}
Response Structure
Information about the IPv6 CIDR block association.
The association ID for the CIDR block.
The IPv6 CIDR block.
Information about the state of the CIDR block.
The state of a CIDR block.
A message about the status of the CIDR block, if applicable.
The ID of the subnet.
Disassociates the specified subnets from the transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_transit_gateway_multicast_domain(
TransitGatewayMulticastDomainId='string',
TransitGatewayAttachmentId='string',
SubnetIds=[
'string',
],
DryRun=True|False
)
The IDs of the subnets;
dict
Response Syntax
{
'Associations': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceOwnerId': 'string',
'Subnets': [
{
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
},
]
}
}
Response Structure
(dict) --
Associations (dict) --
Information about the association.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the AWS account that owns the resource.
Subnets (list) --
The subnets associated with the multicast domain.
(dict) --
Describes the subnet association with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
Disassociates a resource attachment from a transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_transit_gateway_route_table(
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'Association': {
'TransitGatewayRouteTableId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
}
}
Response Structure
(dict) --
Association (dict) --
Information about the association.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the association.
Removes an association between a branch network interface with a trunk network interface.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_trunk_interface(
AssociationId='string',
ClientToken='string',
DryRun=True|False
)
[REQUIRED]
The ID ofthe association
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
{
'Return': True|False,
'ClientToken': 'string'
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .
Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs . You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).
See also: AWS API Documentation
Request Syntax
response = client.disassociate_vpc_cidr_block(
AssociationId='string'
)
[REQUIRED]
The association ID for the CIDR block.
{
'Ipv6CidrBlockAssociation': {
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string'
},
'CidrBlockAssociation': {
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
'VpcId': 'string'
}
Response Structure
Information about the IPv6 CIDR block association.
The association ID for the IPv6 CIDR block.
The IPv6 CIDR block.
Information about the state of the CIDR block.
The state of the CIDR block.
A message about the status of the CIDR block, if applicable.
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1 .
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
Information about the IPv4 CIDR block association.
The association ID for the IPv4 CIDR block.
The IPv4 CIDR block.
Information about the state of the CIDR block.
The state of the CIDR block.
A message about the status of the CIDR block, if applicable.
The ID of the VPC.
Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default CMK or the CMK that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
You can specify the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId .
Enabling encryption by default has no effect on the encryption status of your existing volumes.
After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types .
See also: AWS API Documentation
Request Syntax
response = client.enable_ebs_encryption_by_default(
DryRun=True|False
)
{
'EbsEncryptionByDefault': True|False
}
Response Structure
The updated status of encryption by default.
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores . To disable fast snapshot restores, use DisableFastSnapshotRestores .
For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.enable_fast_snapshot_restores(
AvailabilityZones=[
'string',
],
SourceSnapshotIds=[
'string',
],
DryRun=True|False
)
[REQUIRED]
One or more Availability Zones. For example, us-east-2a .
[REQUIRED]
The IDs of one or more snapshots. For example, snap-1234567890abcdef0 . You can specify a snapshot that was shared with you from another AWS account.
dict
Response Syntax
{
'Successful': [
{
'SnapshotId': 'string',
'AvailabilityZone': 'string',
'State': 'enabling'|'optimizing'|'enabled'|'disabling'|'disabled',
'StateTransitionReason': 'string',
'OwnerId': 'string',
'OwnerAlias': 'string',
'EnablingTime': datetime(2015, 1, 1),
'OptimizingTime': datetime(2015, 1, 1),
'EnabledTime': datetime(2015, 1, 1),
'DisablingTime': datetime(2015, 1, 1),
'DisabledTime': datetime(2015, 1, 1)
},
],
'Unsuccessful': [
{
'SnapshotId': 'string',
'FastSnapshotRestoreStateErrors': [
{
'AvailabilityZone': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
},
]
},
]
}
Response Structure
(dict) --
Successful (list) --
Information about the snapshots for which fast snapshot restores were successfully enabled.
(dict) --
Describes fast snapshot restores that were successfully enabled.
SnapshotId (string) --
The ID of the snapshot.
AvailabilityZone (string) --
The Availability Zone.
State (string) --
The state of fast snapshot restores.
StateTransitionReason (string) --
The reason for the state transition. The possible values are as follows:
OwnerId (string) --
The ID of the AWS account that enabled fast snapshot restores on the snapshot.
OwnerAlias (string) --
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
EnablingTime (datetime) --
The time at which fast snapshot restores entered the enabling state.
OptimizingTime (datetime) --
The time at which fast snapshot restores entered the optimizing state.
EnabledTime (datetime) --
The time at which fast snapshot restores entered the enabled state.
DisablingTime (datetime) --
The time at which fast snapshot restores entered the disabling state.
DisabledTime (datetime) --
The time at which fast snapshot restores entered the disabled state.
Unsuccessful (list) --
Information about the snapshots for which fast snapshot restores could not be enabled.
(dict) --
Contains information about the errors that occurred when enabling fast snapshot restores.
SnapshotId (string) --
The ID of the snapshot.
FastSnapshotRestoreStateErrors (list) --
The errors.
(dict) --
Contains information about an error that occurred when enabling fast snapshot restores.
AvailabilityZone (string) --
The Availability Zone.
Error (dict) --
The error.
Code (string) --
The error code.
Message (string) --
The error message.
Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.enable_image_deprecation(
ImageId='string',
DeprecateAt=datetime(2015, 1, 1),
DryRun=True|False
)
[REQUIRED]
The ID of the AMI.
[REQUIRED]
The date and time to deprecate the AMI, in UTC, in the following format: YYYY -MM -DD T*HH* :MM :SS Z. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
You can’t specify a date in the past. The upper limit for DeprecateAt is 10 years from now.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.enable_serial_console_access(
DryRun=True|False
)
{
'SerialConsoleAccessEnabled': True|False
}
Response Structure
If true , access to the EC2 serial console of all instances is enabled for your account. If false , access to the EC2 serial console of all instances is disabled for your account.
Enables the specified attachment to propagate routes to the specified propagation route table.
See also: AWS API Documentation
Request Syntax
response = client.enable_transit_gateway_route_table_propagation(
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the propagation route table.
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'Propagation': {
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'TransitGatewayRouteTableId': 'string',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
}
}
Response Structure
(dict) --
Propagation (dict) --
Information about route propagation.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
State (string) --
The state.
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
See also: AWS API Documentation
Request Syntax
response = client.enable_vgw_route_propagation(
GatewayId='string',
RouteTableId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.
[REQUIRED]
The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
None
Examples
This example enables the specified virtual private gateway to propagate static routes to the specified route table.
response = client.enable_vgw_route_propagation(
GatewayId='vgw-9a4cacf3',
RouteTableId='rtb-22574640',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
See also: AWS API Documentation
Request Syntax
response = client.enable_volume_io(
DryRun=True|False,
VolumeId='string'
)
[REQUIRED]
The ID of the volume.
None
Examples
This example enables I/O on volume vol-1234567890abcdef0.
response = client.enable_volume_io(
VolumeId='vol-1234567890abcdef0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.enable_vpc_classic_link(
DryRun=True|False,
VpcId='string'
)
[REQUIRED]
The ID of the VPC.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide .
You must specify a VPC ID in the request.
See also: AWS API Documentation
Request Syntax
response = client.enable_vpc_classic_link_dns_support(
VpcId='string'
)
{
'Return': True|False
}
Response Structure
Returns true if the request succeeds; otherwise, it returns an error.
Downloads the client certificate revocation list for the specified Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.export_client_vpn_client_certificate_revocation_list(
ClientVpnEndpointId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint.
dict
Response Syntax
{
'CertificateRevocationList': 'string',
'Status': {
'Code': 'pending'|'active',
'Message': 'string'
}
}
Response Structure
(dict) --
CertificateRevocationList (string) --
Information about the client certificate revocation list.
Status (dict) --
The current state of the client certificate revocation list.
Code (string) --
The state of the client certificate revocation list.
Message (string) --
A message about the status of the client certificate revocation list, if applicable.
Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.export_client_vpn_client_configuration(
ClientVpnEndpointId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint.
dict
Response Syntax
{
'ClientConfiguration': 'string'
}
Response Structure
(dict) --
ClientConfiguration (string) --
The contents of the Client VPN endpoint configuration file.
Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide .
See also: AWS API Documentation
Request Syntax
response = client.export_image(
ClientToken='string',
Description='string',
DiskImageFormat='VMDK'|'RAW'|'VHD',
DryRun=True|False,
ImageId='string',
S3ExportLocation={
'S3Bucket': 'string',
'S3Prefix': 'string'
},
RoleName='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
Token to enable idempotency for export image requests.
This field is autopopulated if not provided.
[REQUIRED]
The disk image format.
[REQUIRED]
The ID of the image.
[REQUIRED]
Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
The destination Amazon S3 bucket.
The prefix (logical hierarchy) in the bucket.
The tags to apply to the export image task during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Description': 'string',
'DiskImageFormat': 'VMDK'|'RAW'|'VHD',
'ExportImageTaskId': 'string',
'ImageId': 'string',
'RoleName': 'string',
'Progress': 'string',
'S3ExportLocation': {
'S3Bucket': 'string',
'S3Prefix': 'string'
},
'Status': 'string',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Description (string) --
A description of the image being exported.
DiskImageFormat (string) --
The disk image format for the exported image.
ExportImageTaskId (string) --
The ID of the export image task.
ImageId (string) --
The ID of the image.
RoleName (string) --
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
Progress (string) --
The percent complete of the export image task.
S3ExportLocation (dict) --
Information about the destination Amazon S3 bucket.
S3Bucket (string) --
The destination Amazon S3 bucket.
S3Prefix (string) --
The prefix (logical hierarchy) in the bucket.
Status (string) --
The status of the export image task. The possible values are active , completed , deleting , and deleted .
StatusMessage (string) --
The status message for the export image task.
Tags (list) --
Any tags assigned to the export image task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways .
See also: AWS API Documentation
Request Syntax
response = client.export_transit_gateway_routes(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
S3Bucket='string',
DryRun=True|False
)
[REQUIRED]
The ID of the route table.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
[REQUIRED]
The name of the S3 bucket.
dict
Response Syntax
{
'S3Location': 'string'
}
Response Structure
(dict) --
S3Location (string) --
The URL of the exported file in Amazon S3. For example, s3://bucket_name /VPCTransitGateway/TransitGatewayRouteTables/file_name .
Generate a presigned url given a client, its method, and arguments
The presigned url
Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that's used to encrypt the private key.
See also: AWS API Documentation
Request Syntax
response = client.get_associated_enclave_certificate_iam_roles(
CertificateArn='string',
DryRun=True|False
)
dict
Response Syntax
{
'AssociatedRoles': [
{
'AssociatedRoleArn': 'string',
'CertificateS3BucketName': 'string',
'CertificateS3ObjectKey': 'string',
'EncryptionKmsKeyId': 'string'
},
]
}
Response Structure
(dict) --
AssociatedRoles (list) --
Information about the associated IAM roles.
(dict) --
Information about the associated IAM roles.
AssociatedRoleArn (string) --
The ARN of the associated IAM role.
CertificateS3BucketName (string) --
The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
CertificateS3ObjectKey (string) --
The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: role_arn /certificate_arn .
EncryptionKmsKeyId (string) --
The ID of the KMS customer master key (CMK) used to encrypt the private key.
Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
See also: AWS API Documentation
Request Syntax
response = client.get_associated_ipv6_pool_cidrs(
PoolId='string',
NextToken='string',
MaxResults=123,
DryRun=True|False
)
[REQUIRED]
The ID of the IPv6 address pool.
dict
Response Syntax
{
'Ipv6CidrAssociations': [
{
'Ipv6Cidr': 'string',
'AssociatedResource': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Ipv6CidrAssociations (list) --
Information about the IPv6 CIDR block associations.
(dict) --
Describes an IPv6 CIDR block association.
Ipv6Cidr (string) --
The IPv6 CIDR block.
AssociatedResource (string) --
The resource that's associated with the IPv6 CIDR block.
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.
Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
See also: AWS API Documentation
Request Syntax
response = client.get_capacity_reservation_usage(
CapacityReservationId='string',
NextToken='string',
MaxResults=123,
DryRun=True|False
)
[REQUIRED]
The ID of the Capacity Reservation.
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 returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
dict
Response Syntax
{
'NextToken': 'string',
'CapacityReservationId': 'string',
'InstanceType': 'string',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'State': 'active'|'expired'|'cancelled'|'pending'|'failed',
'InstanceUsages': [
{
'AccountId': 'string',
'UsedInstanceCount': 123
},
]
}
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.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
InstanceType (string) --
The type of instance for which the Capacity Reservation reserves capacity.
TotalInstanceCount (integer) --
The number of instances for which the Capacity Reservation reserves capacity.
AvailableInstanceCount (integer) --
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
State (string) --
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
InstanceUsages (list) --
Information about the Capacity Reservation usage.
(dict) --
Information about the Capacity Reservation usage.
AccountId (string) --
The ID of the account that is making use of the Capacity Reservation.
UsedInstanceCount (integer) --
The number of instances the account currently has in the Capacity Reservation.
Describes the allocations from the specified customer-owned address pool.
See also: AWS API Documentation
Request Syntax
response = client.get_coip_pool_usage(
PoolId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the address pool.
The filters. The following are the possible values:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'CoipPoolId': 'string',
'CoipAddressUsages': [
{
'AllocationId': 'string',
'AwsAccountId': 'string',
'AwsService': 'string',
'CoIp': 'string'
},
],
'LocalGatewayRouteTableId': 'string'
}
Response Structure
(dict) --
CoipPoolId (string) --
The ID of the customer-owned address pool.
CoipAddressUsages (list) --
Information about the address usage.
(dict) --
Describes address usage for a customer-owned address pool.
AllocationId (string) --
The allocation ID of the address.
AwsAccountId (string) --
The AWS account ID.
AwsService (string) --
The AWS service.
CoIp (string) --
The customer-owned IP address.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_console_output(
InstanceId='string',
DryRun=True|False,
Latest=True|False
)
[REQUIRED]
The ID of the instance.
When enabled, retrieves the latest console output for the instance.
Default: disabled (false )
dict
Response Syntax
{
'InstanceId': 'string',
'Output': 'string',
'Timestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
InstanceId (string) --
The ID of the instance.
Output (string) --
The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.
Timestamp (datetime) --
The time at which the output was last updated.
Examples
This example gets the console output for the specified instance.
response = client.get_console_output(
InstanceId='i-1234567890abcdef0',
)
print(response)
Expected Output:
{
'InstanceId': 'i-1234567890abcdef0',
'Output': '...',
'Timestamp': datetime(2018, 5, 25, 21, 23, 53, 4, 145, 0),
'ResponseMetadata': {
'...': '...',
},
}
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
See also: AWS API Documentation
Request Syntax
response = client.get_console_screenshot(
DryRun=True|False,
InstanceId='string',
WakeUp=True|False
)
[REQUIRED]
The ID of the instance.
dict
Response Syntax
{
'ImageData': 'string',
'InstanceId': 'string'
}
Response Structure
(dict) --
ImageData (string) --
The data that comprises the image.
InstanceId (string) --
The ID of the instance.
Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_default_credit_specification(
DryRun=True|False,
InstanceFamily='t2'|'t3'|'t3a'|'t4g'
)
[REQUIRED]
The instance family.
dict
Response Syntax
{
'InstanceFamilyCreditSpecification': {
'InstanceFamily': 't2'|'t3'|'t3a'|'t4g',
'CpuCredits': 'string'
}
}
Response Structure
(dict) --
InstanceFamilyCreditSpecification (dict) --
The default credit option for CPU usage of the instance family.
InstanceFamily (string) --
The instance family.
CpuCredits (string) --
The default credit option for CPU usage of the instance family. Valid values are standard and unlimited .
Describes the default customer master key (CMK) for EBS encryption by default for your account in this Region. You can change the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId .
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_ebs_default_kms_key_id(
DryRun=True|False
)
{
'KmsKeyId': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the default CMK for encryption by default.
Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_ebs_encryption_by_default(
DryRun=True|False
)
{
'EbsEncryptionByDefault': True|False
}
Response Structure
Indicates whether encryption by default is enabled.
Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:
See also: AWS API Documentation
Request Syntax
response = client.get_flow_logs_integration_template(
DryRun=True|False,
FlowLogId='string',
ConfigDeliveryS3DestinationArn='string',
IntegrateServices={
'AthenaIntegrations': [
{
'IntegrationResultS3DestinationArn': 'string',
'PartitionLoadFrequency': 'none'|'daily'|'weekly'|'monthly',
'PartitionStartDate': datetime(2015, 1, 1),
'PartitionEndDate': datetime(2015, 1, 1)
},
]
}
)
[REQUIRED]
The ID of the flow log.
[REQUIRED]
To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.
[REQUIRED]
Information about the service integration.
Information about the integration with Amazon Athena.
Describes integration options for Amazon Athena.
The location in Amazon S3 to store the generated CloudFormation template.
The schedule for adding new partitions to the table.
The start date for the partition.
The end date for the partition.
dict
Response Syntax
{
'Result': 'string'
}
Response Structure
(dict) --
Result (string) --
The generated CloudFormation template.
Lists the resource groups to which a Capacity Reservation has been added.
See also: AWS API Documentation
Request Syntax
response = client.get_groups_for_capacity_reservation(
CapacityReservationId='string',
NextToken='string',
MaxResults=123,
DryRun=True|False
)
[REQUIRED]
The ID of the Capacity Reservation.
dict
Response Syntax
{
'NextToken': 'string',
'CapacityReservationGroups': [
{
'GroupArn': 'string',
'OwnerId': 'string'
},
]
}
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.
CapacityReservationGroups (list) --
Information about the resource groups to which the Capacity Reservation has been added.
(dict) --
Describes a resource group to which a Capacity Reservation has been added.
GroupArn (string) --
The ARN of the resource group.
OwnerId (string) --
The ID of the account that owns the resource group.
Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
See also: AWS API Documentation
Request Syntax
response = client.get_host_reservation_purchase_preview(
HostIdSet=[
'string',
],
OfferingId='string'
)
[REQUIRED]
The IDs of the Dedicated Hosts with which the reservation is associated.
[REQUIRED]
The offering ID of the reservation.
dict
Response Syntax
{
'CurrencyCode': 'USD',
'Purchase': [
{
'CurrencyCode': 'USD',
'Duration': 123,
'HostIdSet': [
'string',
],
'HostReservationId': 'string',
'HourlyPrice': 'string',
'InstanceFamily': 'string',
'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
'UpfrontPrice': 'string'
},
],
'TotalHourlyPrice': 'string',
'TotalUpfrontPrice': 'string'
}
Response Structure
(dict) --
CurrencyCode (string) --
The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD .
Purchase (list) --
The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
(dict) --
Describes the result of the purchase.
CurrencyCode (string) --
The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD .
Duration (integer) --
The duration of the reservation's term in seconds.
HostIdSet (list) --
The IDs of the Dedicated Hosts associated with the reservation.
HostReservationId (string) --
The ID of the reservation.
HourlyPrice (string) --
The hourly price of the reservation per hour.
InstanceFamily (string) --
The instance family on the Dedicated Host that the reservation can be associated with.
PaymentOption (string) --
The payment option for the reservation.
UpfrontPrice (string) --
The upfront price of the reservation.
TotalHourlyPrice (string) --
The potential total hourly price of the reservation per hour.
TotalUpfrontPrice (string) --
The potential total upfront price. This is billed immediately.
Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.
See also: AWS API Documentation
Request Syntax
response = client.get_launch_template_data(
DryRun=True|False,
InstanceId='string'
)
[REQUIRED]
The ID of the instance.
dict
Response Syntax
{
'LaunchTemplateData': {
'KernelId': 'string',
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'Encrypted': True|False,
'DeleteOnTermination': True|False,
'Iops': 123,
'KmsKeyId': 'string',
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'Throughput': 123
},
'NoDevice': 'string'
},
],
'NetworkInterfaces': [
{
'AssociateCarrierIpAddress': True|False,
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'InterfaceType': 'string',
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'NetworkCardIndex': 123
},
],
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string',
'PartitionNumber': 123
},
'RamDiskId': 'string',
'DisableApiTermination': True|False,
'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
'UserData': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ElasticGpuSpecifications': [
{
'Type': 'string'
},
],
'ElasticInferenceAccelerators': [
{
'Type': 'string',
'Count': 123
},
],
'SecurityGroupIds': [
'string',
],
'SecurityGroups': [
'string',
],
'InstanceMarketOptions': {
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
'CreditSpecification': {
'CpuCredits': 'string'
},
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
'HibernationOptions': {
'Configured': True|False
},
'MetadataOptions': {
'State': 'pending'|'applied',
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
}
}
}
Response Structure
(dict) --
LaunchTemplateData (dict) --
The instance data.
KernelId (string) --
The ID of the kernel, if applicable.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for Amazon EBS I/O.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
BlockDeviceMappings (list) --
The block device mappings.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name.
VirtualName (string) --
The virtual device name (ephemeralN).
Ebs (dict) --
Information about the block device for an EBS volume.
Encrypted (boolean) --
Indicates whether the EBS volume is encrypted.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports.
KmsKeyId (string) --
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiB.
VolumeType (string) --
The volume type.
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
NetworkInterfaces (list) --
The network interfaces.
(dict) --
Describes a network interface.
AssociateCarrierIpAddress (boolean) --
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide .
AssociatePublicIpAddress (boolean) --
Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
DeleteOnTermination (boolean) --
Indicates whether the network interface is deleted when the instance is terminated.
Description (string) --
A description for the network interface.
DeviceIndex (integer) --
The device index for the network interface attachment.
Groups (list) --
The IDs of one or more security groups.
InterfaceType (string) --
The type of network interface.
Ipv6AddressCount (integer) --
The number of IPv6 addresses for the network interface.
Ipv6Addresses (list) --
The IPv6 addresses for the network interface.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
PrivateIpAddress (string) --
The primary private IPv4 address of the network interface.
PrivateIpAddresses (list) --
One or more private IPv4 addresses.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses for the network interface.
SubnetId (string) --
The ID of the subnet for the network interface.
NetworkCardIndex (integer) --
The index of the network card.
ImageId (string) --
The ID of the AMI that was used to launch the instance.
InstanceType (string) --
The instance type.
KeyName (string) --
The name of the key pair.
Monitoring (dict) --
The monitoring for the instance.
Enabled (boolean) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Placement (dict) --
The placement of the instance.
AvailabilityZone (string) --
The Availability Zone of the instance.
Affinity (string) --
The affinity setting for the instance on the Dedicated Host.
GroupName (string) --
The name of the placement group for the instance.
HostId (string) --
The ID of the Dedicated Host for the instance.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
SpreadDomain (string) --
Reserved for future use.
HostResourceGroupArn (string) --
The ARN of the host resource group in which to launch the instances.
PartitionNumber (integer) --
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .
RamDiskId (string) --
The ID of the RAM disk, if applicable.
DisableApiTermination (boolean) --
If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
InstanceInitiatedShutdownBehavior (string) --
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
UserData (string) --
The user data for the instance.
TagSpecifications (list) --
The tags.
(dict) --
The tag specification for the launch template.
ResourceType (string) --
The type of resource.
Tags (list) --
The tags for the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ElasticGpuSpecifications (list) --
The elastic GPU specification.
(dict) --
Describes an elastic GPU.
Type (string) --
The elastic GPU type.
ElasticInferenceAccelerators (list) --
The elastic inference accelerator for the instance.
(dict) --
Describes an elastic inference accelerator.
Type (string) --
The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
Count (integer) --
The number of elastic inference accelerators to attach to the instance.
Default: 1
SecurityGroupIds (list) --
The security group IDs.
SecurityGroups (list) --
The security group names.
InstanceMarketOptions (dict) --
The market (purchasing) option for the instances.
MarketType (string) --
The market type.
SpotOptions (dict) --
The options for Spot Instances.
MaxPrice (string) --
The maximum hourly price you're willing to pay for the Spot Instances.
SpotInstanceType (string) --
The Spot Instance request type.
BlockDurationMinutes (integer) --
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
ValidUntil (datetime) --
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted.
CreditSpecification (dict) --
The credit option for CPU usage of the instance.
CpuCredits (string) --
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
CpuOptions (dict) --
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide .
CoreCount (integer) --
The number of CPU cores for the instance.
ThreadsPerCore (integer) --
The number of threads per CPU core.
CapacityReservationSpecification (dict) --
Information about the Capacity Reservation targeting option.
CapacityReservationPreference (string) --
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
CapacityReservationTarget (dict) --
Information about the target Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) --
The ID of the targeted Capacity Reservation.
CapacityReservationResourceGroupArn (string) --
The ARN of the targeted Capacity Reservation group.
LicenseSpecifications (list) --
The license configurations.
(dict) --
Describes a license configuration.
LicenseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the license configuration.
HibernationOptions (dict) --
Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide .
Configured (boolean) --
If this parameter is set to true , the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
MetadataOptions (dict) --
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide .
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
EnclaveOptions (dict) --
Indicates whether the instance is enabled for AWS Nitro Enclaves.
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.
Examples
This example gets the launch template data for the specified instance.
response = client.get_launch_template_data(
InstanceId='0123d646e8048babc',
)
print(response)
Expected Output:
{
'LaunchTemplateData': {
'BlockDeviceMappings': [
{
'DeviceName': '/dev/xvda',
'Ebs': {
'DeleteOnTermination': True,
'Encrypted': False,
'Iops': 100,
'SnapshotId': 'snap-02594938353ef77d3',
'VolumeSize': 8,
'VolumeType': 'gp2',
},
},
],
'EbsOptimized': False,
'ImageId': 'ami-32cf7b4a',
'InstanceType': 't2.medium',
'KeyName': 'my-key-pair',
'Monitoring': {
'Enabled': False,
},
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': False,
'DeleteOnTermination': True,
'Description': '',
'DeviceIndex': 0,
'Groups': [
'sg-d14e1bb4',
],
'Ipv6Addresses': [
],
'NetworkInterfaceId': 'eni-4338b5a9',
'PrivateIpAddress': '10.0.3.233',
'PrivateIpAddresses': [
{
'Primary': True,
'PrivateIpAddress': '10.0.3.233',
},
],
'SubnetId': 'subnet-5264e837',
},
],
'Placement': {
'AvailabilityZone': 'us-east-2b',
'GroupName': '',
'Tenancy': 'default',
},
},
'ResponseMetadata': {
'...': '...',
},
}
Gets information about the resources that are associated with the specified managed prefix list.
See also: AWS API Documentation
Request Syntax
response = client.get_managed_prefix_list_associations(
DryRun=True|False,
PrefixListId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the prefix list.
dict
Response Syntax
{
'PrefixListAssociations': [
{
'ResourceId': 'string',
'ResourceOwner': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PrefixListAssociations (list) --
Information about the associations.
(dict) --
Describes the resource with which a prefix list is associated.
ResourceId (string) --
The ID of the resource.
ResourceOwner (string) --
The owner of the resource.
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.
Gets information about the entries for a specified managed prefix list.
See also: AWS API Documentation
Request Syntax
response = client.get_managed_prefix_list_entries(
DryRun=True|False,
PrefixListId='string',
TargetVersion=123,
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the prefix list.
dict
Response Syntax
{
'Entries': [
{
'Cidr': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Information about the prefix list entries.
(dict) --
Describes a prefix list entry.
Cidr (string) --
The CIDR block.
Description (string) --
The description.
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.
Create a paginator for an operation.
Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide .
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
See also: AWS API Documentation
Request Syntax
response = client.get_password_data(
InstanceId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Windows instance.
dict
Response Syntax
{
'InstanceId': 'string',
'PasswordData': 'string',
'Timestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
InstanceId (string) --
The ID of the Windows instance.
PasswordData (string) --
The password of the instance. Returns an empty string if the password is not available.
Timestamp (datetime) --
The time the data was last updated.
Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.
See also: AWS API Documentation
Request Syntax
response = client.get_reserved_instances_exchange_quote(
DryRun=True|False,
ReservedInstanceIds=[
'string',
],
TargetConfigurations=[
{
'InstanceCount': 123,
'OfferingId': 'string'
},
]
)
[REQUIRED]
The IDs of the Convertible Reserved Instances to exchange.
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
Details about the target configuration.
The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
The Convertible Reserved Instance offering ID.
dict
Response Syntax
{
'CurrencyCode': 'string',
'IsValidExchange': True|False,
'OutputReservedInstancesWillExpireAt': datetime(2015, 1, 1),
'PaymentDue': 'string',
'ReservedInstanceValueRollup': {
'HourlyPrice': 'string',
'RemainingTotalValue': 'string',
'RemainingUpfrontValue': 'string'
},
'ReservedInstanceValueSet': [
{
'ReservationValue': {
'HourlyPrice': 'string',
'RemainingTotalValue': 'string',
'RemainingUpfrontValue': 'string'
},
'ReservedInstanceId': 'string'
},
],
'TargetConfigurationValueRollup': {
'HourlyPrice': 'string',
'RemainingTotalValue': 'string',
'RemainingUpfrontValue': 'string'
},
'TargetConfigurationValueSet': [
{
'ReservationValue': {
'HourlyPrice': 'string',
'RemainingTotalValue': 'string',
'RemainingUpfrontValue': 'string'
},
'TargetConfiguration': {
'InstanceCount': 123,
'OfferingId': 'string'
}
},
],
'ValidationFailureReason': 'string'
}
Response Structure
(dict) --
Contains the output of GetReservedInstancesExchangeQuote.
CurrencyCode (string) --
The currency of the transaction.
IsValidExchange (boolean) --
If true , the exchange is valid. If false , the exchange cannot be completed.
OutputReservedInstancesWillExpireAt (datetime) --
The new end date of the reservation term.
PaymentDue (string) --
The total true upfront charge for the exchange.
ReservedInstanceValueRollup (dict) --
The cost associated with the Reserved Instance.
HourlyPrice (string) --
The hourly rate of the reservation.
RemainingTotalValue (string) --
The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
RemainingUpfrontValue (string) --
The remaining upfront cost of the reservation.
ReservedInstanceValueSet (list) --
The configuration of your Convertible Reserved Instances.
(dict) --
The total value of the Convertible Reserved Instance.
ReservationValue (dict) --
The total value of the Convertible Reserved Instance that you are exchanging.
HourlyPrice (string) --
The hourly rate of the reservation.
RemainingTotalValue (string) --
The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
RemainingUpfrontValue (string) --
The remaining upfront cost of the reservation.
ReservedInstanceId (string) --
The ID of the Convertible Reserved Instance that you are exchanging.
TargetConfigurationValueRollup (dict) --
The cost associated with the Reserved Instance.
HourlyPrice (string) --
The hourly rate of the reservation.
RemainingTotalValue (string) --
The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
RemainingUpfrontValue (string) --
The remaining upfront cost of the reservation.
TargetConfigurationValueSet (list) --
The values of the target Convertible Reserved Instances.
(dict) --
The total value of the new Convertible Reserved Instances.
ReservationValue (dict) --
The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.
HourlyPrice (string) --
The hourly rate of the reservation.
RemainingTotalValue (string) --
The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
RemainingUpfrontValue (string) --
The remaining upfront cost of the reservation.
TargetConfiguration (dict) --
The configuration of the Convertible Reserved Instances that make up the exchange.
InstanceCount (integer) --
The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
OfferingId (string) --
The ID of the Convertible Reserved Instance offering.
ValidationFailureReason (string) --
Describes the reason why the exchange cannot be completed.
Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_serial_console_access_status(
DryRun=True|False
)
{
'SerialConsoleAccessEnabled': True|False
}
Response Structure
If true , access to the EC2 serial console of all instances is enabled for your account. If false , access to the EC2 serial console of all instances is disabled for your account.
Lists the route tables to which the specified resource attachment propagates routes.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_attachment_propagations(
TransitGatewayAttachmentId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the attachment.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayAttachmentPropagations': [
{
'TransitGatewayRouteTableId': 'string',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayAttachmentPropagations (list) --
Information about the propagation route tables.
(dict) --
Describes a propagation route table.
TransitGatewayRouteTableId (string) --
The ID of the propagation route table.
State (string) --
The state of the propagation route table.
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.
Gets information about the associations for the transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_multicast_domain_associations(
TransitGatewayMulticastDomainId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'MulticastDomainAssociations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceOwnerId': 'string',
'Subnet': {
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MulticastDomainAssociations (list) --
Information about the multicast domain associations.
(dict) --
Describes the resources associated with the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the AWS account that owns the transit gateway multicast domain association resource.
Subnet (dict) --
The subnet associated with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
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.
Gets information about the prefix list references in a specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_prefix_list_references(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayPrefixListReferences': [
{
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayPrefixListReferences (list) --
Information about the prefix list references.
(dict) --
Describes a prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
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.
Gets information about the associations for the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_route_table_associations(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'Associations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Associations (list) --
Information about the associations.
(dict) --
Describes an association between a route table and a resource attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the association.
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.
Gets information about the route table propagations for the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.get_transit_gateway_route_table_propagations(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TransitGatewayRouteTablePropagations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TransitGatewayRouteTablePropagations (list) --
Information about the route table propagations.
(dict) --
Describes a route table propagation.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the resource.
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.
Returns an object that can wait for some condition.
Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
See also: AWS API Documentation
Request Syntax
response = client.import_client_vpn_client_certificate_revocation_list(
ClientVpnEndpointId='string',
CertificateRevocationList='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint to which the client certificate revocation list applies.
[REQUIRED]
The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide .
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide .
See also: AWS API Documentation
Request Syntax
response = client.import_image(
Architecture='string',
ClientData={
'Comment': 'string',
'UploadEnd': datetime(2015, 1, 1),
'UploadSize': 123.0,
'UploadStart': datetime(2015, 1, 1)
},
ClientToken='string',
Description='string',
DiskContainers=[
{
'Description': 'string',
'DeviceName': 'string',
'Format': 'string',
'SnapshotId': 'string',
'Url': 'string',
'UserBucket': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
],
DryRun=True|False,
Encrypted=True|False,
Hypervisor='string',
KmsKeyId='string',
LicenseType='string',
Platform='string',
RoleName='string',
LicenseSpecifications=[
{
'LicenseConfigurationArn': 'string'
},
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The architecture of the virtual machine.
Valid values: i386 | x86_64 | arm64
The client-specific data.
A user-defined comment about the disk upload.
The time that the disk upload ends.
The size of the uploaded disk image, in GiB.
The time that the disk upload starts.
Information about the disk containers.
Describes the disk container object for an import image task.
The description of the disk image.
The block device mapping for the disk.
The format of the disk image being imported.
Valid values: OVA | VHD | VHDX | VMDK | RAW
The ID of the EBS snapshot to be used for importing the snapshot.
The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)
The S3 bucket for the disk image.
The name of the Amazon S3 bucket where the disk image is located.
The file name of the disk image.
The target hypervisor platform.
Valid values: xen
An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric CMKs.
The license type to be used for the Amazon Machine Image (AMI) after importing.
By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.
To use BYOL , you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
The operating system of the virtual machine.
Valid values: Windows | Linux
The ARNs of the license configurations.
The request information of license configurations.
The ARN of a license configuration.
The tags to apply to the import image task during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Architecture': 'string',
'Description': 'string',
'Encrypted': True|False,
'Hypervisor': 'string',
'ImageId': 'string',
'ImportTaskId': 'string',
'KmsKeyId': 'string',
'LicenseType': 'string',
'Platform': 'string',
'Progress': 'string',
'SnapshotDetails': [
{
'Description': 'string',
'DeviceName': 'string',
'DiskImageSize': 123.0,
'Format': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'Url': 'string',
'UserBucket': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
],
'Status': 'string',
'StatusMessage': 'string',
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Architecture (string) --
The architecture of the virtual machine.
Description (string) --
A description of the import task.
Encrypted (boolean) --
Indicates whether the AMI is encrypted.
Hypervisor (string) --
The target hypervisor of the import task.
ImageId (string) --
The ID of the Amazon Machine Image (AMI) created by the import task.
ImportTaskId (string) --
The task ID of the import image task.
KmsKeyId (string) --
The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted AMI.
LicenseType (string) --
The license type of the virtual machine.
Platform (string) --
The operating system of the virtual machine.
Progress (string) --
The progress of the task.
SnapshotDetails (list) --
Information about the snapshots.
(dict) --
Describes the snapshot created from the imported disk.
Description (string) --
A description for the snapshot.
DeviceName (string) --
The block device mapping for the snapshot.
DiskImageSize (float) --
The size of the disk in the snapshot, in GiB.
Format (string) --
The format of the disk image from which the snapshot is created.
Progress (string) --
The percentage of progress for the task.
SnapshotId (string) --
The snapshot ID of the disk being imported.
Status (string) --
A brief status of the snapshot creation.
StatusMessage (string) --
A detailed status message for the snapshot creation.
Url (string) --
The URL used to access the disk image.
UserBucket (dict) --
The Amazon S3 bucket for the disk image.
S3Bucket (string) --
The Amazon S3 bucket from which the disk image was created.
S3Key (string) --
The file name of the disk image.
Status (string) --
A brief status of the task.
StatusMessage (string) --
A detailed status message of the import task.
LicenseSpecifications (list) --
The ARNs of the license configurations.
(dict) --
The response information for license configurations.
LicenseConfigurationArn (string) --
The ARN of a license configuration.
Tags (list) --
Any tags assigned to the import image task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates an import instance task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
This API action is not supported by the AWS Command Line Interface (AWS CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest .
See also: AWS API Documentation
Request Syntax
response = client.import_instance(
Description='string',
DiskImages=[
{
'Description': 'string',
'Image': {
'Bytes': 123,
'Format': 'VMDK'|'RAW'|'VHD',
'ImportManifestUrl': 'string'
},
'Volume': {
'Size': 123
}
},
],
DryRun=True|False,
LaunchSpecification={
'AdditionalInfo': 'string',
'Architecture': 'i386'|'x86_64'|'arm64',
'GroupIds': [
'string',
],
'GroupNames': [
'string',
],
'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'Monitoring': True|False,
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
},
'PrivateIpAddress': 'string',
'SubnetId': 'string',
'UserData': {
'Data': 'string'
}
},
Platform='Windows'
)
The disk image.
Describes a disk image.
A description of the disk image.
Information about the disk image.
The size of the disk image, in GiB.
The disk image format.
A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
Information about the volume.
The size of the volume, in GiB.
The launch specification.
Reserved.
The architecture of the instance.
The security group IDs.
The security group names.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.
Indicates whether monitoring is enabled.
The placement information for the instance.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The name of the placement group the instance is in.
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Reserved for future use.
This parameter is not supported by CreateFleet .
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
[EC2-VPC] An available IP address from the IP address range of the subnet.
[EC2-VPC] The ID of the subnet in which to launch the instance.
The Base64-encoded user data to make available to the instance.
The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
[REQUIRED]
The instance operating system.
dict
Response Syntax
{
'ConversionTask': {
'ConversionTaskId': 'string',
'ExpirationTime': 'string',
'ImportInstance': {
'Description': 'string',
'InstanceId': 'string',
'Platform': 'Windows',
'Volumes': [
{
'AvailabilityZone': 'string',
'BytesConverted': 123,
'Description': 'string',
'Image': {
'Checksum': 'string',
'Format': 'VMDK'|'RAW'|'VHD',
'ImportManifestUrl': 'string',
'Size': 123
},
'Status': 'string',
'StatusMessage': 'string',
'Volume': {
'Id': 'string',
'Size': 123
}
},
]
},
'ImportVolume': {
'AvailabilityZone': 'string',
'BytesConverted': 123,
'Description': 'string',
'Image': {
'Checksum': 'string',
'Format': 'VMDK'|'RAW'|'VHD',
'ImportManifestUrl': 'string',
'Size': 123
},
'Volume': {
'Id': 'string',
'Size': 123
}
},
'State': 'active'|'cancelling'|'cancelled'|'completed',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ConversionTask (dict) --
Information about the conversion task.
ConversionTaskId (string) --
The ID of the conversion task.
ExpirationTime (string) --
The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
ImportInstance (dict) --
If the task is for importing an instance, this contains information about the import instance task.
Description (string) --
A description of the task.
InstanceId (string) --
The ID of the instance.
Platform (string) --
The instance operating system.
Volumes (list) --
The volumes.
(dict) --
Describes an import volume task.
AvailabilityZone (string) --
The Availability Zone where the resulting instance will reside.
BytesConverted (integer) --
The number of bytes converted so far.
Description (string) --
A description of the task.
Image (dict) --
The image.
Checksum (string) --
The checksum computed for the disk image.
Format (string) --
The disk image format.
ImportManifestUrl (string) --
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
Size (integer) --
The size of the disk image, in GiB.
Status (string) --
The status of the import of this particular disk image.
StatusMessage (string) --
The status information or errors related to the disk image.
Volume (dict) --
The volume.
Id (string) --
The volume identifier.
Size (integer) --
The size of the volume, in GiB.
ImportVolume (dict) --
If the task is for importing a volume, this contains information about the import volume task.
AvailabilityZone (string) --
The Availability Zone where the resulting volume will reside.
BytesConverted (integer) --
The number of bytes converted so far.
Description (string) --
The description you provided when starting the import volume task.
Image (dict) --
The image.
Checksum (string) --
The checksum computed for the disk image.
Format (string) --
The disk image format.
ImportManifestUrl (string) --
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
Size (integer) --
The size of the disk image, in GiB.
Volume (dict) --
The volume.
Id (string) --
The volume identifier.
Size (integer) --
The size of the volume, in GiB.
State (string) --
The state of the conversion task.
StatusMessage (string) --
The status message related to the conversion task.
Tags (list) --
Any tags assigned to the task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair , in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.import_key_pair(
DryRun=True|False,
KeyName='string',
PublicKeyMaterial=b'bytes',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
A unique name for the key pair.
[REQUIRED]
The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
The tags to apply to the imported key pair.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'KeyFingerprint': 'string',
'KeyName': 'string',
'KeyPairId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
KeyFingerprint (string) --
The MD5 public key fingerprint as specified in section 4 of RFC 4716.
KeyName (string) --
The key pair name that you provided.
KeyPairId (string) --
The ID of the resulting key pair.
Tags (list) --
The tags applied to the imported key pair.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide .
See also: AWS API Documentation
Request Syntax
response = client.import_snapshot(
ClientData={
'Comment': 'string',
'UploadEnd': datetime(2015, 1, 1),
'UploadSize': 123.0,
'UploadStart': datetime(2015, 1, 1)
},
ClientToken='string',
Description='string',
DiskContainer={
'Description': 'string',
'Format': 'string',
'Url': 'string',
'UserBucket': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
DryRun=True|False,
Encrypted=True|False,
KmsKeyId='string',
RoleName='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The client-specific data.
A user-defined comment about the disk upload.
The time that the disk upload ends.
The size of the uploaded disk image, in GiB.
The time that the disk upload starts.
Information about the disk container.
The description of the disk image being imported.
The format of the disk image being imported.
Valid values: VHD | VMDK | RAW
The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).
The Amazon S3 bucket for the disk image.
The name of the Amazon S3 bucket where the disk image is located.
The file name of the disk image.
An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric CMKs.
The tags to apply to the import snapshot task during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Description': 'string',
'ImportTaskId': 'string',
'SnapshotTaskDetail': {
'Description': 'string',
'DiskImageSize': 123.0,
'Encrypted': True|False,
'Format': 'string',
'KmsKeyId': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'Url': 'string',
'UserBucket': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Description (string) --
A description of the import snapshot task.
ImportTaskId (string) --
The ID of the import snapshot task.
SnapshotTaskDetail (dict) --
Information about the import snapshot task.
Description (string) --
The description of the snapshot.
DiskImageSize (float) --
The size of the disk in the snapshot, in GiB.
Encrypted (boolean) --
Indicates whether the snapshot is encrypted.
Format (string) --
The format of the disk image from which the snapshot is created.
KmsKeyId (string) --
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted snapshot.
Progress (string) --
The percentage of completion for the import snapshot task.
SnapshotId (string) --
The snapshot ID of the disk being imported.
Status (string) --
A brief status for the import snapshot task.
StatusMessage (string) --
A detailed status message for the import snapshot task.
Url (string) --
The URL of the disk image from which the snapshot is created.
UserBucket (dict) --
The Amazon S3 bucket for the disk image.
S3Bucket (string) --
The Amazon S3 bucket from which the disk image was created.
S3Key (string) --
The file name of the disk image.
Tags (list) --
Any tags assigned to the import snapshot task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Creates an import volume task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.
This API action is not supported by the AWS Command Line Interface (AWS CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest .
See also: AWS API Documentation
Request Syntax
response = client.import_volume(
AvailabilityZone='string',
Description='string',
DryRun=True|False,
Image={
'Bytes': 123,
'Format': 'VMDK'|'RAW'|'VHD',
'ImportManifestUrl': 'string'
},
Volume={
'Size': 123
}
)
[REQUIRED]
The Availability Zone for the resulting EBS volume.
[REQUIRED]
The disk image.
The size of the disk image, in GiB.
The disk image format.
A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
[REQUIRED]
The volume size.
The size of the volume, in GiB.
dict
Response Syntax
{
'ConversionTask': {
'ConversionTaskId': 'string',
'ExpirationTime': 'string',
'ImportInstance': {
'Description': 'string',
'InstanceId': 'string',
'Platform': 'Windows',
'Volumes': [
{
'AvailabilityZone': 'string',
'BytesConverted': 123,
'Description': 'string',
'Image': {
'Checksum': 'string',
'Format': 'VMDK'|'RAW'|'VHD',
'ImportManifestUrl': 'string',
'Size': 123
},
'Status': 'string',
'StatusMessage': 'string',
'Volume': {
'Id': 'string',
'Size': 123
}
},
]
},
'ImportVolume': {
'AvailabilityZone': 'string',
'BytesConverted': 123,
'Description': 'string',
'Image': {
'Checksum': 'string',
'Format': 'VMDK'|'RAW'|'VHD',
'ImportManifestUrl': 'string',
'Size': 123
},
'Volume': {
'Id': 'string',
'Size': 123
}
},
'State': 'active'|'cancelling'|'cancelled'|'completed',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ConversionTask (dict) --
Information about the conversion task.
ConversionTaskId (string) --
The ID of the conversion task.
ExpirationTime (string) --
The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
ImportInstance (dict) --
If the task is for importing an instance, this contains information about the import instance task.
Description (string) --
A description of the task.
InstanceId (string) --
The ID of the instance.
Platform (string) --
The instance operating system.
Volumes (list) --
The volumes.
(dict) --
Describes an import volume task.
AvailabilityZone (string) --
The Availability Zone where the resulting instance will reside.
BytesConverted (integer) --
The number of bytes converted so far.
Description (string) --
A description of the task.
Image (dict) --
The image.
Checksum (string) --
The checksum computed for the disk image.
Format (string) --
The disk image format.
ImportManifestUrl (string) --
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
Size (integer) --
The size of the disk image, in GiB.
Status (string) --
The status of the import of this particular disk image.
StatusMessage (string) --
The status information or errors related to the disk image.
Volume (dict) --
The volume.
Id (string) --
The volume identifier.
Size (integer) --
The size of the volume, in GiB.
ImportVolume (dict) --
If the task is for importing a volume, this contains information about the import volume task.
AvailabilityZone (string) --
The Availability Zone where the resulting volume will reside.
BytesConverted (integer) --
The number of bytes converted so far.
Description (string) --
The description you provided when starting the import volume task.
Image (dict) --
The image.
Checksum (string) --
The checksum computed for the disk image.
Format (string) --
The disk image format.
ImportManifestUrl (string) --
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .
For information about the import manifest referenced by this API action, see VM Import Manifest .
Size (integer) --
The size of the disk image, in GiB.
Volume (dict) --
The volume.
Id (string) --
The volume identifier.
Size (integer) --
The size of the volume, in GiB.
State (string) --
The state of the conversion task.
StatusMessage (string) --
The status message related to the conversion task.
Tags (list) --
Any tags assigned to the task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications .
See also: AWS API Documentation
Request Syntax
response = client.modify_address_attribute(
AllocationId='string',
DomainName='string',
DryRun=True|False
)
[REQUIRED]
[EC2-VPC] The allocation ID.
dict
Response Syntax
{
'Address': {
'PublicIp': 'string',
'AllocationId': 'string',
'PtrRecord': 'string',
'PtrRecordUpdate': {
'Value': 'string',
'Status': 'string',
'Reason': 'string'
}
}
}
Response Structure
(dict) --
Address (dict) --
Information about the Elastic IP address.
PublicIp (string) --
The public IP address.
AllocationId (string) --
[EC2-VPC] The allocation ID.
PtrRecord (string) --
The pointer (PTR) record for the IP address.
PtrRecordUpdate (dict) --
The updated PTR record for the IP address.
Value (string) --
The value for the PTR record update.
Status (string) --
The status of the PTR record update.
Reason (string) --
The reason for the PTR record update.
Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for GroupName .
See also: AWS API Documentation
Request Syntax
response = client.modify_availability_zone_group(
GroupName='string',
OptInStatus='opted-in'|'not-opted-in',
DryRun=True|False
)
[REQUIRED]
The name of the Availability Zone group, Local Zone group, or Wavelength Zone group.
[REQUIRED]
Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The only valid value is opted-in . You must contact AWS Support to opt out of a Local Zone group, or Wavelength Zone group.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Is true if the request succeeds, and an error otherwise.
Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.
See also: AWS API Documentation
Request Syntax
response = client.modify_capacity_reservation(
CapacityReservationId='string',
InstanceCount=123,
EndDate=datetime(2015, 1, 1),
EndDateType='unlimited'|'limited',
Accept=True|False,
DryRun=True|False
)
[REQUIRED]
The ID of the Capacity Reservation.
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate value if EndDateType is limited . Omit EndDate if EndDateType is unlimited .
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
See also: AWS API Documentation
Request Syntax
response = client.modify_client_vpn_endpoint(
ClientVpnEndpointId='string',
ServerCertificateArn='string',
ConnectionLogOptions={
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string'
},
DnsServers={
'CustomDnsServers': [
'string',
],
'Enabled': True|False
},
VpnPort=123,
Description='string',
SplitTunnel=True|False,
DryRun=True|False,
SecurityGroupIds=[
'string',
],
VpcId='string',
SelfServicePortal='enabled'|'disabled',
ClientConnectOptions={
'Enabled': True|False,
'LambdaFunctionArn': 'string'
}
)
[REQUIRED]
The ID of the Client VPN endpoint to modify.
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Indicates whether connection logging is enabled.
The name of the CloudWatch Logs log group. Required if connection logging is enabled.
The name of the CloudWatch Logs log stream to which the connection data is published.
Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.
Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide .
The IDs of one or more security groups to apply to the target network.
The options for managing connection authorization for new client connections.
Indicates whether client connect options are enabled. The default is false (not enabled).
The Amazon Resource Name (ARN) of the AWS Lambda function used for connection authorization.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_default_credit_specification(
DryRun=True|False,
InstanceFamily='t2'|'t3'|'t3a'|'t4g',
CpuCredits='string'
)
[REQUIRED]
The instance family.
[REQUIRED]
The credit option for CPU usage of the instance family.
Valid Values: standard | unlimited
dict
Response Syntax
{
'InstanceFamilyCreditSpecification': {
'InstanceFamily': 't2'|'t3'|'t3a'|'t4g',
'CpuCredits': 'string'
}
}
Response Structure
(dict) --
InstanceFamilyCreditSpecification (dict) --
The default credit option for CPU usage of the instance family.
InstanceFamily (string) --
The instance family.
CpuCredits (string) --
The default credit option for CPU usage of the instance family. Valid values are standard and unlimited .
Changes the default customer master key (CMK) for EBS encryption by default for your account in this Region.
AWS creates a unique AWS managed CMK in each Region for use with encryption by default. If you change the default CMK to a symmetric customer managed CMK, it is used instead of the AWS managed CMK. To reset the default CMK to the AWS managed CMK for EBS, use ResetEbsDefaultKmsKeyId . Amazon EBS does not support asymmetric CMKs.
If you delete or disable the customer managed CMK that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_ebs_default_kms_key_id(
KmsKeyId='string',
DryRun=True|False
)
[REQUIRED]
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true .
You can specify the CMK using any of the following:
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric CMKs.
dict
Response Syntax
{
'KmsKeyId': 'string'
}
Response Structure
(dict) --
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the default CMK for encryption by default.
Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type maintain .
While the EC2 Fleet is being modified, it is in the modifying state.
To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price , the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified , the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized , EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price , the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized , the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified , the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.
See also: AWS API Documentation
Request Syntax
response = client.modify_fleet(
DryRun=True|False,
ExcessCapacityTerminationPolicy='no-termination'|'termination',
LaunchTemplateConfigs=[
{
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
}
},
]
},
],
FleetId='string',
TargetCapacitySpecification={
'TotalTargetCapacity': 123,
'OnDemandTargetCapacity': 123,
'SpotTargetCapacity': 123,
'DefaultTargetCapacityType': 'spot'|'on-demand'
},
Context='string'
)
The launch template and overrides.
Describes a launch template and overrides.
The launch template to use. You must specify either the launch template ID or launch template name in the request.
The ID of the launch template. If you specify the template ID, you can't specify the template name.
The name of the launch template. If you specify the template name, you can't specify the template ID.
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Any parameters that you specify override the same parameters in the launch template.
For fleets of type request and maintain , a maximum of 300 items is allowed across all launch templates.
Describes overrides for a launch template.
The instance type.
The maximum price per unit hour that you are willing to pay for a Spot Instance.
The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2 ). A request of type instant can have only one subnet ID.
The Availability Zone in which to launch the instances.
The number of units provided by the specified instance type.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The location where the instance launched, if applicable.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The name of the placement group the instance is in.
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Reserved for future use.
This parameter is not supported by CreateFleet .
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
[REQUIRED]
The ID of the EC2 Fleet.
The size of the EC2 Fleet.
The number of units to request, filled using DefaultTargetCapacityType .
The number of On-Demand units to request.
The number of Spot units to request.
The default TotalTargetCapacity , which is either Spot or On-Demand .
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Is true if the request succeeds, and an error otherwise.
Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
See also: AWS API Documentation
Request Syntax
response = client.modify_fpga_image_attribute(
DryRun=True|False,
FpgaImageId='string',
Attribute='description'|'name'|'loadPermission'|'productCodes',
OperationType='add'|'remove',
UserIds=[
'string',
],
UserGroups=[
'string',
],
ProductCodes=[
'string',
],
LoadPermission={
'Add': [
{
'Group': 'all',
'UserId': 'string'
},
],
'Remove': [
{
'Group': 'all',
'UserId': 'string'
},
]
},
Description='string',
Name='string'
)
[REQUIRED]
The ID of the AFI.
The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.
The user groups. This parameter is valid only when modifying the loadPermission attribute.
The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute.
The load permission for the AFI.
The load permissions to add.
Describes a load permission.
The name of the group.
The AWS account ID.
The load permissions to remove.
Describes a load permission.
The name of the group.
The AWS account ID.
dict
Response Syntax
{
'FpgaImageAttribute': {
'FpgaImageId': 'string',
'Name': 'string',
'Description': 'string',
'LoadPermissions': [
{
'UserId': 'string',
'Group': 'all'
},
],
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
]
}
}
Response Structure
(dict) --
FpgaImageAttribute (dict) --
Information about the attribute.
FpgaImageId (string) --
The ID of the AFI.
Name (string) --
The name of the AFI.
Description (string) --
The description of the AFI.
LoadPermissions (list) --
The load permissions.
(dict) --
Describes a load permission.
UserId (string) --
The AWS account ID.
Group (string) --
The name of the group.
ProductCodes (list) --
The product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
See also: AWS API Documentation
Request Syntax
response = client.modify_hosts(
AutoPlacement='on'|'off',
HostIds=[
'string',
],
HostRecovery='on'|'off',
InstanceType='string',
InstanceFamily='string'
)
[REQUIRED]
The IDs of the Dedicated Hosts to modify.
Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.
If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
dict
Response Syntax
{
'Successful': [
'string',
],
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Successful (list) --
The IDs of the Dedicated Hosts that were successfully modified.
Unsuccessful (list) --
The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .
This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide .
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
See also: AWS API Documentation
Request Syntax
response = client.modify_id_format(
Resource='string',
UseLongIds=True|False
)
[REQUIRED]
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
[REQUIRED]
Indicate whether the resource should use longer IDs (17-character IDs).
None
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide .
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
See also: AWS API Documentation
Request Syntax
response = client.modify_identity_id_format(
PrincipalArn='string',
Resource='string',
UseLongIds=True|False
)
[REQUIRED]
The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.
[REQUIRED]
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway .
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
[REQUIRED]
Indicates whether the resource should use longer IDs (17-character IDs)
None
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description , LaunchPermission , or ProductCode .
AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
See also: AWS API Documentation
Request Syntax
response = client.modify_image_attribute(
Attribute='string',
Description={
'Value': 'string'
},
ImageId='string',
LaunchPermission={
'Add': [
{
'Group': 'all',
'UserId': 'string'
},
],
'Remove': [
{
'Group': 'all',
'UserId': 'string'
},
]
},
OperationType='add'|'remove',
ProductCodes=[
'string',
],
UserGroups=[
'string',
],
UserIds=[
'string',
],
Value='string',
DryRun=True|False
)
A new description for the AMI.
The attribute value. The value is case-sensitive.
[REQUIRED]
The ID of the AMI.
A new launch permission for the AMI.
The AWS account ID to add to the list of launch permissions for the AMI.
Describes a launch permission.
The name of the group.
The AWS account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
The AWS account ID to remove from the list of launch permissions for the AMI.
Describes a launch permission.
The name of the group.
The AWS account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
The DevPay product codes. After you add a product code to an AMI, it can't be removed.
The user groups. This parameter can be used only when the Attribute parameter is launchPermission .
The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission .
None
Examples
This example makes the specified AMI public.
response = client.modify_image_attribute(
ImageId='ami-5731123e',
LaunchPermission={
'Add': [
{
'Group': 'all',
},
],
},
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example grants launch permissions for the specified AMI to the specified AWS account.
response = client.modify_image_attribute(
ImageId='ami-5731123e',
LaunchPermission={
'Add': [
{
'UserId': '123456789012',
},
],
},
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modifying attributes of a stopped instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_instance_attribute(
SourceDestCheck={
'Value': True|False
},
Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions',
BlockDeviceMappings=[
{
'DeviceName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'VolumeId': 'string'
},
'NoDevice': 'string',
'VirtualName': 'string'
},
],
DisableApiTermination={
'Value': True|False
},
DryRun=True|False,
EbsOptimized={
'Value': True|False
},
EnaSupport={
'Value': True|False
},
Groups=[
'string',
],
InstanceId='string',
InstanceInitiatedShutdownBehavior={
'Value': 'string'
},
InstanceType={
'Value': 'string'
},
Kernel={
'Value': 'string'
},
Ramdisk={
'Value': 'string'
},
SriovNetSupport={
'Value': 'string'
},
UserData={
'Value': b'bytes'
},
Value='string'
)
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.
The attribute value. The valid values are true or false .
Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination , the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the block device mapping when launching an instance in the Amazon EC2 User Guide .
Describes a block device mapping entry.
The device name (for example, /dev/sdh or xvdh ).
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the volume is deleted on instance termination.
The ID of the EBS volume.
suppress the specified device included in the block device mapping.
The virtual device name.
If the value is true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.
The attribute value. The valid values are true or false .
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
The attribute value. The valid values are true or false .
Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
The attribute value. The valid values are true or false .
[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.
[REQUIRED]
The ID of the instance.
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
The attribute value. The value is case-sensitive.
Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide . If the instance type is not valid, the error returned is InvalidInstanceAttributeValue .
The attribute value. The value is case-sensitive.
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB .
The attribute value. The value is case-sensitive.
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB .
The attribute value. The value is case-sensitive.
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
The attribute value. The value is case-sensitive.
Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
None
Examples
This example modifies the instance type of the specified stopped instance.
response = client.modify_instance_attribute(
InstanceId='i-1234567890abcdef0',
InstanceType={
'Value': 'm5.large',
},
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example enables enhanced networking for the specified stopped instance.
response = client.modify_instance_attribute(
EnaSupport={
'Value': True,
},
InstanceId='i-1234567890abcdef0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.
See also: AWS API Documentation
Request Syntax
response = client.modify_instance_capacity_reservation_attributes(
InstanceId='string',
CapacityReservationSpecification={
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
DryRun=True|False
)
[REQUIRED]
The ID of the instance to be modified.
[REQUIRED]
Information about the Capacity Reservation targeting option.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
Information about the target Capacity Reservation or Capacity Reservation group.
The ID of the Capacity Reservation in which to run the instance.
The ARN of the Capacity Reservation resource group in which to run the instance.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited .
For more information, see Burstable performance instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_instance_credit_specification(
DryRun=True|False,
ClientToken='string',
InstanceCreditSpecifications=[
{
'InstanceId': 'string',
'CpuCredits': 'string'
},
]
)
[REQUIRED]
Information about the credit option for CPU usage.
Describes the credit option for CPU usage of a burstable performance instance.
The ID of the instance.
The credit option for CPU usage of the instance. Valid values are standard and unlimited .
dict
Response Syntax
{
'SuccessfulInstanceCreditSpecifications': [
{
'InstanceId': 'string'
},
],
'UnsuccessfulInstanceCreditSpecifications': [
{
'InstanceId': 'string',
'Error': {
'Code': 'InvalidInstanceID.Malformed'|'InvalidInstanceID.NotFound'|'IncorrectInstanceState'|'InstanceCreditSpecification.NotSupported',
'Message': 'string'
}
},
]
}
Response Structure
(dict) --
SuccessfulInstanceCreditSpecifications (list) --
Information about the instances whose credit option for CPU usage was successfully modified.
(dict) --
Describes the burstable performance instance whose credit option for CPU usage was successfully modified.
InstanceId (string) --
The ID of the instance.
UnsuccessfulInstanceCreditSpecifications (list) --
Information about the instances whose credit option for CPU usage was not modified.
(dict) --
Describes the burstable performance instance whose credit option for CPU usage was not modified.
InstanceId (string) --
The ID of the instance.
Error (dict) --
The applicable error for the burstable performance instance whose credit option for CPU usage was not modified.
Code (string) --
The error code.
Message (string) --
The applicable error message.
Modifies the start time for a scheduled Amazon EC2 instance event.
See also: AWS API Documentation
Request Syntax
response = client.modify_instance_event_start_time(
DryRun=True|False,
InstanceId='string',
InstanceEventId='string',
NotBefore=datetime(2015, 1, 1)
)
[REQUIRED]
The ID of the instance with the scheduled event.
[REQUIRED]
The ID of the event whose date and time you are modifying.
[REQUIRED]
The new date and time when the event will take place.
dict
Response Syntax
{
'Event': {
'InstanceEventId': 'string',
'Code': 'instance-reboot'|'system-reboot'|'system-maintenance'|'instance-retirement'|'instance-stop',
'Description': 'string',
'NotAfter': datetime(2015, 1, 1),
'NotBefore': datetime(2015, 1, 1),
'NotBeforeDeadline': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Event (dict) --
Describes a scheduled event for an instance.
InstanceEventId (string) --
The ID of the event.
Code (string) --
The event code.
Description (string) --
A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
NotAfter (datetime) --
The latest scheduled end time for the event.
NotBefore (datetime) --
The earliest scheduled start time for the event.
NotBeforeDeadline (datetime) --
The deadline for starting the event.
Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_instance_metadata_options(
InstanceId='string',
HttpTokens='optional'|'required',
HttpPutResponseHopLimit=123,
HttpEndpoint='disabled'|'enabled',
DryRun=True|False
)
[REQUIRED]
The ID of the instance.
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the existing state is maintained.
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
dict
Response Syntax
{
'InstanceId': 'string',
'InstanceMetadataOptions': {
'State': 'pending'|'applied',
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
}
}
Response Structure
(dict) --
InstanceId (string) --
The ID of the instance.
InstanceMetadataOptions (dict) --
The metadata options for the instance.
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
Modifies the placement attributes for a specified instance. You can do the following:
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.
See also: AWS API Documentation
Request Syntax
response = client.modify_instance_placement(
Affinity='default'|'host',
GroupName='string',
HostId='string',
InstanceId='string',
Tenancy='dedicated'|'host',
PartitionNumber=123,
HostResourceGroupArn='string'
)
The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default . For cluster and partition placement groups, the instance must have a tenancy of default or dedicated .
To remove an instance from a placement group, specify an empty string ("").
[REQUIRED]
The ID of the instance that you are modifying.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Is true if the request succeeds, and an error otherwise.
Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.
See also: AWS API Documentation
Request Syntax
response = client.modify_launch_template(
DryRun=True|False,
ClientToken='string',
LaunchTemplateId='string',
LaunchTemplateName='string',
DefaultVersion='string'
)
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
Constraint: Maximum 128 ASCII characters.
dict
Response Syntax
{
'LaunchTemplate': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersionNumber': 123,
'LatestVersionNumber': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
LaunchTemplate (dict) --
Information about the launch template.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
CreateTime (datetime) --
The time launch template was created.
CreatedBy (string) --
The principal that created the launch template.
DefaultVersionNumber (integer) --
The version number of the default version of the launch template.
LatestVersionNumber (integer) --
The version number of the latest version of the launch template.
Tags (list) --
The tags for the launch template.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Examples
This example specifies version 2 as the default version of the specified launch template.
response = client.modify_launch_template(
DefaultVersion='2',
LaunchTemplateId='lt-0abcd290751193123',
)
print(response)
Expected Output:
{
'LaunchTemplate': {
'CreateTime': datetime(2017, 12, 1, 13, 35, 46, 4, 335, 0),
'CreatedBy': 'arn:aws:iam::123456789012:root',
'DefaultVersionNumber': 2,
'LatestVersionNumber': 2,
'LaunchTemplateId': 'lt-0abcd290751193123',
'LaunchTemplateName': 'WebServers',
},
'ResponseMetadata': {
'...': '...',
},
}
Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
See also: AWS API Documentation
Request Syntax
response = client.modify_managed_prefix_list(
DryRun=True|False,
PrefixListId='string',
CurrentVersion=123,
PrefixListName='string',
AddEntries=[
{
'Cidr': 'string',
'Description': 'string'
},
],
RemoveEntries=[
{
'Cidr': 'string'
},
]
)
[REQUIRED]
The ID of the prefix list.
One or more entries to add to the prefix list.
An entry for a prefix list.
The CIDR block.
A description for the entry.
Constraints: Up to 255 characters in length.
One or more entries to remove from the prefix list.
An entry for a prefix list.
The CIDR block.
dict
Response Syntax
{
'PrefixList': {
'PrefixListId': 'string',
'AddressFamily': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'PrefixListArn': 'string',
'PrefixListName': 'string',
'MaxEntries': 123,
'Version': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string'
}
}
Response Structure
(dict) --
PrefixList (dict) --
Information about the prefix list.
PrefixListId (string) --
The ID of the prefix list.
AddressFamily (string) --
The IP address version.
State (string) --
The state of the prefix list.
StateMessage (string) --
The state message.
PrefixListArn (string) --
The Amazon Resource Name (ARN) for the prefix list.
PrefixListName (string) --
The name of the prefix list.
MaxEntries (integer) --
The maximum number of entries for the prefix list.
Version (integer) --
The version of the prefix list.
Tags (list) --
The tags for the prefix list.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the owner of the prefix list.
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
response = 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
}
)
Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
The ID of the network interface attachment.
Indicates whether the network interface is deleted when the instance is terminated.
A description for the network interface.
The attribute value. The value is case-sensitive.
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.
[REQUIRED]
The ID of the network interface.
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.
The attribute value. The valid values are true or false .
None
Examples
This example modifies the attachment attribute of the specified network interface.
response = client.modify_network_interface_attribute(
Attachment={
'AttachmentId': 'eni-attach-43348162',
'DeleteOnTermination': False,
},
NetworkInterfaceId='eni-686ea200',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example modifies the description attribute of the specified network interface.
response = client.modify_network_interface_attribute(
Description={
'Value': 'My description',
},
NetworkInterfaceId='eni-686ea200',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example command modifies the groupSet attribute of the specified network interface.
response = client.modify_network_interface_attribute(
Groups=[
'sg-903004f8',
'sg-1a2b3c4d',
],
NetworkInterfaceId='eni-686ea200',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example command modifies the sourceDestCheck attribute of the specified network interface.
response = client.modify_network_interface_attribute(
NetworkInterfaceId='eni-686ea200',
SourceDestCheck={
'Value': False,
},
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_reserved_instances(
ReservedInstancesIds=[
'string',
],
ClientToken='string',
TargetConfigurations=[
{
'AvailabilityZone': 'string',
'InstanceCount': 123,
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'Platform': 'string',
'Scope': 'Availability Zone'|'Region'
},
]
)
[REQUIRED]
The IDs of the Reserved Instances to modify.
[REQUIRED]
The configuration settings for the Reserved Instances to modify.
Describes the configuration settings for the modified Reserved Instances.
The Availability Zone for the modified Reserved Instances.
The number of modified Reserved Instances.
Note
This is a required field for a request.
The instance type for the modified Reserved Instances.
The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
dict
Response Syntax
{
'ReservedInstancesModificationId': 'string'
}
Response Structure
(dict) --
Contains the output of ModifyReservedInstances.
ReservedInstancesModificationId (string) --
The ID for the modification.
Modifies the rules of a security group.
See also: AWS API Documentation
Request Syntax
response = client.modify_security_group_rules(
GroupId='string',
SecurityGroupRules=[
{
'SecurityGroupRuleId': 'string',
'SecurityGroupRule': {
'IpProtocol': 'string',
'FromPort': 123,
'ToPort': 123,
'CidrIpv4': 'string',
'CidrIpv6': 'string',
'PrefixListId': 'string',
'ReferencedGroupId': 'string',
'Description': 'string'
}
},
],
DryRun=True|False
)
[REQUIRED]
The ID of the security group.
[REQUIRED]
Information about the security group properties to update.
Describes an update to a security group rule.
The ID of the security group rule.
Information about the security group rule.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
Use -1 to specify all protocols.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
The ID of the prefix list.
The ID of the security group that is referenced in the security group rule.
The description of the security group rule.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_snapshot_attribute(
Attribute='productCodes'|'createVolumePermission',
CreateVolumePermission={
'Add': [
{
'Group': 'all',
'UserId': 'string'
},
],
'Remove': [
{
'Group': 'all',
'UserId': 'string'
},
]
},
GroupNames=[
'string',
],
OperationType='add'|'remove',
SnapshotId='string',
UserIds=[
'string',
],
DryRun=True|False
)
A JSON representation of the snapshot attribute modification.
Adds the specified AWS account ID or group to the list.
Describes the user or group to be added or removed from the list of create volume permissions for a volume.
The group to be added or removed. The possible value is all .
The AWS account ID to be added or removed.
Removes the specified AWS account ID or group from the list.
Describes the user or group to be added or removed from the list of create volume permissions for a volume.
The group to be added or removed. The possible value is all .
The AWS account ID to be added or removed.
The group to modify for the snapshot.
[REQUIRED]
The ID of the snapshot.
The account ID to modify for the snapshot.
None
Examples
This example modifies snapshot snap-1234567890abcdef0 to remove the create volume permission for a user with the account ID 123456789012. If the command succeeds, no output is returned.
response = client.modify_snapshot_attribute(
Attribute='createVolumePermission',
OperationType='remove',
SnapshotId='snap-1234567890abcdef0',
UserIds=[
'123456789012',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example makes the snapshot snap-1234567890abcdef0 public.
response = client.modify_snapshot_attribute(
Attribute='createVolumePermission',
GroupNames=[
'all',
],
OperationType='add',
SnapshotId='snap-1234567890abcdef0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type maintain .
While the Spot Fleet request is being modified, it is in the modifying state.
To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice , the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified , the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized , Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice , the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized , the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified , the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.
See also: AWS API Documentation
Request Syntax
response = client.modify_spot_fleet_request(
ExcessCapacityTerminationPolicy='noTermination'|'default',
LaunchTemplateConfigs=[
{
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'SpotPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0
},
]
},
],
SpotFleetRequestId='string',
TargetCapacity=123,
OnDemandTargetCapacity=123,
Context='string'
)
The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs ) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.
Describes a launch template and overrides.
The launch template.
The ID of the launch template. If you specify the template ID, you can't specify the template name.
The name of the launch template. If you specify the template name, you can't specify the template ID.
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Any parameters that you specify override the same parameters in the launch template.
Describes overrides for a launch template.
The instance type.
The maximum price per unit hour that you are willing to pay for a Spot Instance.
The ID of the subnet in which to launch the instances.
The Availability Zone in which to launch the instances.
The number of units provided by the specified instance type.
The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized , Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized , Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
[REQUIRED]
The ID of the Spot Fleet request.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Contains the output of ModifySpotFleetRequest.
Return (boolean) --
Is true if the request succeeds, and an error otherwise.
Examples
This example increases the target capacity of the specified Spot fleet request.
response = client.modify_spot_fleet_request(
SpotFleetRequestId='sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
TargetCapacity=20,
)
print(response)
Expected Output:
{
'Return': True,
'ResponseMetadata': {
'...': '...',
},
}
This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result.
response = client.modify_spot_fleet_request(
ExcessCapacityTerminationPolicy='NoTermination ',
SpotFleetRequestId='sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
TargetCapacity=10,
)
print(response)
Expected Output:
{
'Return': True,
'ResponseMetadata': {
'...': '...',
},
}
Modifies a subnet attribute. You can only modify one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = client.modify_subnet_attribute(
AssignIpv6AddressOnCreation={
'Value': True|False
},
MapPublicIpOnLaunch={
'Value': True|False
},
SubnetId='string',
MapCustomerOwnedIpOnLaunch={
'Value': True|False
},
CustomerOwnedIpv4Pool='string'
)
Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API.
The attribute value. The valid values are true or false .
Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
The attribute value. The valid values are true or false .
[REQUIRED]
The ID of the subnet.
Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.
When this value is true , you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool .
The attribute value. The valid values are true or false .
The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true for MapCustomerOwnedIpOnLaunch .
None
Examples
This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.
response = client.modify_subnet_attribute(
MapPublicIpOnLaunch={
'Value': True,
},
SubnetId='subnet-1a2b3c4d',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.
For information about filter rule properties, see Network Services in the Traffic Mirroring User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_traffic_mirror_filter_network_services(
TrafficMirrorFilterId='string',
AddNetworkServices=[
'amazon-dns',
],
RemoveNetworkServices=[
'amazon-dns',
],
DryRun=True|False
)
[REQUIRED]
The ID of the Traffic Mirror filter.
The network service, for example Amazon DNS, that you want to mirror.
The network service, for example Amazon DNS, that you no longer want to mirror.
dict
Response Syntax
{
'TrafficMirrorFilter': {
'TrafficMirrorFilterId': 'string',
'IngressFilterRules': [
{
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
],
'EgressFilterRules': [
{
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
],
'NetworkServices': [
'amazon-dns',
],
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TrafficMirrorFilter (dict) --
The Traffic Mirror filter that the network service is associated with.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
IngressFilterRules (list) --
Information about the ingress rules that are associated with the Traffic Mirror filter.
(dict) --
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
EgressFilterRules (list) --
Information about the egress rules that are associated with the Traffic Mirror filter.
(dict) --
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
NetworkServices (list) --
The network service traffic that is associated with the Traffic Mirror filter.
Description (string) --
The description of the Traffic Mirror filter.
Tags (list) --
The tags assigned to the Traffic Mirror filter.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
See also: AWS API Documentation
Request Syntax
response = client.modify_traffic_mirror_filter_rule(
TrafficMirrorFilterRuleId='string',
TrafficDirection='ingress'|'egress',
RuleNumber=123,
RuleAction='accept'|'reject',
DestinationPortRange={
'FromPort': 123,
'ToPort': 123
},
SourcePortRange={
'FromPort': 123,
'ToPort': 123
},
Protocol=123,
DestinationCidrBlock='string',
SourceCidrBlock='string',
Description='string',
RemoveFields=[
'destination-port-range'|'source-port-range'|'protocol'|'description',
],
DryRun=True|False
)
[REQUIRED]
The ID of the Traffic Mirror rule.
The destination ports that are associated with the Traffic Mirror rule.
The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
The port range to assign to the Traffic Mirror rule.
The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
dict
Response Syntax
{
'TrafficMirrorFilterRule': {
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
TrafficMirrorFilterRule (dict) --
Modifies a Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
Modifies a Traffic Mirror session.
See also: AWS API Documentation
Request Syntax
response = client.modify_traffic_mirror_session(
TrafficMirrorSessionId='string',
TrafficMirrorTargetId='string',
TrafficMirrorFilterId='string',
PacketLength=123,
SessionNumber=123,
VirtualNetworkId=123,
Description='string',
RemoveFields=[
'packet-length'|'description'|'virtual-network-id',
],
DryRun=True|False
)
[REQUIRED]
The ID of the Traffic Mirror session.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
dict
Response Syntax
{
'TrafficMirrorSession': {
'TrafficMirrorSessionId': 'string',
'TrafficMirrorTargetId': 'string',
'TrafficMirrorFilterId': 'string',
'NetworkInterfaceId': 'string',
'OwnerId': 'string',
'PacketLength': 123,
'SessionNumber': 123,
'VirtualNetworkId': 123,
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TrafficMirrorSession (dict) --
Information about the Traffic Mirror session.
TrafficMirrorSessionId (string) --
The ID for the Traffic Mirror session.
TrafficMirrorTargetId (string) --
The ID of the Traffic Mirror target.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
NetworkInterfaceId (string) --
The ID of the Traffic Mirror session's network interface.
OwnerId (string) --
The ID of the account that owns the Traffic Mirror session.
PacketLength (integer) --
The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet
SessionNumber (integer) --
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
VirtualNetworkId (integer) --
The virtual network ID associated with the Traffic Mirror session.
Description (string) --
The description of the Traffic Mirror session.
Tags (list) --
The tags assigned to the Traffic Mirror session.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.
See also: AWS API Documentation
Request Syntax
response = client.modify_transit_gateway(
TransitGatewayId='string',
Description='string',
Options={
'AddTransitGatewayCidrBlocks': [
'string',
],
'RemoveTransitGatewayCidrBlocks': [
'string',
],
'VpnEcmpSupport': 'enable'|'disable',
'DnsSupport': 'enable'|'disable',
'AutoAcceptSharedAttachments': 'enable'|'disable',
'DefaultRouteTableAssociation': 'enable'|'disable',
'AssociationDefaultRouteTableId': 'string',
'DefaultRouteTablePropagation': 'enable'|'disable',
'PropagationDefaultRouteTableId': 'string'
},
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway.
The options to modify.
Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
Removes CIDR blocks for the transit gateway.
Enable or disable Equal Cost Multipath Protocol support.
Enable or disable DNS support.
Enable or disable automatic acceptance of attachment requests.
Enable or disable automatic association with the default association route table.
The ID of the default association route table.
Enable or disable automatic propagation of routes to the default propagation route table.
The ID of the default propagation route table.
dict
Response Syntax
{
'TransitGateway': {
'TransitGatewayId': 'string',
'TransitGatewayArn': 'string',
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'OwnerId': 'string',
'Description': 'string',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'AmazonSideAsn': 123,
'TransitGatewayCidrBlocks': [
'string',
],
'AutoAcceptSharedAttachments': 'enable'|'disable',
'DefaultRouteTableAssociation': 'enable'|'disable',
'AssociationDefaultRouteTableId': 'string',
'DefaultRouteTablePropagation': 'enable'|'disable',
'PropagationDefaultRouteTableId': 'string',
'VpnEcmpSupport': 'enable'|'disable',
'DnsSupport': 'enable'|'disable',
'MulticastSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGateway (dict) --
Describes a transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (string) --
The state of the transit gateway.
OwnerId (string) --
The ID of the AWS account ID that owns the transit gateway.
Description (string) --
The description of the transit gateway.
CreationTime (datetime) --
The creation time.
Options (dict) --
The transit gateway options.
AmazonSideAsn (integer) --
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
TransitGatewayCidrBlocks (list) --
The transit gateway CIDR blocks.
AutoAcceptSharedAttachments (string) --
Indicates whether attachment requests are automatically accepted.
DefaultRouteTableAssociation (string) --
Indicates whether resource attachments are automatically associated with the default association route table.
AssociationDefaultRouteTableId (string) --
The ID of the default association route table.
DefaultRouteTablePropagation (string) --
Indicates whether resource attachments automatically propagate routes to the default propagation route table.
PropagationDefaultRouteTableId (string) --
The ID of the default propagation route table.
VpnEcmpSupport (string) --
Indicates whether Equal Cost Multipath Protocol support is enabled.
DnsSupport (string) --
Indicates whether DNS support is enabled.
MulticastSupport (string) --
Indicates whether multicast is enabled on the transit gateway
Tags (list) --
The tags for the transit gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.modify_transit_gateway_prefix_list_reference(
TransitGatewayRouteTableId='string',
PrefixListId='string',
TransitGatewayAttachmentId='string',
Blackhole=True|False,
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
[REQUIRED]
The ID of the prefix list.
dict
Response Syntax
{
'TransitGatewayPrefixListReference': {
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceId': 'string'
}
}
}
Response Structure
(dict) --
TransitGatewayPrefixListReference (dict) --
Information about the prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
Modifies the specified VPC attachment.
See also: AWS API Documentation
Request Syntax
response = client.modify_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId='string',
AddSubnetIds=[
'string',
],
RemoveSubnetIds=[
'string',
],
Options={
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
DryRun=True|False
)
[REQUIRED]
The ID of the attachment.
The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
The IDs of one or more subnets to remove.
The new VPC attachment options.
Note
You cannot modify the IPv6 options.
Enable or disable DNS support. The default is enable .
Enable or disable IPv6 support. The default is enable .
Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable .
dict
Response Syntax
{
'TransitGatewayVpcAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'VpcId': 'string',
'VpcOwnerId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'SubnetIds': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Options': {
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayVpcAttachment (dict) --
Information about the modified attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
VpcId (string) --
The ID of the VPC.
VpcOwnerId (string) --
The ID of the AWS account that owns the VPC.
State (string) --
The state of the VPC attachment. Note that the initiating state has been deprecated.
SubnetIds (list) --
The IDs of the subnets.
CreationTime (datetime) --
The creation time.
Options (dict) --
The VPC attachment options.
DnsSupport (string) --
Indicates whether DNS support is enabled.
Ipv6Support (string) --
Indicates whether IPv6 support is disabled.
ApplianceModeSupport (string) --
Indicates whether appliance mode support is enabled.
Tags (list) --
The tags for the VPC attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the size, IOPS, or type of an EBS volume on Linux . For more information about modifying an EBS volume running Windows, see Modifying the size, IOPS, or type of an EBS volume on Windows .
When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux file system . For information about extending a Windows file system, see Extending a Windows file system .
You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide . You can also track the status of a modification using DescribeVolumesModifications . For information about tracking status changes using either method, see Monitoring volume modifications .
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Amazon EBS Elastic Volumes (Linux) or Amazon EBS Elastic Volumes (Windows).
If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume.
See also: AWS API Documentation
Request Syntax
response = client.modify_volume(
DryRun=True|False,
VolumeId='string',
Size=123,
VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
Iops=123,
Throughput=123,
MultiAttachEnabled=True|False
)
[REQUIRED]
The ID of the volume.
The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
Default: If no size is specified, the existing size is retained.
The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .
Default: If no type is specified, the existing type is retained.
The target IOPS rate of the volume. This parameter is valid only for gp3 , io1 , and io2 volumes.
The following are the supported values for each volume type:
Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.
Default: If no throughput value is specified, the existing value is retained.
Valid Range: Minimum value of 125. Maximum value of 1000.
dict
Response Syntax
{
'VolumeModification': {
'VolumeId': 'string',
'ModificationState': 'modifying'|'optimizing'|'completed'|'failed',
'StatusMessage': 'string',
'TargetSize': 123,
'TargetIops': 123,
'TargetVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'TargetThroughput': 123,
'TargetMultiAttachEnabled': True|False,
'OriginalSize': 123,
'OriginalIops': 123,
'OriginalVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'OriginalThroughput': 123,
'OriginalMultiAttachEnabled': True|False,
'Progress': 123,
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
VolumeModification (dict) --
Information about the volume modification.
VolumeId (string) --
The ID of the volume.
ModificationState (string) --
The current modification state. The modification state is null for unmodified volumes.
StatusMessage (string) --
A status message about the modification progress or failure.
TargetSize (integer) --
The target size of the volume, in GiB.
TargetIops (integer) --
The target IOPS rate of the volume.
TargetVolumeType (string) --
The target EBS volume type of the volume.
TargetThroughput (integer) --
The target throughput of the volume, in MiB/s.
TargetMultiAttachEnabled (boolean) --
The target setting for Amazon EBS Multi-Attach.
OriginalSize (integer) --
The original size of the volume, in GiB.
OriginalIops (integer) --
The original IOPS rate of the volume.
OriginalVolumeType (string) --
The original EBS volume type of the volume.
OriginalThroughput (integer) --
The original throughput of the volume, in MiB/s.
OriginalMultiAttachEnabled (boolean) --
The original setting for Amazon EBS Multi-Attach.
Progress (integer) --
The modification progress, from 0 to 100 percent complete.
StartTime (datetime) --
The modification start time.
EndTime (datetime) --
The modification completion or failure time.
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
See also: AWS API Documentation
Request Syntax
response = client.modify_volume_attribute(
AutoEnableIO={
'Value': True|False
},
VolumeId='string',
DryRun=True|False
)
Indicates whether the volume should be auto-enabled for I/O operations.
The attribute value. The valid values are true or false .
[REQUIRED]
The ID of the volume.
None
Examples
This example sets the autoEnableIo attribute of the volume with the ID vol-1234567890abcdef0 to true. If the command succeeds, no output is returned.
response = client.modify_volume_attribute(
AutoEnableIO={
'Value': True,
},
DryRun=True,
VolumeId='vol-1234567890abcdef0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Modifies the specified attribute of the specified VPC.
See also: AWS API Documentation
Request Syntax
response = client.modify_vpc_attribute(
EnableDnsHostnames={
'Value': True|False
},
EnableDnsSupport={
'Value': True|False
},
VpcId='string'
)
Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
The attribute value. The valid values are true or false .
Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
The attribute value. The valid values are true or false .
[REQUIRED]
The ID of the VPC.
None
Examples
This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.
response = client.modify_vpc_attribute(
EnableDnsSupport={
'Value': False,
},
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
response = client.modify_vpc_attribute(
EnableDnsHostnames={
'Value': False,
},
VpcId='vpc-a01106c2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_vpc_endpoint(
DryRun=True|False,
VpcEndpointId='string',
ResetPolicy=True|False,
PolicyDocument='string',
AddRouteTableIds=[
'string',
],
RemoveRouteTableIds=[
'string',
],
AddSubnetIds=[
'string',
],
RemoveSubnetIds=[
'string',
],
AddSecurityGroupIds=[
'string',
],
RemoveSecurityGroupIds=[
'string',
],
PrivateDnsEnabled=True|False
)
[REQUIRED]
The ID of the endpoint.
(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
(Interface endpoint) One or more security group IDs to associate with the network interface.
(Interface endpoint) One or more security group IDs to disassociate from the network interface.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.
See also: AWS API Documentation
Request Syntax
response = client.modify_vpc_endpoint_connection_notification(
DryRun=True|False,
ConnectionNotificationId='string',
ConnectionNotificationArn='string',
ConnectionEvents=[
'string',
]
)
[REQUIRED]
The ID of the notification.
One or more events for the endpoint. Valid values are Accept , Connect , Delete , and Reject .
dict
Response Syntax
{
'ReturnValue': True|False
}
Response Structure
(dict) --
ReturnValue (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_vpc_endpoint_service_configuration(
DryRun=True|False,
ServiceId='string',
PrivateDnsName='string',
RemovePrivateDnsName=True|False,
AcceptanceRequired=True|False,
AddNetworkLoadBalancerArns=[
'string',
],
RemoveNetworkLoadBalancerArns=[
'string',
],
AddGatewayLoadBalancerArns=[
'string',
],
RemoveGatewayLoadBalancerArns=[
'string',
]
)
[REQUIRED]
The ID of the service.
The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Modifies the permissions for your VPC endpoint service . You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
See also: AWS API Documentation
Request Syntax
response = client.modify_vpc_endpoint_service_permissions(
DryRun=True|False,
ServiceId='string',
AddAllowedPrincipals=[
'string',
],
RemoveAllowedPrincipals=[
'string',
]
)
[REQUIRED]
The ID of the service.
The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).
The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
dict
Response Syntax
{
'ReturnValue': True|False
}
Response Structure
(dict) --
ReturnValue (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
See also: AWS API Documentation
Request Syntax
response = client.modify_vpc_peering_connection_options(
AccepterPeeringConnectionOptions={
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
DryRun=True|False,
RequesterPeeringConnectionOptions={
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
VpcPeeringConnectionId='string'
)
The VPC peering connection options for the accepter VPC.
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
The VPC peering connection options for the requester VPC.
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
[REQUIRED]
The ID of the VPC peering connection.
dict
Response Syntax
{
'AccepterPeeringConnectionOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'RequesterPeeringConnectionOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
}
}
Response Structure
(dict) --
AccepterPeeringConnectionOptions (dict) --
Information about the VPC peering connection options for the accepter VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
RequesterPeeringConnectionOptions (dict) --
Information about the VPC peering connection options for the requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated .
After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default , unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_vpc_tenancy(
VpcId='string',
InstanceTenancy='default',
DryRun=True|False
)
[REQUIRED]
The ID of the VPC.
[REQUIRED]
The instance tenancy attribute for the VPC.
dict
Response Syntax
{
'ReturnValue': True|False
}
Response Structure
(dict) --
ReturnValue (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
Modifies the customer gateway or the target gateway of an AWS Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in VPN Gateway Target Modification Required VPC Route Table Updates in the AWS Site-to-Site VPN User Guide .
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your AWS Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
See also: AWS API Documentation
Request Syntax
response = client.modify_vpn_connection(
VpnConnectionId='string',
TransitGatewayId='string',
CustomerGatewayId='string',
VpnGatewayId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the VPN connection.
dict
Response Syntax
{
'VpnConnection': {
'CustomerGatewayConfiguration': 'string',
'CustomerGatewayId': 'string',
'Category': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Type': 'ipsec.1',
'VpnConnectionId': 'string',
'VpnGatewayId': 'string',
'TransitGatewayId': 'string',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string'
},
]
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
]
}
}
Response Structure
(dict) --
VpnConnection (dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the AWS side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
See also: AWS API Documentation
Request Syntax
response = client.modify_vpn_connection_options(
VpnConnectionId='string',
LocalIpv4NetworkCidr='string',
RemoteIpv4NetworkCidr='string',
LocalIpv6NetworkCidr='string',
RemoteIpv6NetworkCidr='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Site-to-Site VPN connection.
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
dict
Response Syntax
{
'VpnConnection': {
'CustomerGatewayConfiguration': 'string',
'CustomerGatewayId': 'string',
'Category': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Type': 'ipsec.1',
'VpnConnectionId': 'string',
'VpnGatewayId': 'string',
'TransitGatewayId': 'string',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string'
},
]
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
]
}
}
Response Structure
(dict) --
VpnConnection (dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
Modifies the VPN tunnel endpoint certificate.
See also: AWS API Documentation
Request Syntax
response = client.modify_vpn_tunnel_certificate(
VpnConnectionId='string',
VpnTunnelOutsideIpAddress='string',
DryRun=True|False
)
[REQUIRED]
The ID of the AWS Site-to-Site VPN connection.
[REQUIRED]
The external IP address of the VPN tunnel.
dict
Response Syntax
{
'VpnConnection': {
'CustomerGatewayConfiguration': 'string',
'CustomerGatewayId': 'string',
'Category': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Type': 'ipsec.1',
'VpnConnectionId': 'string',
'VpnGatewayId': 'string',
'TransitGatewayId': 'string',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string'
},
]
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
]
}
}
Response Structure
(dict) --
VpnConnection (dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN Tunnel Options for Your Site-to-Site VPN Connection in the AWS Site-to-Site VPN User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_vpn_tunnel_options(
VpnConnectionId='string',
VpnTunnelOutsideIpAddress='string',
TunnelOptions={
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DPDTimeoutSeconds': 123,
'DPDTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IKEVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string'
},
DryRun=True|False
)
[REQUIRED]
The ID of the AWS Site-to-Site VPN connection.
[REQUIRED]
The external IP address of the VPN tunnel.
[REQUIRED]
The tunnel options to modify.
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds .
Default: 3600
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage .
Constraints: A value between 60 and half of Phase2LifetimeSeconds .
Default: 540
The percentage of the rekey window (determined by RekeyMarginTimeSeconds ) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
The number of seconds after which a DPD timeout occurs.
Constraints: A value between 0 and 30.
Default: 30
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.
The value for the encryption algorithm.
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.
The encryption algorithm.
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.
The value for the integrity algorithm.
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
The integrity algorithm.
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.
The Diffie-Hellmann group number.
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.
The Diffie-Hellmann group number.
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
The IKE version that is permitted for the VPN tunnel.
The IKE version.
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation.
Valid Values: add | start
Default: add
dict
Response Syntax
{
'VpnConnection': {
'CustomerGatewayConfiguration': 'string',
'CustomerGatewayId': 'string',
'Category': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Type': 'ipsec.1',
'VpnConnectionId': 'string',
'VpnGatewayId': 'string',
'TransitGatewayId': 'string',
'Options': {
'EnableAcceleration': True|False,
'StaticRoutesOnly': True|False,
'LocalIpv4NetworkCidr': 'string',
'RemoteIpv4NetworkCidr': 'string',
'LocalIpv6NetworkCidr': 'string',
'RemoteIpv6NetworkCidr': 'string',
'TunnelInsideIpVersion': 'ipv4'|'ipv6',
'TunnelOptions': [
{
'OutsideIpAddress': 'string',
'TunnelInsideCidr': 'string',
'TunnelInsideIpv6Cidr': 'string',
'PreSharedKey': 'string',
'Phase1LifetimeSeconds': 123,
'Phase2LifetimeSeconds': 123,
'RekeyMarginTimeSeconds': 123,
'RekeyFuzzPercentage': 123,
'ReplayWindowSize': 123,
'DpdTimeoutSeconds': 123,
'DpdTimeoutAction': 'string',
'Phase1EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase2EncryptionAlgorithms': [
{
'Value': 'string'
},
],
'Phase1IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase2IntegrityAlgorithms': [
{
'Value': 'string'
},
],
'Phase1DHGroupNumbers': [
{
'Value': 123
},
],
'Phase2DHGroupNumbers': [
{
'Value': 123
},
],
'IkeVersions': [
{
'Value': 'string'
},
],
'StartupAction': 'string'
},
]
},
'Routes': [
{
'DestinationCidrBlock': 'string',
'Source': 'Static',
'State': 'pending'|'available'|'deleting'|'deleted'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VgwTelemetry': [
{
'AcceptedRouteCount': 123,
'LastStatusChange': datetime(2015, 1, 1),
'OutsideIpAddress': 'string',
'Status': 'UP'|'DOWN',
'StatusMessage': 'string',
'CertificateArn': 'string'
},
]
}
}
Response Structure
(dict) --
VpnConnection (dict) --
Describes a VPN connection.
CustomerGatewayConfiguration (string) --
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
CustomerGatewayId (string) --
The ID of the customer gateway at your end of the VPN connection.
Category (string) --
The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
State (string) --
The current state of the VPN connection.
Type (string) --
The type of VPN connection.
VpnConnectionId (string) --
The ID of the VPN connection.
VpnGatewayId (string) --
The ID of the virtual private gateway at the AWS side of the VPN connection.
TransitGatewayId (string) --
The ID of the transit gateway associated with the VPN connection.
Options (dict) --
The VPN connection options.
EnableAcceleration (boolean) --
Indicates whether acceleration is enabled for the VPN connection.
StaticRoutesOnly (boolean) --
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
LocalIpv4NetworkCidr (string) --
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv4NetworkCidr (string) --
The IPv4 CIDR on the AWS side of the VPN connection.
LocalIpv6NetworkCidr (string) --
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
RemoteIpv6NetworkCidr (string) --
The IPv6 CIDR on the AWS side of the VPN connection.
TunnelInsideIpVersion (string) --
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
TunnelOptions (list) --
Indicates the VPN tunnel options.
(dict) --
The VPN tunnel options.
OutsideIpAddress (string) --
The external IP address of the VPN tunnel.
TunnelInsideCidr (string) --
The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr (string) --
The range of inside IPv6 addresses for the tunnel.
PreSharedKey (string) --
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds (integer) --
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2LifetimeSeconds (integer) --
The lifetime for phase 2 of the IKE negotiation, in seconds.
RekeyMarginTimeSeconds (integer) --
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
RekeyFuzzPercentage (integer) --
The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize (integer) --
The number of packets in an IKE replay window.
DpdTimeoutSeconds (integer) --
The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction (string) --
The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The encryption algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the encryption algorithm.
Phase2EncryptionAlgorithms (list) --
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The encryption algorithm for phase 2 IKE negotiations.
Value (string) --
The encryption algorithm.
Phase1IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The integrity algorithm for phase 1 IKE negotiations.
Value (string) --
The value for the integrity algorithm.
Phase2IntegrityAlgorithms (list) --
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The integrity algorithm for phase 2 IKE negotiations.
Value (string) --
The integrity algorithm.
Phase1DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 1 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
Phase2DHGroupNumbers (list) --
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(dict) --
The Diffie-Hellmann group number for phase 2 IKE negotiations.
Value (integer) --
The Diffie-Hellmann group number.
IkeVersions (list) --
The IKE versions that are permitted for the VPN tunnel.
(dict) --
The internet key exchange (IKE) version permitted for the VPN tunnel.
Value (string) --
The IKE version.
StartupAction (string) --
The action to take when the establishing the VPN tunnels for a VPN connection.
Routes (list) --
The static routes associated with the VPN connection.
(dict) --
Describes a static route for a VPN connection.
DestinationCidrBlock (string) --
The CIDR block associated with the local subnet of the customer data center.
Source (string) --
Indicates how the routes were provided.
State (string) --
The current state of the static route.
Tags (list) --
Any tags assigned to the VPN connection.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VgwTelemetry (list) --
Information about the VPN tunnel.
(dict) --
Describes telemetry for a VPN tunnel.
AcceptedRouteCount (integer) --
The number of accepted routes.
LastStatusChange (datetime) --
The date and time of the last change in status.
OutsideIpAddress (string) --
The Internet-routable IP address of the virtual private gateway's outside interface.
Status (string) --
The status of the VPN tunnel.
StatusMessage (string) --
If an error occurs, a description of the error.
CertificateArn (string) --
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
To disable detailed monitoring, see .
See also: AWS API Documentation
Request Syntax
response = client.monitor_instances(
InstanceIds=[
'string',
],
DryRun=True|False
)
[REQUIRED]
The IDs of the instances.
dict
Response Syntax
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
(dict) --
InstanceMonitorings (list) --
The monitoring information.
(dict) --
Describes the monitoring of an instance.
InstanceId (string) --
The ID of the instance.
Monitoring (dict) --
The monitoring for the instance.
State (string) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
See also: AWS API Documentation
Request Syntax
response = client.move_address_to_vpc(
DryRun=True|False,
PublicIp='string'
)
[REQUIRED]
The Elastic IP address.
dict
Response Syntax
{
'AllocationId': 'string',
'Status': 'MoveInProgress'|'InVpc'|'InClassic'
}
Response Structure
(dict) --
AllocationId (string) --
The allocation ID for the Elastic IP address.
Status (string) --
The status of the move of the IP address.
Examples
This example moves the specified Elastic IP address to the EC2-VPC platform.
response = client.move_address_to_vpc(
PublicIp='54.123.4.56',
)
print(response)
Expected Output:
{
'Status': 'MoveInProgress',
'ResponseMetadata': {
'...': '...',
},
}
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr .
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide .
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned . To monitor the status of an address range, use DescribeByoipCidrs . To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
See also: AWS API Documentation
Request Syntax
response = client.provision_byoip_cidr(
Cidr='string',
CidrAuthorizationContext={
'Message': 'string',
'Signature': 'string'
},
PubliclyAdvertisable=True|False,
Description='string',
DryRun=True|False,
PoolTagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiRegion=True|False
)
[REQUIRED]
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've brought to this or another Region.
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
The plain-text authorization message for the prefix and account.
The signed authorization message for the prefix and account.
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
The tags to apply to the address pool.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'Description': 'string',
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address pool.
Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.
See also: AWS API Documentation
Request Syntax
response = client.purchase_host_reservation(
ClientToken='string',
CurrencyCode='USD',
HostIdSet=[
'string',
],
LimitPrice='string',
OfferingId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The IDs of the Dedicated Hosts with which the reservation will be associated.
[REQUIRED]
The ID of the offering.
The tags to apply to the Dedicated Host Reservation during purchase.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'ClientToken': 'string',
'CurrencyCode': 'USD',
'Purchase': [
{
'CurrencyCode': 'USD',
'Duration': 123,
'HostIdSet': [
'string',
],
'HostReservationId': 'string',
'HourlyPrice': 'string',
'InstanceFamily': 'string',
'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
'UpfrontPrice': 'string'
},
],
'TotalHourlyPrice': 'string',
'TotalUpfrontPrice': 'string'
}
Response Structure
(dict) --
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
CurrencyCode (string) --
The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD .
Purchase (list) --
Describes the details of the purchase.
(dict) --
Describes the result of the purchase.
CurrencyCode (string) --
The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD .
Duration (integer) --
The duration of the reservation's term in seconds.
HostIdSet (list) --
The IDs of the Dedicated Hosts associated with the reservation.
HostReservationId (string) --
The ID of the reservation.
HourlyPrice (string) --
The hourly price of the reservation per hour.
InstanceFamily (string) --
The instance family on the Dedicated Host that the reservation can be associated with.
PaymentOption (string) --
The payment option for the reservation.
UpfrontPrice (string) --
The upfront price of the reservation.
TotalHourlyPrice (string) --
The total hourly price of the reservation calculated per hour.
TotalUpfrontPrice (string) --
The total amount charged to your account when you purchase the reservation.
Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances .
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.purchase_reserved_instances_offering(
InstanceCount=123,
ReservedInstancesOfferingId='string',
DryRun=True|False,
LimitPrice={
'Amount': 123.0,
'CurrencyCode': 'USD'
},
PurchaseTime=datetime(2015, 1, 1)
)
[REQUIRED]
The number of Reserved Instances to purchase.
[REQUIRED]
The ID of the Reserved Instance offering to purchase.
Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD .
dict
Response Syntax
{
'ReservedInstancesId': 'string'
}
Response Structure
(dict) --
Contains the output of PurchaseReservedInstancesOffering.
ReservedInstancesId (string) --
The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing pricing tiers in the Amazon Elastic Compute Cloud User Guide .
Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.
See also: AWS API Documentation
Request Syntax
response = client.purchase_scheduled_instances(
ClientToken='string',
DryRun=True|False,
PurchaseRequests=[
{
'InstanceCount': 123,
'PurchaseToken': 'string'
},
]
)
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency .
This field is autopopulated if not provided.
[REQUIRED]
The purchase requests.
Describes a request to purchase Scheduled Instances.
The number of instances.
The purchase token.
dict
Response Syntax
{
'ScheduledInstanceSet': [
{
'AvailabilityZone': 'string',
'CreateDate': datetime(2015, 1, 1),
'HourlyPrice': 'string',
'InstanceCount': 123,
'InstanceType': 'string',
'NetworkPlatform': 'string',
'NextSlotStartTime': datetime(2015, 1, 1),
'Platform': 'string',
'PreviousSlotEndTime': datetime(2015, 1, 1),
'Recurrence': {
'Frequency': 'string',
'Interval': 123,
'OccurrenceDaySet': [
123,
],
'OccurrenceRelativeToEnd': True|False,
'OccurrenceUnit': 'string'
},
'ScheduledInstanceId': 'string',
'SlotDurationInHours': 123,
'TermEndDate': datetime(2015, 1, 1),
'TermStartDate': datetime(2015, 1, 1),
'TotalScheduledInstanceHours': 123
},
]
}
Response Structure
(dict) --
Contains the output of PurchaseScheduledInstances.
ScheduledInstanceSet (list) --
Information about the Scheduled Instances.
(dict) --
Describes a Scheduled Instance.
AvailabilityZone (string) --
The Availability Zone.
CreateDate (datetime) --
The date when the Scheduled Instance was purchased.
HourlyPrice (string) --
The hourly price for a single instance.
InstanceCount (integer) --
The number of instances.
InstanceType (string) --
The instance type.
NetworkPlatform (string) --
The network platform (EC2-Classic or EC2-VPC ).
NextSlotStartTime (datetime) --
The time for the next schedule to start.
Platform (string) --
The platform (Linux/UNIX or Windows ).
PreviousSlotEndTime (datetime) --
The time that the previous schedule ended or will end.
Recurrence (dict) --
The schedule recurrence.
Frequency (string) --
The frequency (Daily , Weekly , or Monthly ).
Interval (integer) --
The interval quantity. The interval unit depends on the value of frequency . For example, every 2 weeks or every 2 months.
OccurrenceDaySet (list) --
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
OccurrenceRelativeToEnd (boolean) --
Indicates whether the occurrence is relative to the end of the specified week or month.
OccurrenceUnit (string) --
The unit for occurrenceDaySet (DayOfWeek or DayOfMonth ).
ScheduledInstanceId (string) --
The Scheduled Instance ID.
SlotDurationInHours (integer) --
The number of hours in the schedule.
TermEndDate (datetime) --
The end date for the Scheduled Instance.
TermStartDate (datetime) --
The start date for the Scheduled Instance.
TotalScheduledInstanceHours (integer) --
The total number of hours for a single instance for the entire term.
Examples
This example purchases a Scheduled Instance.
response = client.purchase_scheduled_instances(
PurchaseRequests=[
{
'InstanceCount': 1,
'PurchaseToken': 'eyJ2IjoiMSIsInMiOjEsImMiOi...',
},
],
)
print(response)
Expected Output:
{
'ScheduledInstanceSet': [
{
'AvailabilityZone': 'us-west-2b',
'CreateDate': datetime(2016, 1, 25, 21, 43, 38, 0, 25, 0),
'HourlyPrice': '0.095',
'InstanceCount': 1,
'InstanceType': 'c4.large',
'NetworkPlatform': 'EC2-VPC',
'NextSlotStartTime': datetime(2016, 1, 31, 9, 0, 0, 6, 31, 0),
'Platform': 'Linux/UNIX',
'Recurrence': {
'Frequency': 'Weekly',
'Interval': 1,
'OccurrenceDaySet': [
1,
],
'OccurrenceRelativeToEnd': False,
'OccurrenceUnit': '',
},
'ScheduledInstanceId': 'sci-1234-1234-1234-1234-123456789012',
'SlotDurationInHours': 32,
'TermEndDate': datetime(2017, 1, 31, 9, 0, 0, 1, 31, 0),
'TermStartDate': datetime(2016, 1, 31, 9, 0, 0, 6, 31, 0),
'TotalScheduledInstanceHours': 1696,
},
],
'ResponseMetadata': {
'...': '...',
},
}
Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.reboot_instances(
InstanceIds=[
'string',
],
DryRun=True|False
)
[REQUIRED]
The instance IDs.
None
Examples
This example reboots the specified EC2 instance.
response = client.reboot_instances(
InstanceIds=[
'i-1234567890abcdef5',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide .
Note
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide .
AWS Marketplace product codes
If any snapshots have AWS Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Obtaining billing information in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.register_image(
ImageLocation='string',
Architecture='i386'|'x86_64'|'arm64',
BlockDeviceMappings=[
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
Description='string',
DryRun=True|False,
EnaSupport=True|False,
KernelId='string',
Name='string',
BillingProducts=[
'string',
],
RamdiskId='string',
RootDeviceName='string',
SriovNetSupport='string',
VirtualizationType='string',
BootMode='legacy-bios'|'uefi'
)
The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386 . For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an EBS volume using the ID of an EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide .
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
[REQUIRED]
A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
The type of virtualization (hvm | paravirtual ).
Default: paravirtual
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
Contains the output of RegisterImage.
ImageId (string) --
The ID of the newly registered AMI.
Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use .
See also: AWS API Documentation
Request Syntax
response = client.register_instance_event_notification_attributes(
DryRun=True|False,
InstanceTagAttribute={
'IncludeAllTagsOfInstance': True|False,
'InstanceTagKeys': [
'string',
]
}
)
Information about the tag keys to register.
Indicates whether to register all tag keys in the current Region. Specify true to register all tag keys.
The tag keys to register.
dict
Response Syntax
{
'InstanceTagAttribute': {
'InstanceTagKeys': [
'string',
],
'IncludeAllTagsOfInstance': True|False
}
}
Response Structure
(dict) --
InstanceTagAttribute (dict) --
The resulting set of tag keys.
InstanceTagKeys (list) --
The registered tag keys.
IncludeAllTagsOfInstance (boolean) --
Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.
Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways .
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
See also: AWS API Documentation
Request Syntax
response = client.register_transit_gateway_multicast_group_members(
TransitGatewayMulticastDomainId='string',
GroupIpAddress='string',
NetworkInterfaceIds=[
'string',
],
DryRun=True|False
)
The group members' network interface IDs to register with the transit gateway multicast group.
dict
Response Syntax
{
'RegisteredMulticastGroupMembers': {
'TransitGatewayMulticastDomainId': 'string',
'RegisteredNetworkInterfaceIds': [
'string',
],
'GroupIpAddress': 'string'
}
}
Response Structure
(dict) --
RegisteredMulticastGroupMembers (dict) --
Information about the registered transit gateway multicast group members.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
RegisteredNetworkInterfaceIds (list) --
The ID of the registered network interfaces.
GroupIpAddress (string) --
The IP address assigned to the transit gateway multicast group.
Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways .
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
See also: AWS API Documentation
Request Syntax
response = client.register_transit_gateway_multicast_group_sources(
TransitGatewayMulticastDomainId='string',
GroupIpAddress='string',
NetworkInterfaceIds=[
'string',
],
DryRun=True|False
)
The group sources' network interface IDs to register with the transit gateway multicast group.
dict
Response Syntax
{
'RegisteredMulticastGroupSources': {
'TransitGatewayMulticastDomainId': 'string',
'RegisteredNetworkInterfaceIds': [
'string',
],
'GroupIpAddress': 'string'
}
}
Response Structure
(dict) --
RegisteredMulticastGroupSources (dict) --
Information about the transit gateway multicast group sources.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
RegisteredNetworkInterfaceIds (list) --
The IDs of the network interfaces members registered with the transit gateway multicast group.
GroupIpAddress (string) --
The IP address assigned to the transit gateway multicast group.
Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
See also: AWS API Documentation
Request Syntax
response = client.reject_transit_gateway_multicast_domain_associations(
TransitGatewayMulticastDomainId='string',
TransitGatewayAttachmentId='string',
SubnetIds=[
'string',
],
DryRun=True|False
)
The IDs of the subnets to associate with the transit gateway multicast domain.
dict
Response Syntax
{
'Associations': {
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceOwnerId': 'string',
'Subnets': [
{
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
},
]
}
}
Response Structure
(dict) --
Associations (dict) --
Describes the multicast domain associations.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the AWS account that owns the resource.
Subnets (list) --
The subnets associated with the multicast domain.
(dict) --
Describes the subnet association with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
Rejects a transit gateway peering attachment request.
See also: AWS API Documentation
Request Syntax
response = client.reject_transit_gateway_peering_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway peering attachment.
dict
Response Syntax
{
'TransitGatewayPeeringAttachment': {
'TransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayPeeringAttachment (dict) --
The transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.
See also: AWS API Documentation
Request Syntax
response = client.reject_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the attachment.
dict
Response Syntax
{
'TransitGatewayVpcAttachment': {
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'VpcId': 'string',
'VpcOwnerId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'SubnetIds': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Options': {
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
TransitGatewayVpcAttachment (dict) --
Information about the attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
VpcId (string) --
The ID of the VPC.
VpcOwnerId (string) --
The ID of the AWS account that owns the VPC.
State (string) --
The state of the VPC attachment. Note that the initiating state has been deprecated.
SubnetIds (list) --
The IDs of the subnets.
CreationTime (datetime) --
The creation time.
Options (dict) --
The VPC attachment options.
DnsSupport (string) --
Indicates whether DNS support is enabled.
Ipv6Support (string) --
Indicates whether IPv6 support is disabled.
ApplianceModeSupport (string) --
Indicates whether appliance mode support is enabled.
Tags (list) --
The tags for the VPC attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
See also: AWS API Documentation
Request Syntax
response = client.reject_vpc_endpoint_connections(
DryRun=True|False,
ServiceId='string',
VpcEndpointIds=[
'string',
]
)
[REQUIRED]
The ID of the service.
[REQUIRED]
The IDs of one or more VPC endpoints.
dict
Response Syntax
{
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
(dict) --
Unsuccessful (list) --
Information about the endpoints that were not rejected, if applicable.
(dict) --
Information about items that were not successfully processed in a batch call.
Error (dict) --
Information about the error.
Code (string) --
The error code.
Message (string) --
The error message accompanying the error code.
ResourceId (string) --
The ID of the resource.
Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection .
See also: AWS API Documentation
Request Syntax
response = client.reject_vpc_peering_connection(
DryRun=True|False,
VpcPeeringConnectionId='string'
)
[REQUIRED]
The ID of the VPC peering connection.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress .
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse ).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress .
See also: AWS API Documentation
Request Syntax
response = client.release_address(
AllocationId='string',
PublicIp='string',
NetworkBorderGroup='string',
DryRun=True|False
)
The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes .
Note
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes .
None
Examples
This example releases an Elastic IP address for use with instances in a VPC.
response = client.release_address(
AllocationId='eipalloc-64d5890a',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example releases an Elastic IP address for use with instances in EC2-Classic.
response = client.release_address(
PublicIp='198.51.100.0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
See also: AWS API Documentation
Request Syntax
response = client.release_hosts(
HostIds=[
'string',
]
)
[REQUIRED]
The IDs of the Dedicated Hosts to release.
{
'Successful': [
'string',
],
'Unsuccessful': [
{
'Error': {
'Code': 'string',
'Message': 'string'
},
'ResourceId': 'string'
},
]
}
Response Structure
The IDs of the Dedicated Hosts that were successfully released.
The IDs of the Dedicated Hosts that could not be released, including an error message.
Information about items that were not successfully processed in a batch call.
Information about the error.
The error code.
The error message accompanying the error code.
The ID of the resource.
Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
See also: AWS API Documentation
Request Syntax
response = client.replace_iam_instance_profile_association(
IamInstanceProfile={
'Arn': 'string',
'Name': 'string'
},
AssociationId='string'
)
[REQUIRED]
The IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
[REQUIRED]
The ID of the existing IAM instance profile association.
dict
Response Syntax
{
'IamInstanceProfileAssociation': {
'AssociationId': 'string',
'InstanceId': 'string',
'IamInstanceProfile': {
'Arn': 'string',
'Id': 'string'
},
'State': 'associating'|'associated'|'disassociating'|'disassociated',
'Timestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
IamInstanceProfileAssociation (dict) --
Information about the IAM instance profile association.
AssociationId (string) --
The ID of the association.
InstanceId (string) --
The ID of the instance.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Id (string) --
The ID of the instance profile.
State (string) --
The state of the association.
Timestamp (datetime) --
The time the IAM instance profile was associated with the instance.
Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
This is an idempotent operation.
See also: AWS API Documentation
Request Syntax
response = client.replace_network_acl_association(
AssociationId='string',
DryRun=True|False,
NetworkAclId='string'
)
[REQUIRED]
The ID of the current association between the original network ACL and the subnet.
[REQUIRED]
The ID of the new network ACL to associate with the subnet.
dict
Response Syntax
{
'NewAssociationId': 'string'
}
Response Structure
(dict) --
NewAssociationId (string) --
The ID of the new association.
Examples
This example associates the specified network ACL with the subnet for the specified network ACL association.
response = client.replace_network_acl_association(
AssociationId='aclassoc-e5b95c8c',
NetworkAclId='acl-5fb85d36',
)
print(response)
Expected Output:
{
'NewAssociationId': 'aclassoc-3999875b',
'ResponseMetadata': {
'...': '...',
},
}
Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.replace_network_acl_entry(
CidrBlock='string',
DryRun=True|False,
Egress=True|False,
IcmpTypeCode={
'Code': 123,
'Type': 123
},
Ipv6CidrBlock='string',
NetworkAclId='string',
PortRange={
'From': 123,
'To': 123
},
Protocol='string',
RuleAction='allow'|'deny',
RuleNumber=123
)
[REQUIRED]
Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
The ICMP code. A value of -1 means all codes for the specified ICMP type.
The ICMP type. A value of -1 means all types.
[REQUIRED]
The ID of the ACL.
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
The first port in the range.
The last port in the range.
[REQUIRED]
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
[REQUIRED]
Indicates whether to allow or deny the traffic that matches the rule.
[REQUIRED]
The rule number of the entry to replace.
None
Examples
This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.
response = client.replace_network_acl_entry(
CidrBlock='203.0.113.12/24',
Egress=False,
NetworkAclId='acl-5fb85d36',
PortRange={
'From': 53,
'To': 53,
},
Protocol='udp',
RuleAction='allow',
RuleNumber=100,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.replace_route(
DestinationCidrBlock='string',
DestinationIpv6CidrBlock='string',
DestinationPrefixListId='string',
DryRun=True|False,
VpcEndpointId='string',
EgressOnlyInternetGatewayId='string',
GatewayId='string',
InstanceId='string',
LocalTarget=True|False,
NatGatewayId='string',
TransitGatewayId='string',
LocalGatewayId='string',
CarrierGatewayId='string',
NetworkInterfaceId='string',
RouteTableId='string',
VpcPeeringConnectionId='string'
)
[REQUIRED]
The ID of the route table.
None
Examples
This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway.
response = client.replace_route(
DestinationCidrBlock='10.0.0.0/16',
GatewayId='vgw-9a4cacf3',
RouteTableId='rtb-22574640',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide .
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.
See also: AWS API Documentation
Request Syntax
response = client.replace_route_table_association(
AssociationId='string',
DryRun=True|False,
RouteTableId='string'
)
[REQUIRED]
The association ID.
[REQUIRED]
The ID of the new route table to associate with the subnet.
dict
Response Syntax
{
'NewAssociationId': 'string',
'AssociationState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failed',
'StatusMessage': 'string'
}
}
Response Structure
(dict) --
NewAssociationId (string) --
The ID of the new association.
AssociationState (dict) --
The state of the association.
State (string) --
The state of the association.
StatusMessage (string) --
The status message, if applicable.
Examples
This example associates the specified route table with the subnet for the specified route table association.
response = client.replace_route_table_association(
AssociationId='rtbassoc-781d0d1a',
RouteTableId='rtb-22574640',
)
print(response)
Expected Output:
{
'NewAssociationId': 'rtbassoc-3a1f0f58',
'ResponseMetadata': {
'...': '...',
},
}
Replaces the specified route in the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.replace_transit_gateway_route(
DestinationCidrBlock='string',
TransitGatewayRouteTableId='string',
TransitGatewayAttachmentId='string',
Blackhole=True|False,
DryRun=True|False
)
[REQUIRED]
The CIDR range used for the destination match. Routing decisions are based on the most specific match.
[REQUIRED]
The ID of the route table.
dict
Response Syntax
{
'Route': {
'DestinationCidrBlock': 'string',
'PrefixListId': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
}
}
Response Structure
(dict) --
Route (dict) --
Information about the modified route.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
PrefixListId (string) --
The ID of the prefix list used for destination matches.
TransitGatewayAttachments (list) --
The attachments.
(dict) --
Describes a route attachment.
ResourceId (string) --
The ID of the resource.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
Type (string) --
The route type.
State (string) --
The state of the route.
Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus , use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus .
See also: AWS API Documentation
Request Syntax
response = client.report_instance_status(
Description='string',
DryRun=True|False,
EndTime=datetime(2015, 1, 1),
Instances=[
'string',
],
ReasonCodes=[
'instance-stuck-in-state'|'unresponsive'|'not-accepting-credentials'|'password-not-available'|'performance-network'|'performance-instance-store'|'performance-ebs-volume'|'performance-other'|'other',
],
StartTime=datetime(2015, 1, 1),
Status='ok'|'impaired'
)
[REQUIRED]
The instances.
[REQUIRED]
The reason codes that describe the health state of your instance.
[REQUIRED]
The status of all instances listed.
None
Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances .
See also: AWS API Documentation
Request Syntax
response = client.request_spot_fleet(
DryRun=True|False,
SpotFleetRequestConfig={
'AllocationStrategy': 'lowestPrice'|'diversified'|'capacityOptimized'|'capacityOptimizedPrioritized',
'OnDemandAllocationStrategy': 'lowestPrice'|'prioritized',
'SpotMaintenanceStrategies': {
'CapacityRebalance': {
'ReplacementStrategy': 'launch'
}
},
'ClientToken': 'string',
'ExcessCapacityTerminationPolicy': 'noTermination'|'default',
'FulfilledCapacity': 123.0,
'OnDemandFulfilledCapacity': 123.0,
'IamFleetRole': 'string',
'LaunchSpecifications': [
{
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'AddressingType': 'string',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'RamdiskId': 'string',
'SpotPrice': 'string',
'SubnetId': 'string',
'UserData': 'string',
'WeightedCapacity': 123.0,
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
],
'LaunchTemplateConfigs': [
{
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'SpotPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0
},
]
},
],
'SpotPrice': 'string',
'TargetCapacity': 123,
'OnDemandTargetCapacity': 123,
'OnDemandMaxTotalPrice': 'string',
'SpotMaxTotalPrice': 'string',
'TerminateInstancesWithExpiration': True|False,
'Type': 'request'|'maintain'|'instant',
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'ReplaceUnhealthyInstances': True|False,
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
'LoadBalancersConfig': {
'ClassicLoadBalancersConfig': {
'ClassicLoadBalancers': [
{
'Name': 'string'
},
]
},
'TargetGroupsConfig': {
'TargetGroups': [
{
'Arn': 'string'
},
]
}
},
'InstancePoolsToUseCount': 123,
'Context': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
)
[REQUIRED]
The configuration for the Spot Fleet request.
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.
If the allocation strategy is lowestPrice , Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified , Spot Fleet launches instances from all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice .
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
The replacement strategy to use. Only available for fleets of type maintain . You must specify a value, otherwise you get an error.
To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for a Spot Instance in the fleet, specify launch .
Note
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency .
Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration .
The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications , you can't specify LaunchTemplateConfigs . If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs .
Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use SpotFleetLaunchSpecification ; you must use LaunchTemplateConfig .
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
Describes a security group.
The name of the security group.
The ID of the security group.
Deprecated.
One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
The IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
The ID of the AMI.
The instance type.
The ID of the kernel.
The name of the key pair.
Enable or disable monitoring for the instances.
Enables monitoring for the instance.
Default: false
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
Note
SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig .
Describes a network interface.
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
The description of the network interface. Applies only if creating a network interface when launching an instance.
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
Describes an IPv6 address.
The IPv6 address.
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
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.
The placement information.
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
The name of the placement group.
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity .
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
The Base64-encoded user data that instances use when starting up.
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
The tags to apply during creation.
The tags for a Spot Fleet resource.
The type of resource. Currently, the only resource type that is supported is instance . To tag the Spot Fleet request on creation, use the TagSpecifications parameter in ` SpotFleetRequestConfigData https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html`__ .
The tags.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The launch template and overrides. If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications . If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs .
Describes a launch template and overrides.
The launch template.
The ID of the launch template. If you specify the template ID, you can't specify the template name.
The name of the launch template. If you specify the template name, you can't specify the template ID.
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Any parameters that you specify override the same parameters in the launch template.
Describes overrides for a launch template.
The instance type.
The maximum price per unit hour that you are willing to pay for a Spot Instance.
The ID of the subnet in which to launch the instances.
The Availability Zone in which to launch the instances.
The number of units provided by the specified instance type.
The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized , Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized , Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain . instant is listed but is not used by Spot Fleet.
The start date and time of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). By default, Amazon EC2 starts fulfilling the request immediately.
The end date and time of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
Indicates whether Spot Fleet should replace unhealthy instances.
The behavior when a Spot Instance is interrupted. The default is terminate .
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
The Classic Load Balancers.
One or more Classic Load Balancers.
Describes a Classic Load Balancer.
The name of the load balancer.
The target groups.
One or more target groups.
Describes a load balancer target group.
The Amazon Resource Name (ARN) of the target group.
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
Reserved.
The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs ) or in the ` SpotFleetTagSpecification https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html`__ (valid only if you use LaunchSpecifications ). For information about tagging after launch, see Tagging Your Resources .
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'SpotFleetRequestId': 'string'
}
Response Structure
(dict) --
Contains the output of RequestSpotFleet.
SpotFleetRequestId (string) --
The ID of the Spot Fleet request.
Examples
This example creates a Spot fleet request with two launch specifications that differ only by subnet. The Spot fleet launches the instances in the specified subnet with the lowest price. If the instances are launched in a default VPC, they receive a public IP address by default. If the instances are launched in a nondefault VPC, they do not receive a public IP address by default. Note that you can't specify different subnets from the same Availability Zone in a Spot fleet request.
response = client.request_spot_fleet(
SpotFleetRequestConfig={
'IamFleetRole': 'arn:aws:iam::123456789012:role/my-spot-fleet-role',
'LaunchSpecifications': [
{
'IamInstanceProfile': {
'Arn': 'arn:aws:iam::123456789012:instance-profile/my-iam-role',
},
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'm3.medium',
'KeyName': 'my-key-pair',
'SecurityGroups': [
{
'GroupId': 'sg-1a2b3c4d',
},
],
'SubnetId': 'subnet-1a2b3c4d, subnet-3c4d5e6f',
},
],
'SpotPrice': '0.04',
'TargetCapacity': 2,
},
)
print(response)
Expected Output:
{
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
'ResponseMetadata': {
'...': '...',
},
}
This example creates a Spot fleet request with two launch specifications that differ only by Availability Zone. The Spot fleet launches the instances in the specified Availability Zone with the lowest price. If your account supports EC2-VPC only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the Availability Zone.
response = client.request_spot_fleet(
SpotFleetRequestConfig={
'IamFleetRole': 'arn:aws:iam::123456789012:role/my-spot-fleet-role',
'LaunchSpecifications': [
{
'IamInstanceProfile': {
'Arn': 'arn:aws:iam::123456789012:instance-profile/my-iam-role',
},
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'm3.medium',
'KeyName': 'my-key-pair',
'Placement': {
'AvailabilityZone': 'us-west-2a, us-west-2b',
},
'SecurityGroups': [
{
'GroupId': 'sg-1a2b3c4d',
},
],
},
],
'SpotPrice': '0.04',
'TargetCapacity': 2,
},
)
print(response)
Expected Output:
{
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
'ResponseMetadata': {
'...': '...',
},
}
This example assigns public addresses to instances launched in a nondefault VPC. Note that when you specify a network interface, you must include the subnet ID and security group ID using the network interface.
response = client.request_spot_fleet(
SpotFleetRequestConfig={
'IamFleetRole': 'arn:aws:iam::123456789012:role/my-spot-fleet-role',
'LaunchSpecifications': [
{
'IamInstanceProfile': {
'Arn': 'arn:aws:iam::880185128111:instance-profile/my-iam-role',
},
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'm3.medium',
'KeyName': 'my-key-pair',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True,
'DeviceIndex': 0,
'Groups': [
'sg-1a2b3c4d',
],
'SubnetId': 'subnet-1a2b3c4d',
},
],
},
],
'SpotPrice': '0.04',
'TargetCapacity': 2,
},
)
print(response)
Expected Output:
{
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
'ResponseMetadata': {
'...': '...',
},
}
This example creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. The launch specifications differ by instance type. The Spot fleet distributes the instances across the launch specifications such that there are 10 instances of each type.
response = client.request_spot_fleet(
SpotFleetRequestConfig={
'AllocationStrategy': 'diversified',
'IamFleetRole': 'arn:aws:iam::123456789012:role/my-spot-fleet-role',
'LaunchSpecifications': [
{
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'c4.2xlarge',
'SubnetId': 'subnet-1a2b3c4d',
},
{
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'm3.2xlarge',
'SubnetId': 'subnet-1a2b3c4d',
},
{
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'r3.2xlarge',
'SubnetId': 'subnet-1a2b3c4d',
},
],
'SpotPrice': '0.70',
'TargetCapacity': 30,
},
)
print(response)
Expected Output:
{
'SpotFleetRequestId': 'sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE',
'ResponseMetadata': {
'...': '...',
},
}
Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances .
See also: AWS API Documentation
Request Syntax
response = client.request_spot_instances(
AvailabilityZoneGroup='string',
BlockDurationMinutes=123,
ClientToken='string',
DryRun=True|False,
InstanceCount=123,
LaunchGroup='string',
LaunchSpecification={
'SecurityGroupIds': [
'string',
],
'SecurityGroups': [
'string',
],
'AddressingType': 'string',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'RamdiskId': 'string',
'SubnetId': 'string',
'UserData': 'string'
},
SpotPrice='string',
Type='one-time'|'persistent',
ValidFrom=datetime(2015, 1, 1),
ValidUntil=datetime(2015, 1, 1),
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
InstanceInterruptionBehavior='hibernate'|'stop'|'terminate'
)
The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
The maximum number of Spot Instances to launch.
Default: 1
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
The launch specification.
One or more security group IDs.
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
Deprecated.
One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
The IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
The ID of the AMI.
The instance type.
The ID of the kernel.
The name of the key pair.
Indicates whether basic or detailed monitoring is enabled for the instance.
Default: Disabled
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
Describes a network interface.
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
The description of the network interface. Applies only if creating a network interface when launching an instance.
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
Describes an IPv6 address.
The IPv6 address.
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
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.
The placement information for the instance.
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
The name of the placement group.
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
The ID of the RAM disk.
The ID of the subnet in which to launch the instance.
The Base64-encoded user data for the instance. User data is limited to 16 KB.
The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
The end date of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z).
The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request , otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags .
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'SpotInstanceRequests': [
{
'ActualBlockHourlyPrice': 'string',
'AvailabilityZoneGroup': 'string',
'BlockDurationMinutes': 123,
'CreateTime': datetime(2015, 1, 1),
'Fault': {
'Code': 'string',
'Message': 'string'
},
'InstanceId': 'string',
'LaunchGroup': 'string',
'LaunchSpecification': {
'UserData': 'string',
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'AddressingType': 'string',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'RamdiskId': 'string',
'SubnetId': 'string',
'Monitoring': {
'Enabled': True|False
}
},
'LaunchedAvailabilityZone': 'string',
'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
'SpotInstanceRequestId': 'string',
'SpotPrice': 'string',
'State': 'open'|'active'|'closed'|'cancelled'|'failed',
'Status': {
'Code': 'string',
'Message': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Type': 'one-time'|'persistent',
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
},
]
}
Response Structure
(dict) --
Contains the output of RequestSpotInstances.
SpotInstanceRequests (list) --
One or more Spot Instance requests.
(dict) --
Describes a Spot Instance request.
ActualBlockHourlyPrice (string) --
Deprecated.
AvailabilityZoneGroup (string) --
The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
BlockDurationMinutes (integer) --
Deprecated.
CreateTime (datetime) --
The date and time when the Spot Instance request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Fault (dict) --
The fault codes for the Spot Instance request, if any.
Code (string) --
The reason code for the Spot Instance state change.
Message (string) --
The message for the Spot Instance state change.
InstanceId (string) --
The instance ID, if an instance has been launched to fulfill the Spot Instance request.
LaunchGroup (string) --
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
LaunchSpecification (dict) --
Additional information for launching instances.
UserData (string) --
The Base64-encoded user data for the instance.
SecurityGroups (list) --
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
AddressingType (string) --
Deprecated.
BlockDeviceMappings (list) --
One or more block device mapping entries.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
ImageId (string) --
The ID of the AMI.
InstanceType (string) --
The instance type.
KernelId (string) --
The ID of the kernel.
KeyName (string) --
The name of the key pair.
NetworkInterfaces (list) --
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
(dict) --
Describes a network interface.
AssociatePublicIpAddress (boolean) --
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
DeleteOnTermination (boolean) --
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
Description (string) --
The description of the network interface. Applies only if creating a network interface when launching an instance.
DeviceIndex (integer) --
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
Groups (list) --
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
Ipv6AddressCount (integer) --
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
Ipv6Addresses (list) --
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
PrivateIpAddress (string) --
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
PrivateIpAddresses (list) --
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
SubnetId (string) --
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
AssociateCarrierIpAddress (boolean) --
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
InterfaceType (string) --
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
NetworkCardIndex (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.
Placement (dict) --
The placement information for the instance.
AvailabilityZone (string) --
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
GroupName (string) --
The name of the placement group.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
RamdiskId (string) --
The ID of the RAM disk.
SubnetId (string) --
The ID of the subnet in which to launch the instance.
Monitoring (dict) --
Describes the monitoring of an instance.
Enabled (boolean) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
LaunchedAvailabilityZone (string) --
The Availability Zone in which the request is launched.
ProductDescription (string) --
The product description associated with the Spot Instance.
SpotInstanceRequestId (string) --
The ID of the Spot Instance request.
SpotPrice (string) --
The maximum price per hour that you are willing to pay for a Spot Instance.
State (string) --
The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot status in the Amazon EC2 User Guide for Linux Instances .
Status (dict) --
The status code and status message describing the Spot Instance request.
Code (string) --
The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances .
Message (string) --
The description for the status code.
UpdateTime (datetime) --
The date and time of the most recent status update, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Type (string) --
The Spot Instance request type.
ValidFrom (datetime) --
The start date of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The request becomes active at this date and time.
ValidUntil (datetime) --
The end date of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z).
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted.
Examples
This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the specified Availability Zone.
response = client.request_spot_instances(
InstanceCount=5,
LaunchSpecification={
'IamInstanceProfile': {
'Arn': 'arn:aws:iam::123456789012:instance-profile/my-iam-role',
},
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'm3.medium',
'KeyName': 'my-key-pair',
'Placement': {
'AvailabilityZone': 'us-west-2a',
},
'SecurityGroupIds': [
'sg-1a2b3c4d',
],
},
SpotPrice='0.03',
Type='one-time',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example command creates a one-time Spot Instance request for five instances in the specified subnet. Amazon EC2 launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances do not receive a public IP address by default.
response = client.request_spot_instances(
InstanceCount=5,
LaunchSpecification={
'IamInstanceProfile': {
'Arn': 'arn:aws:iam::123456789012:instance-profile/my-iam-role',
},
'ImageId': 'ami-1a2b3c4d',
'InstanceType': 'm3.medium',
'SecurityGroupIds': [
'sg-1a2b3c4d',
],
'SubnetId': 'subnet-1a2b3c4d',
},
SpotPrice='0.050',
Type='one-time',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications .
See also: AWS API Documentation
Request Syntax
response = client.reset_address_attribute(
AllocationId='string',
Attribute='domain-name',
DryRun=True|False
)
[REQUIRED]
[EC2-VPC] The allocation ID.
[REQUIRED]
The attribute of the IP address.
dict
Response Syntax
{
'Address': {
'PublicIp': 'string',
'AllocationId': 'string',
'PtrRecord': 'string',
'PtrRecordUpdate': {
'Value': 'string',
'Status': 'string',
'Reason': 'string'
}
}
}
Response Structure
(dict) --
Address (dict) --
Information about the IP address.
PublicIp (string) --
The public IP address.
AllocationId (string) --
[EC2-VPC] The allocation ID.
PtrRecord (string) --
The pointer (PTR) record for the IP address.
PtrRecordUpdate (dict) --
The updated PTR record for the IP address.
Value (string) --
The value for the PTR record update.
Status (string) --
The status of the PTR record update.
Reason (string) --
The reason for the PTR record update.
Resets the default customer master key (CMK) for EBS encryption for your account in this Region to the AWS managed CMK for EBS.
After resetting the default CMK to the AWS managed CMK, you can continue to encrypt by a customer managed CMK by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.reset_ebs_default_kms_key_id(
DryRun=True|False
)
{
'KmsKeyId': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the default CMK for EBS encryption by default.
Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.
See also: AWS API Documentation
Request Syntax
response = client.reset_fpga_image_attribute(
DryRun=True|False,
FpgaImageId='string',
Attribute='loadPermission'
)
[REQUIRED]
The ID of the AFI.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Is true if the request succeeds, and an error otherwise.
Resets an attribute of an AMI to its default value.
Note
The productCodes attribute can't be reset.
See also: AWS API Documentation
Request Syntax
response = client.reset_image_attribute(
Attribute='launchPermission',
ImageId='string',
DryRun=True|False
)
[REQUIRED]
The attribute to reset (currently you can only reset the launch permission attribute).
[REQUIRED]
The ID of the AMI.
None
Examples
This example resets the launchPermission attribute for the specified AMI. By default, AMIs are private.
response = client.reset_image_attribute(
Attribute='launchPermission',
ImageId='ami-5731123e',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk , the instance must be in a stopped state. To reset the sourceDestCheck , the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true , which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide .
See also: AWS API Documentation
Request Syntax
response = client.reset_instance_attribute(
Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions',
DryRun=True|False,
InstanceId='string'
)
[REQUIRED]
The attribute to reset.
Warning
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck . To change an instance attribute, use ModifyInstanceAttribute .
[REQUIRED]
The ID of the instance.
None
Examples
This example resets the sourceDestCheck attribute for the specified instance.
response = client.reset_instance_attribute(
Attribute='sourceDestCheck',
InstanceId='i-1234567890abcdef0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Resets a network interface attribute. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = client.reset_network_interface_attribute(
DryRun=True|False,
NetworkInterfaceId='string',
SourceDestCheck='string'
)
[REQUIRED]
The ID of the network interface.
None
Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = client.reset_snapshot_attribute(
Attribute='productCodes'|'createVolumePermission',
SnapshotId='string',
DryRun=True|False
)
[REQUIRED]
The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.
[REQUIRED]
The ID of the snapshot.
None
Examples
This example resets the create volume permissions for snapshot snap-1234567890abcdef0. If the command succeeds, no output is returned.
response = client.reset_snapshot_attribute(
Attribute='createVolumePermission',
SnapshotId='snap-1234567890abcdef0',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
See also: AWS API Documentation
Request Syntax
response = client.restore_address_to_classic(
DryRun=True|False,
PublicIp='string'
)
[REQUIRED]
The Elastic IP address.
dict
Response Syntax
{
'PublicIp': 'string',
'Status': 'MoveInProgress'|'InVpc'|'InClassic'
}
Response Structure
(dict) --
PublicIp (string) --
The Elastic IP address.
Status (string) --
The move status for the IP address.
Examples
This example restores the specified Elastic IP address to the EC2-Classic platform.
response = client.restore_address_to_classic(
PublicIp='198.51.100.0',
)
print(response)
Expected Output:
{
'PublicIp': '198.51.100.0',
'Status': 'MoveInProgress',
'ResponseMetadata': {
'...': '...',
},
}
Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
See also: AWS API Documentation
Request Syntax
response = client.restore_managed_prefix_list_version(
DryRun=True|False,
PrefixListId='string',
PreviousVersion=123,
CurrentVersion=123
)
[REQUIRED]
The ID of the prefix list.
[REQUIRED]
The version to restore.
[REQUIRED]
The current version number for the prefix list.
dict
Response Syntax
{
'PrefixList': {
'PrefixListId': 'string',
'AddressFamily': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'PrefixListArn': 'string',
'PrefixListName': 'string',
'MaxEntries': 123,
'Version': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string'
}
}
Response Structure
(dict) --
PrefixList (dict) --
Information about the prefix list.
PrefixListId (string) --
The ID of the prefix list.
AddressFamily (string) --
The IP address version.
State (string) --
The state of the prefix list.
StateMessage (string) --
The state message.
PrefixListArn (string) --
The Amazon Resource Name (ARN) for the prefix list.
PrefixListName (string) --
The name of the prefix list.
MaxEntries (integer) --
The maximum number of entries for the prefix list.
Version (integer) --
The version of the prefix list.
Tags (list) --
The tags for the prefix list.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the owner of the prefix list.
Removes an ingress authorization rule from a Client VPN endpoint.
See also: AWS API Documentation
Request Syntax
response = client.revoke_client_vpn_ingress(
ClientVpnEndpointId='string',
TargetNetworkCidr='string',
AccessGroupId='string',
RevokeAllGroups=True|False,
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint with which the authorization rule is associated.
[REQUIRED]
The IPv4 address range, in CIDR notation, of the network for which access is being removed.
dict
Response Syntax
{
'Status': {
'Code': 'authorizing'|'active'|'failed'|'revoking',
'Message': 'string'
}
}
Response Structure
(dict) --
Status (dict) --
The current state of the authorization rule.
Code (string) --
The state of the authorization rule.
Message (string) --
A message about the status of the authorization rule, if applicable.
[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[Default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
See also: AWS API Documentation
Request Syntax
response = client.revoke_security_group_egress(
DryRun=True|False,
GroupId='string',
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
SecurityGroupRuleIds=[
'string',
],
CidrIp='string',
FromPort=123,
IpProtocol='string',
ToPort=123,
SourceSecurityGroupName='string',
SourceSecurityGroupOwnerId='string'
)
[REQUIRED]
The ID of the security group.
The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The IDs of the security group rules.
dict
Response Syntax
{
'Return': True|False,
'UnknownIpPermissions': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
]
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
UnknownIpPermissions (list) --
The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
See also: AWS API Documentation
Request Syntax
response = client.revoke_security_group_ingress(
CidrIp='string',
FromPort=123,
GroupId='string',
GroupName='string',
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
IpProtocol='string',
SourceSecurityGroupName='string',
SourceSecurityGroupOwnerId='string',
ToPort=123,
DryRun=True|False,
SecurityGroupRuleIds=[
'string',
]
)
The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The IDs of the security group rules.
dict
Response Syntax
{
'Return': True|False,
'UnknownIpPermissions': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
]
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
UnknownIpPermissions (list) --
The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
You can create a launch template , which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances , you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances . You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources .
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs .
For troubleshooting, see What to do if an instance immediately terminates , and Troubleshooting connecting to your instance .
See also: AWS API Documentation
Request Syntax
response = client.run_instances(
BlockDeviceMappings=[
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
ImageId='string',
InstanceType='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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
Ipv6AddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string'
},
],
KernelId='string',
KeyName='string',
MaxCount=123,
MinCount=123,
Monitoring={
'Enabled': True|False
},
Placement={
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
},
RamdiskId='string',
SecurityGroupIds=[
'string',
],
SecurityGroups=[
'string',
],
SubnetId='string',
UserData='string',
AdditionalInfo='string',
ClientToken='string',
DisableApiTermination=True|False,
DryRun=True|False,
EbsOptimized=True|False,
IamInstanceProfile={
'Arn': 'string',
'Name': 'string'
},
InstanceInitiatedShutdownBehavior='stop'|'terminate',
NetworkInterfaces=[
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
PrivateIpAddress='string',
ElasticGpuSpecification=[
{
'Type': 'string'
},
],
ElasticInferenceAccelerators=[
{
'Type': 'string',
'Count': 123
},
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
LaunchTemplate={
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
InstanceMarketOptions={
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
CreditSpecification={
'CpuCredits': 'string'
},
CpuOptions={
'CoreCount': 123,
'ThreadsPerCore': 123
},
CapacityReservationSpecification={
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
HibernationOptions={
'Configured': True|False
},
LicenseSpecifications=[
{
'LicenseConfigurationArn': 'string'
},
],
MetadataOptions={
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
EnclaveOptions={
'Enabled': True|False
}
)
The block device mapping entries.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .
Default: m1.small
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
Describes an IPv6 address.
The IPv6 address.
The ID of the kernel.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .
Warning
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
[REQUIRED]
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount .
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
[REQUIRED]
The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
Specifies whether detailed monitoring is enabled for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
The placement for the instance.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The name of the placement group the instance is in.
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Reserved for future use.
This parameter is not supported by CreateFleet .
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .
The IDs of the security groups. You can create a security group using CreateSecurityGroup .
If you specify a network interface, you must specify any security groups as part of the network interface.
[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
[EC2-VPC] The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
The user data to make available to the instance. For more information, see Running commands on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency .
Constraints: Maximum 64 ASCII characters
This field is autopopulated if not provided.
If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.
Default: false
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The name or Amazon Resource Name (ARN) of an IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
Describes a network interface.
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
The description of the network interface. Applies only if creating a network interface when launching an instance.
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
Describes an IPv6 address.
The IPv6 address.
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
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.
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide .
A specification for an Elastic Graphics accelerator.
The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see Elastic Graphics Basics , specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances .
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Describes an elastic inference accelerator.
The type of elastic inference accelerator. The possible values are eia1.medium , eia1.large , eia1.xlarge , eia2.medium , eia2.large , and eia2.xlarge .
The number of elastic inference accelerators to attach to the instance.
Default: 1
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
The ID of the launch template.
The name of the launch template.
The version number of the launch template.
Default: The default version for the launch template.
The market (purchasing) option for the instances.
For RunInstances , persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop .
The market type.
The options for Spot Instances.
The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price.
The Spot Instance request type. For RunInstances , persistent Spot Instance requests are only supported when the instance interruption behavior is either hibernate or stop .
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
You can't specify an Availability Zone group or a launch group if you specify a duration.
New accounts or accounts with no previous billing history with Amazon Web Services are not eligible for Spot Instances with a defined duration (also known as Spot blocks).
The end date of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). Supported only for persistent requests.
The behavior when a Spot Instance is interrupted. The default is terminate .
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited . To change this attribute after launch, use ModifyInstanceCreditSpecification . For more information, see Burstable performance instances in the Amazon EC2 User Guide .
Default: standard (T2 instances) or unlimited (T3/T3a instances)
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon EC2 User Guide .
The number of CPU cores for the instance.
The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1 . Otherwise, specify the default value of 2 .
Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
Information about the target Capacity Reservation or Capacity Reservation group.
The ID of the Capacity Reservation in which to run the instance.
The ARN of the Capacity Reservation resource group in which to run the instance.
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
If you set this parameter to true , your instance is enabled for hibernation.
Default: false
The license configurations.
Describes a license configuration.
The Amazon Resource Name (ARN) of the license configuration.
The metadata options for the instance. For more information, see Instance metadata and user data .
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide .
You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true .
dict
Response Syntax
{
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'Instances': [
{
'AmiLaunchIndex': 123,
'ImageId': 'string',
'InstanceId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'LaunchTime': datetime(2015, 1, 1),
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
},
'Platform': 'Windows',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'PublicDnsName': 'string',
'PublicIpAddress': 'string',
'RamdiskId': 'string',
'State': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'StateTransitionReason': 'string',
'SubnetId': 'string',
'VpcId': 'string',
'Architecture': 'i386'|'x86_64'|'arm64',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'Ebs': {
'AttachTime': datetime(2015, 1, 1),
'DeleteOnTermination': True|False,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'VolumeId': 'string'
}
},
],
'ClientToken': 'string',
'EbsOptimized': True|False,
'EnaSupport': True|False,
'Hypervisor': 'ovm'|'xen',
'IamInstanceProfile': {
'Arn': 'string',
'Id': 'string'
},
'InstanceLifecycle': 'spot'|'scheduled',
'ElasticGpuAssociations': [
{
'ElasticGpuId': 'string',
'ElasticGpuAssociationId': 'string',
'ElasticGpuAssociationState': 'string',
'ElasticGpuAssociationTime': 'string'
},
],
'ElasticInferenceAcceleratorAssociations': [
{
'ElasticInferenceAcceleratorArn': 'string',
'ElasticInferenceAcceleratorAssociationId': 'string',
'ElasticInferenceAcceleratorAssociationState': 'string',
'ElasticInferenceAcceleratorAssociationTime': datetime(2015, 1, 1)
},
],
'NetworkInterfaces': [
{
'Association': {
'CarrierIp': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string'
},
'Attachment': {
'AttachTime': datetime(2015, 1, 1),
'AttachmentId': 'string',
'DeleteOnTermination': True|False,
'DeviceIndex': 123,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'NetworkCardIndex': 123
},
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OwnerId': 'string',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Association': {
'CarrierIp': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string'
},
'Primary': True|False,
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string'
},
],
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'VpcId': 'string',
'InterfaceType': 'string'
},
],
'OutpostArn': 'string',
'RootDeviceName': 'string',
'RootDeviceType': 'ebs'|'instance-store',
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'SourceDestCheck': True|False,
'SpotInstanceRequestId': 'string',
'SriovNetSupport': 'string',
'StateReason': {
'Code': 'string',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VirtualizationType': 'hvm'|'paravirtual',
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationId': 'string',
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'HibernationOptions': {
'Configured': True|False
},
'Licenses': [
{
'LicenseConfigurationArn': 'string'
},
],
'MetadataOptions': {
'State': 'pending'|'applied',
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
},
'BootMode': 'legacy-bios'|'uefi'
},
],
'OwnerId': 'string',
'RequesterId': 'string',
'ReservationId': 'string'
}
Response Structure
(dict) --
Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.
Groups (list) --
[EC2-Classic only] The security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
Instances (list) --
The instances.
(dict) --
Describes an instance.
AmiLaunchIndex (integer) --
The AMI launch index, which can be used to find this instance in the launch group.
ImageId (string) --
The ID of the AMI used to launch the instance.
InstanceId (string) --
The ID of the instance.
InstanceType (string) --
The instance type.
KernelId (string) --
The kernel associated with this instance, if applicable.
KeyName (string) --
The name of the key pair, if this instance was launched with an associated key pair.
LaunchTime (datetime) --
The time the instance was launched.
Monitoring (dict) --
The monitoring for the instance.
State (string) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Placement (dict) --
The location where the instance launched, if applicable.
AvailabilityZone (string) --
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
Affinity (string) --
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
GroupName (string) --
The name of the placement group the instance is in.
PartitionNumber (integer) --
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
HostId (string) --
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
SpreadDomain (string) --
Reserved for future use.
This parameter is not supported by CreateFleet .
HostResourceGroupArn (string) --
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
Platform (string) --
The value is Windows for Windows instances; otherwise blank.
PrivateDnsName (string) --
(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
PrivateIpAddress (string) --
The private IPv4 address assigned to the instance.
ProductCodes (list) --
The product codes attached to this instance, if applicable.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
PublicDnsName (string) --
(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.
PublicIpAddress (string) --
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
RamdiskId (string) --
The RAM disk associated with this instance, if applicable.
State (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
StateTransitionReason (string) --
The reason for the most recent state transition. This might be an empty string.
SubnetId (string) --
[EC2-VPC] The ID of the subnet in which the instance is running.
VpcId (string) --
[EC2-VPC] The ID of the VPC in which the instance is running.
Architecture (string) --
The architecture of the image.
BlockDeviceMappings (list) --
Any block device mapping entries for the instance.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
AttachTime (datetime) --
The time stamp when the attachment initiated.
DeleteOnTermination (boolean) --
Indicates whether the volume is deleted on instance termination.
Status (string) --
The attachment state.
VolumeId (string) --
The ID of the EBS volume.
ClientToken (string) --
The idempotency token you provided when you launched the instance, if applicable.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
EnaSupport (boolean) --
Specifies whether enhanced networking with ENA is enabled.
Hypervisor (string) --
The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.
IamInstanceProfile (dict) --
The IAM instance profile associated with the instance, if applicable.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Id (string) --
The ID of the instance profile.
InstanceLifecycle (string) --
Indicates whether this is a Spot Instance or a Scheduled Instance.
ElasticGpuAssociations (list) --
The Elastic GPU associated with the instance.
(dict) --
Describes the association between an instance and an Elastic Graphics accelerator.
ElasticGpuId (string) --
The ID of the Elastic Graphics accelerator.
ElasticGpuAssociationId (string) --
The ID of the association.
ElasticGpuAssociationState (string) --
The state of the association between the instance and the Elastic Graphics accelerator.
ElasticGpuAssociationTime (string) --
The time the Elastic Graphics accelerator was associated with the instance.
ElasticInferenceAcceleratorAssociations (list) --
The elastic inference accelerator associated with the instance.
(dict) --
Describes the association between an instance and an elastic inference accelerator.
ElasticInferenceAcceleratorArn (string) --
The Amazon Resource Name (ARN) of the elastic inference accelerator.
ElasticInferenceAcceleratorAssociationId (string) --
The ID of the association.
ElasticInferenceAcceleratorAssociationState (string) --
The state of the elastic inference accelerator.
ElasticInferenceAcceleratorAssociationTime (datetime) --
The time at which the elastic inference accelerator is associated with an instance.
NetworkInterfaces (list) --
[EC2-VPC] The network interfaces for the instance.
(dict) --
Describes a network interface.
Association (dict) --
The association information for an Elastic IPv4 associated with the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
IpOwnerId (string) --
The ID of the owner of the Elastic IP address.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The public IP address or Elastic IP address bound to the network interface.
Attachment (dict) --
The network interface attachment.
AttachTime (datetime) --
The time stamp 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 index of the device on the instance for the network interface attachment.
Status (string) --
The attachment state.
NetworkCardIndex (integer) --
The index of the network card.
Description (string) --
The description.
Groups (list) --
One or more security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
Ipv6Addresses (list) --
One or more IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OwnerId (string) --
The ID of the account that created the network interface.
PrivateDnsName (string) --
The private DNS name.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
PrivateIpAddresses (list) --
One or more private IPv4 addresses associated with the network interface.
(dict) --
Describes a private IPv4 address.
Association (dict) --
The association information for an Elastic IP address for the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
IpOwnerId (string) --
The ID of the owner of the Elastic IP address.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The public IP address or Elastic IP address bound to the network interface.
Primary (boolean) --
Indicates whether this IPv4 address is the primary private IP address of the network interface.
PrivateDnsName (string) --
The private IPv4 DNS name.
PrivateIpAddress (string) --
The private IPv4 address of the network interface.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
Status (string) --
The status of the network interface.
SubnetId (string) --
The ID of the subnet.
VpcId (string) --
The ID of the VPC.
InterfaceType (string) --
Describes the type of network interface.
Valid values: interface | efa | trunk
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
RootDeviceName (string) --
The device name of the root device volume (for example, /dev/sda1 ).
RootDeviceType (string) --
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
SecurityGroups (list) --
The security groups for the instance.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
SpotInstanceRequestId (string) --
If the request is a Spot Instance request, the ID of the request.
SriovNetSupport (string) --
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason (dict) --
The reason for the most recent state transition.
Code (string) --
The reason code for the state change.
Message (string) --
The message for the state change.
Tags (list) --
Any tags assigned to the instance.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VirtualizationType (string) --
The virtualization type of the instance.
CpuOptions (dict) --
The CPU options for the instance.
CoreCount (integer) --
The number of CPU cores for the instance.
ThreadsPerCore (integer) --
The number of threads per CPU core.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
CapacityReservationSpecification (dict) --
Information about the Capacity Reservation targeting option.
CapacityReservationPreference (string) --
Describes the instance's Capacity Reservation preferences. Possible preferences include:
CapacityReservationTarget (dict) --
Information about the targeted Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) --
The ID of the targeted Capacity Reservation.
CapacityReservationResourceGroupArn (string) --
The ARN of the targeted Capacity Reservation group.
HibernationOptions (dict) --
Indicates whether the instance is enabled for hibernation.
Configured (boolean) --
If this parameter is set to true , your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
Licenses (list) --
The license configurations.
(dict) --
Describes a license configuration.
LicenseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the license configuration.
MetadataOptions (dict) --
The metadata options for the instance.
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
EnclaveOptions (dict) --
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
BootMode (string) --
The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide .
OwnerId (string) --
The ID of the account that owns the reservation.
RequesterId (string) --
The ID of the requester that launched the instances on your behalf (for example, Management Console or Auto Scaling).
ReservationId (string) --
The ID of the reservation.
Examples
This example launches an instance using the specified AMI, instance type, security group, subnet, block device mapping, and tags.
response = client.run_instances(
BlockDeviceMappings=[
{
'DeviceName': '/dev/sdh',
'Ebs': {
'VolumeSize': 100,
},
},
],
ImageId='ami-abc12345',
InstanceType='t2.micro',
KeyName='my-key-pair',
MaxCount=1,
MinCount=1,
SecurityGroupIds=[
'sg-1a2b3c4d',
],
SubnetId='subnet-6e7f829e',
TagSpecifications=[
{
'ResourceType': 'instance',
'Tags': [
{
'Key': 'Purpose',
'Value': 'test',
},
],
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances .
You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.run_scheduled_instances(
ClientToken='string',
DryRun=True|False,
InstanceCount=123,
LaunchSpecification={
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Encrypted': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'string'
},
'NoDevice': 'string',
'VirtualName': 'string'
},
],
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'ImageId': 'string',
'InstanceType': 'string',
'KernelId': 'string',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddressConfigs': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string'
},
],
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string'
},
'RamdiskId': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetId': 'string',
'UserData': 'string'
},
ScheduledInstanceId='string'
)
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency .
This field is autopopulated if not provided.
The number of instances.
Default: 1
[REQUIRED]
The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.
The block device mapping entries.
Describes a block device mapping for a Scheduled Instance.
The device name (for example, /dev/sdh or xvdh ).
Parameters used to set up EBS volumes automatically when the instance is launched.
Indicates whether the volume is deleted on instance termination.
Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.
The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1 , and 500 IOPS/GiB for io2 . Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide .
This parameter is valid only for Provisioned IOPS SSD (io1 and io2 ) volumes.
The ID of the snapshot.
The size of the volume, in GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, Throughput Optimized HDD for st1 , Cold HDD for sc1 , or standard for Magnetic.
Default: gp2
To omit the device from the block device mapping, specify an empty string.
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The IAM instance profile.
The Amazon Resource Name (ARN).
The name.
The ID of the Amazon Machine Image (AMI).
The instance type.
The ID of the kernel.
The name of the key pair.
Enable or disable monitoring for the instances.
Indicates whether monitoring is enabled.
The network interfaces.
Describes a network interface for a Scheduled Instance.
Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
Indicates whether to delete the interface when the instance is terminated.
The description.
The index of the device for the network interface attachment.
The IDs of the security groups.
The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.
The specific IPv6 addresses from the subnet range.
Describes an IPv6 address.
The IPv6 address.
The ID of the network interface.
The IPv4 address of the network interface within the subnet.
The private IPv4 addresses.
Describes a private IPv4 address for a Scheduled Instance.
Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.
The IPv4 address.
The number of secondary private IPv4 addresses.
The ID of the subnet.
The placement information.
The Availability Zone.
The name of the placement group.
The ID of the RAM disk.
The IDs of the security groups.
The ID of the subnet in which to launch the instances.
The base64-encoded MIME user data.
[REQUIRED]
The Scheduled Instance ID.
dict
Response Syntax
{
'InstanceIdSet': [
'string',
]
}
Response Structure
(dict) --
Contains the output of RunScheduledInstances.
InstanceIdSet (list) --
The IDs of the newly launched instances.
Examples
This example launches the specified Scheduled Instance in a VPC.
response = client.run_scheduled_instances(
InstanceCount=1,
LaunchSpecification={
'IamInstanceProfile': {
'Name': 'my-iam-role',
},
'ImageId': 'ami-12345678',
'InstanceType': 'c4.large',
'KeyName': 'my-key-pair',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True,
'DeviceIndex': 0,
'Groups': [
'sg-12345678',
],
'SubnetId': 'subnet-12345678',
},
],
},
ScheduledInstanceId='sci-1234-1234-1234-1234-123456789012',
)
print(response)
Expected Output:
{
'InstanceIdSet': [
'i-1234567890abcdef0',
],
'ResponseMetadata': {
'...': '...',
},
}
This example launches the specified Scheduled Instance in EC2-Classic.
response = client.run_scheduled_instances(
InstanceCount=1,
LaunchSpecification={
'IamInstanceProfile': {
'Name': 'my-iam-role',
},
'ImageId': 'ami-12345678',
'InstanceType': 'c4.large',
'KeyName': 'my-key-pair',
'Placement': {
'AvailabilityZone': 'us-west-2b',
},
'SecurityGroupIds': [
'sg-12345678',
],
},
ScheduledInstanceId='sci-1234-1234-1234-1234-123456789012',
)
print(response)
Expected Output:
{
'InstanceIdSet': [
'i-1234567890abcdef0',
],
'ResponseMetadata': {
'...': '...',
},
}
Searches for routes in the specified local gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.search_local_gateway_routes(
LocalGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
[REQUIRED]
The ID of the local gateway route table.
[REQUIRED]
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'Routes': [
{
'DestinationCidrBlock': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Routes (list) --
Information about the routes.
(dict) --
Describes a route for a local gateway route table.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
Type (string) --
The route type.
State (string) --
The state of the route.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
OwnerId (string) --
The AWS account ID that owns the local gateway route.
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.
Searches one or more transit gateway multicast groups and returns the group membership information.
See also: AWS API Documentation
Request Syntax
response = client.search_transit_gateway_multicast_groups(
TransitGatewayMulticastDomainId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'MulticastGroups': [
{
'GroupIpAddress': 'string',
'TransitGatewayAttachmentId': 'string',
'SubnetId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceOwnerId': 'string',
'NetworkInterfaceId': 'string',
'GroupMember': True|False,
'GroupSource': True|False,
'MemberType': 'static'|'igmp',
'SourceType': 'static'|'igmp'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MulticastGroups (list) --
Information about the transit gateway multicast group.
(dict) --
Describes the transit gateway multicast group resources.
GroupIpAddress (string) --
The IP address assigned to the transit gateway multicast group.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
SubnetId (string) --
The ID of the subnet.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the AWS account that owns the transit gateway multicast domain group resource.
NetworkInterfaceId (string) --
The ID of the transit gateway attachment.
GroupMember (boolean) --
Indicates that the resource is a transit gateway multicast group member.
GroupSource (boolean) --
Indicates that the resource is a transit gateway multicast group member.
MemberType (string) --
The member type (for example, static ).
SourceType (string) --
The source type.
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.
Searches for routes in the specified transit gateway route table.
See also: AWS API Documentation
Request Syntax
response = client.search_transit_gateway_routes(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
DryRun=True|False
)
[REQUIRED]
The ID of the transit gateway route table.
[REQUIRED]
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'Routes': [
{
'DestinationCidrBlock': 'string',
'PrefixListId': 'string',
'TransitGatewayAttachments': [
{
'ResourceId': 'string',
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'
},
],
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted'
},
],
'AdditionalRoutesAvailable': True|False
}
Response Structure
(dict) --
Routes (list) --
Information about the routes.
(dict) --
Describes a route for a transit gateway route table.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
PrefixListId (string) --
The ID of the prefix list used for destination matches.
TransitGatewayAttachments (list) --
The attachments.
(dict) --
Describes a route attachment.
ResourceId (string) --
The ID of the resource.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
Type (string) --
The route type.
State (string) --
The state of the route.
AdditionalRoutesAvailable (boolean) --
Indicates whether there are additional routes available.
Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen /stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (Linux instances) or Send a Diagnostic Interrupt (Windows instances).
See also: AWS API Documentation
Request Syntax
response = client.send_diagnostic_interrupt(
InstanceId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the instance.
None
Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.start_instances(
InstanceIds=[
'string',
],
AdditionalInfo='string',
DryRun=True|False
)
[REQUIRED]
The IDs of the instances.
dict
Response Syntax
{
'StartingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StartingInstances (list) --
Information about the started instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Examples
This example starts the specified EC2 instance.
response = client.start_instances(
InstanceIds=[
'i-1234567890abcdef0',
],
)
print(response)
Expected Output:
{
'StartingInstances': [
{
'CurrentState': {
'Code': 0,
'Name': 'pending',
},
'InstanceId': 'i-1234567890abcdef0',
'PreviousState': {
'Code': 80,
'Name': 'stopped',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
See also: AWS API Documentation
Request Syntax
response = client.start_network_insights_analysis(
NetworkInsightsPathId='string',
FilterInArns=[
'string',
],
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
[REQUIRED]
The ID of the path.
The Amazon Resource Names (ARN) of the resources that the path must traverse.
The tags to apply.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
[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',
'FilterInArns': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'Status': 'running'|'succeeded'|'failed',
'StatusMessage': 'string',
'NetworkPathFound': True|False,
'ForwardPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Component': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': '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'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
}
},
],
'ReturnPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Component': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': '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'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
}
},
],
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': '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'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string'
}
},
],
'AlternatePathHints': [
{
'ComponentId': 'string',
'ComponentArn': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
NetworkInsightsAnalysis (dict) --
Information about the network insights analysis.
NetworkInsightsAnalysisId (string) --
The ID of the network insights analysis.
NetworkInsightsAnalysisArn (string) --
The Amazon Resource Name (ARN) of the network insights analysis.
NetworkInsightsPathId (string) --
The ID of the path.
FilterInArns (list) --
The Amazon Resource Names (ARN) of the AWS resources that the path must traverse.
StartDate (datetime) --
The time the analysis started.
Status (string) --
The status of the network insights analysis.
StatusMessage (string) --
The status message, if the status is failed .
NetworkPathFound (boolean) --
Indicates whether the destination is reachable from the source.
ForwardPathComponents (list) --
The components in the path from source to destination.
(dict) --
Describes a path component.
SequenceNumber (integer) --
The sequence number.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
OutboundHeader (dict) --
The outbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
InboundHeader (dict) --
The inbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
ReturnPathComponents (list) --
The components in the path from destination to source.
(dict) --
Describes a path component.
SequenceNumber (integer) --
The sequence number.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
OutboundHeader (dict) --
The outbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
InboundHeader (dict) --
The inbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Explanations (list) --
The explanations. For more information, see Reachability Analyzer explanation codes .
(dict) --
Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes .
Acl (dict) --
The network ACL.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Address (string) --
The IPv4 address, in CIDR notation.
Addresses (list) --
The IPv4 addresses, in CIDR notation.
AttachedTo (dict) --
The resource to which the component is attached.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AvailabilityZones (list) --
The Availability Zones.
Cidrs (list) --
The CIDR ranges.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
CustomerGateway (dict) --
The customer gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Destination (dict) --
The destination.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Direction (string) --
The direction. The following are possible values:
ExplanationCode (string) --
The explanation code.
IngressRouteTable (dict) --
The route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
InternetGateway (dict) --
The internet gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
ClassicLoadBalancerListener (dict) --
The listener for a Classic Load Balancer.
LoadBalancerPort (integer) --
The port on which the load balancer is listening.
InstancePort (integer) --
[Classic Load Balancers] The back-end port for the listener.
LoadBalancerListenerPort (integer) --
The listener port of the load balancer.
LoadBalancerTarget (dict) --
The target.
Address (string) --
The IP address.
AvailabilityZone (string) --
The Availability Zone.
Instance (dict) --
Information about the instance.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Port (integer) --
The port on which the target is listening.
LoadBalancerTargetGroup (dict) --
The target group.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerTargetGroups (list) --
The target groups.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerTargetPort (integer) --
The target port.
ElasticLoadBalancerListener (dict) --
The load balancer listener.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
MissingComponent (string) --
The missing component.
NatGateway (dict) --
The NAT gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
NetworkInterface (dict) --
The network interface.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
PacketField (string) --
The packet field.
VpcPeeringConnection (dict) --
The VPC peering connection.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Port (integer) --
The port.
PortRanges (list) --
The port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixList (dict) --
The prefix list.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Protocols (list) --
The protocols.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
RouteTable (dict) --
The route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SecurityGroup (dict) --
The security group.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SecurityGroups (list) --
The security groups.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
State (string) --
The state.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SubnetRouteTable (dict) --
The route table for the subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpcEndpoint (dict) --
The VPC endpoint.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpnConnection (dict) --
The VPN connection.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpnGateway (dict) --
The VPN gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AlternatePathHints (list) --
Potential intermediate components.
(dict) --
Describes an potential intermediate component of a feasible path.
ComponentId (string) --
The ID of the component.
ComponentArn (string) --
The Amazon Resource Name (ARN) of the component.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server. For more information, see Adding a TXT Record to Your Domain's DNS Server in the Amazon VPC User Guide .
See also: AWS API Documentation
Request Syntax
response = client.start_vpc_endpoint_service_private_dns_verification(
DryRun=True|False,
ServiceId='string'
)
[REQUIRED]
The ID of the endpoint service.
dict
Response Syntax
{
'ReturnValue': True|False
}
Response Structure
(dict) --
ReturnValue (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon EC2 User Guide .
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide .
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.stop_instances(
InstanceIds=[
'string',
],
Hibernate=True|False,
DryRun=True|False,
Force=True|False
)
[REQUIRED]
The IDs of the instances.
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
Default: false
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
dict
Response Syntax
{
'StoppingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StoppingInstances (list) --
Information about the stopped instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Examples
This example stops the specified EC2 instance.
response = client.stop_instances(
InstanceIds=[
'i-1234567890abcdef0',
],
)
print(response)
Expected Output:
{
'StoppingInstances': [
{
'CurrentState': {
'Code': 64,
'Name': 'stopping',
},
'InstanceId': 'i-1234567890abcdef0',
'PreviousState': {
'Code': 16,
'Name': 'running',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.
See also: AWS API Documentation
Request Syntax
response = client.terminate_client_vpn_connections(
ClientVpnEndpointId='string',
ConnectionId='string',
Username='string',
DryRun=True|False
)
[REQUIRED]
The ID of the Client VPN endpoint to which the client is connected.
dict
Response Syntax
{
'ClientVpnEndpointId': 'string',
'Username': 'string',
'ConnectionStatuses': [
{
'ConnectionId': 'string',
'PreviousStatus': {
'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated',
'Message': 'string'
},
'CurrentStatus': {
'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated',
'Message': 'string'
}
},
]
}
Response Structure
(dict) --
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
Username (string) --
The user who established the terminated client connections.
ConnectionStatuses (list) --
The current state of the client connections.
(dict) --
Information about a terminated Client VPN endpoint client connection.
ConnectionId (string) --
The ID of the client connection.
PreviousStatus (dict) --
The state of the client connection.
Code (string) --
The state of the client connection.
Message (string) --
A message about the status of the client connection, if applicable.
CurrentStatus (dict) --
A message about the status of the client connection, if applicable.
Code (string) --
The state of the client connection.
Message (string) --
A message about the status of the client connection, if applicable.
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
For example, say you have the following instances:
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.terminate_instances(
InstanceIds=[
'string',
],
DryRun=True|False
)
[REQUIRED]
The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
dict
Response Syntax
{
'TerminatingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
TerminatingInstances (list) --
Information about the terminated instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Examples
This example terminates the specified EC2 instance.
response = client.terminate_instances(
InstanceIds=[
'i-1234567890abcdef0',
],
)
print(response)
Expected Output:
{
'TerminatingInstances': [
{
'CurrentState': {
'Code': 32,
'Name': 'shutting-down',
},
'InstanceId': 'i-1234567890abcdef0',
'PreviousState': {
'Code': 16,
'Name': 'running',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
Unassigns one or more IPv6 addresses from a network interface.
See also: AWS API Documentation
Request Syntax
response = client.unassign_ipv6_addresses(
NetworkInterfaceId='string',
Ipv6Addresses=[
'string',
]
)
[REQUIRED]
The ID of the network interface.
[REQUIRED]
The IPv6 addresses to unassign from the network interface.
dict
Response Syntax
{
'NetworkInterfaceId': 'string',
'UnassignedIpv6Addresses': [
'string',
]
}
Response Structure
(dict) --
NetworkInterfaceId (string) --
The ID of the network interface.
UnassignedIpv6Addresses (list) --
The IPv6 addresses that have been unassigned from the network interface.
Unassigns one or more secondary private IP addresses from a network interface.
See also: AWS API Documentation
Request Syntax
response = client.unassign_private_ip_addresses(
NetworkInterfaceId='string',
PrivateIpAddresses=[
'string',
]
)
[REQUIRED]
The ID of the network interface.
[REQUIRED]
The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
None
Examples
This example unassigns the specified private IP address from the specified network interface.
response = client.unassign_private_ip_addresses(
NetworkInterfaceId='eni-e5aa89a3',
PrivateIpAddresses=[
'10.0.0.82',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = client.unmonitor_instances(
InstanceIds=[
'string',
],
DryRun=True|False
)
[REQUIRED]
The IDs of the instances.
dict
Response Syntax
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
(dict) --
InstanceMonitorings (list) --
The monitoring information.
(dict) --
Describes the monitoring of an instance.
InstanceId (string) --
The ID of the instance.
Monitoring (dict) --
The monitoring for the instance.
State (string) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
See also: AWS API Documentation
Request Syntax
response = client.update_security_group_rule_descriptions_egress(
DryRun=True|False,
GroupId='string',
GroupName='string',
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
SecurityGroupRuleDescriptions=[
{
'SecurityGroupRuleId': 'string',
'Description': 'string'
},
]
)
The IP permissions for the security group rule. You must specify either the IP permissions or the description.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The description for the egress security group rules. You must specify either the description or the IP permissions.
Describes the description of a security group rule.
You can use this when you want to update the security group rule description for either an inbound or outbound rule.
The ID of the security group rule.
The description of the security group rule.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
Examples
This example updates the description for the specified security group rule.
response = client.update_security_group_rule_descriptions_egress(
GroupId='sg-123abc12',
IpPermissions=[
{
'FromPort': 80,
'IpProtocol': 'tcp',
'IpRanges': [
{
'CidrIp': '203.0.113.0/24',
'Description': 'Outbound HTTP access to server 2',
},
],
'ToPort': 80,
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
See also: AWS API Documentation
Request Syntax
response = client.update_security_group_rule_descriptions_ingress(
DryRun=True|False,
GroupId='string',
GroupName='string',
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
SecurityGroupRuleDescriptions=[
{
'SecurityGroupRuleId': 'string',
'Description': 'string'
},
]
)
The IP permissions for the security group rule. You must specify either IP permissions or a description.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
[VPC only] The description for the ingress security group rules. You must specify either a description or IP permissions.
Describes the description of a security group rule.
You can use this when you want to update the security group rule description for either an inbound or outbound rule.
The ID of the security group rule.
The description of the security group rule.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
Examples
This example updates the description for the specified security group rule.
response = client.update_security_group_rule_descriptions_ingress(
GroupId='sg-123abc12',
IpPermissions=[
{
'FromPort': 22,
'IpProtocol': 'tcp',
'IpRanges': [
{
'CidrIp': '203.0.113.0/16',
'Description': 'SSH access from the LA office',
},
],
'ToPort': 22,
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.
See also: AWS API Documentation
Request Syntax
response = client.withdraw_byoip_cidr(
Cidr='string',
DryRun=True|False
)
[REQUIRED]
The address range, in CIDR notation.
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'Description': 'string',
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address pool.
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address pool.
The available paginators are:
paginator = client.get_paginator('describe_addresses_attribute')
Creates an iterator that will paginate through responses from EC2.Client.describe_addresses_attribute().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AllocationIds=[
'string',
],
Attribute='domain-name',
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[EC2-VPC] The allocation IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Addresses': [
{
'PublicIp': 'string',
'AllocationId': 'string',
'PtrRecord': 'string',
'PtrRecordUpdate': {
'Value': 'string',
'Status': 'string',
'Reason': 'string'
}
},
],
}
Response Structure
(dict) --
Addresses (list) --
Information about the IP addresses.
(dict) --
The attributes associated with an Elastic IP address.
PublicIp (string) --
The public IP address.
AllocationId (string) --
[EC2-VPC] The allocation ID.
PtrRecord (string) --
The pointer (PTR) record for the IP address.
PtrRecordUpdate (dict) --
The updated PTR record for the IP address.
Value (string) --
The value for the PTR record update.
Status (string) --
The status of the PTR record update.
Reason (string) --
The reason for the PTR record update.
paginator = client.get_paginator('describe_byoip_cidrs')
Creates an iterator that will paginate through responses from EC2.Client.describe_byoip_cidrs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ByoipCidrs': [
{
'Cidr': 'string',
'Description': 'string',
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
},
],
}
Response Structure
(dict) --
ByoipCidrs (list) --
Information about your address ranges.
(dict) --
Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address pool.
paginator = client.get_paginator('describe_capacity_reservations')
Creates an iterator that will paginate through responses from EC2.Client.describe_capacity_reservations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CapacityReservationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the Capacity Reservation.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CapacityReservations': [
{
'CapacityReservationId': 'string',
'OwnerId': 'string',
'CapacityReservationArn': 'string',
'AvailabilityZoneId': 'string',
'InstanceType': 'string',
'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
'AvailabilityZone': 'string',
'Tenancy': 'default'|'dedicated',
'TotalInstanceCount': 123,
'AvailableInstanceCount': 123,
'EbsOptimized': True|False,
'EphemeralStorage': True|False,
'State': 'active'|'expired'|'cancelled'|'pending'|'failed',
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1),
'EndDateType': 'unlimited'|'limited',
'InstanceMatchCriteria': 'open'|'targeted',
'CreateDate': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OutpostArn': 'string'
},
]
}
Response Structure
(dict) --
CapacityReservations (list) --
Information about the Capacity Reservations.
(dict) --
Describes a Capacity Reservation.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
OwnerId (string) --
The ID of the account that owns the Capacity Reservation.
CapacityReservationArn (string) --
The Amazon Resource Name (ARN) of the Capacity Reservation.
AvailabilityZoneId (string) --
The Availability Zone ID of the Capacity Reservation.
InstanceType (string) --
The type of instance for which the Capacity Reservation reserves capacity.
InstancePlatform (string) --
The type of operating system for which the Capacity Reservation reserves capacity.
AvailabilityZone (string) --
The Availability Zone in which the capacity is reserved.
Tenancy (string) --
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
TotalInstanceCount (integer) --
The total number of instances for which the Capacity Reservation reserves capacity.
AvailableInstanceCount (integer) --
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
EbsOptimized (boolean) --
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
EphemeralStorage (boolean) --
Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
State (string) --
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
StartDate (datetime) --
The date and time at which the Capacity Reservation was started.
EndDate (datetime) --
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
EndDateType (string) --
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
InstanceMatchCriteria (string) --
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
CreateDate (datetime) --
The date and time at which the Capacity Reservation was created.
Tags (list) --
Any tags assigned to the Capacity Reservation.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
paginator = client.get_paginator('describe_carrier_gateways')
Creates an iterator that will paginate through responses from EC2.Client.describe_carrier_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CarrierGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more carrier gateway IDs.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CarrierGateways': [
{
'CarrierGatewayId': 'string',
'VpcId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
CarrierGateways (list) --
Information about the carrier gateway.
(dict) --
Describes a carrier gateway.
CarrierGatewayId (string) --
The ID of the carrier gateway.
VpcId (string) --
The ID of the VPC associated with the carrier gateway.
State (string) --
The state of the carrier gateway.
OwnerId (string) --
The AWS account ID of the owner of the carrier gateway.
Tags (list) --
The tags assigned to the carrier gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_classic_link_instances')
Creates an iterator that will paginate through responses from EC2.Client.describe_classic_link_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
InstanceIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Instances': [
{
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InstanceId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
],
}
Response Structure
(dict) --
Instances (list) --
Information about one or more linked EC2-Classic instances.
(dict) --
Describes a linked EC2-Classic instance.
Groups (list) --
A list of security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
InstanceId (string) --
The ID of the instance.
Tags (list) --
Any tags assigned to the instance.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
paginator = client.get_paginator('describe_client_vpn_authorization_rules')
Creates an iterator that will paginate through responses from EC2.Client.describe_client_vpn_authorization_rules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClientVpnEndpointId='string',
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the Client VPN endpoint.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AuthorizationRules': [
{
'ClientVpnEndpointId': 'string',
'Description': 'string',
'GroupId': 'string',
'AccessAll': True|False,
'DestinationCidr': 'string',
'Status': {
'Code': 'authorizing'|'active'|'failed'|'revoking',
'Message': 'string'
}
},
],
}
Response Structure
(dict) --
AuthorizationRules (list) --
Information about the authorization rules.
(dict) --
Information about an authorization rule.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint with which the authorization rule is associated.
Description (string) --
A brief description of the authorization rule.
GroupId (string) --
The ID of the Active Directory group to which the authorization rule grants access.
AccessAll (boolean) --
Indicates whether the authorization rule grants access to all clients.
DestinationCidr (string) --
The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
Status (dict) --
The current state of the authorization rule.
Code (string) --
The state of the authorization rule.
Message (string) --
A message about the status of the authorization rule, if applicable.
paginator = client.get_paginator('describe_client_vpn_connections')
Creates an iterator that will paginate through responses from EC2.Client.describe_client_vpn_connections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClientVpnEndpointId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the Client VPN endpoint.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Connections': [
{
'ClientVpnEndpointId': 'string',
'Timestamp': 'string',
'ConnectionId': 'string',
'Username': 'string',
'ConnectionEstablishedTime': 'string',
'IngressBytes': 'string',
'EgressBytes': 'string',
'IngressPackets': 'string',
'EgressPackets': 'string',
'ClientIp': 'string',
'CommonName': 'string',
'Status': {
'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated',
'Message': 'string'
},
'ConnectionEndTime': 'string',
'PostureComplianceStatuses': [
'string',
]
},
],
}
Response Structure
(dict) --
Connections (list) --
Information about the active and terminated client connections.
(dict) --
Describes a client connection.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint to which the client is connected.
Timestamp (string) --
The current date and time.
ConnectionId (string) --
The ID of the client connection.
Username (string) --
The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.
ConnectionEstablishedTime (string) --
The date and time the client connection was established.
IngressBytes (string) --
The number of bytes sent by the client.
EgressBytes (string) --
The number of bytes received by the client.
IngressPackets (string) --
The number of packets sent by the client.
EgressPackets (string) --
The number of packets received by the client.
ClientIp (string) --
The IP address of the client.
CommonName (string) --
The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.
Status (dict) --
The current state of the client connection.
Code (string) --
The state of the client connection.
Message (string) --
A message about the status of the client connection, if applicable.
ConnectionEndTime (string) --
The date and time the client connection was terminated.
PostureComplianceStatuses (list) --
The statuses returned by the client connect handler for posture compliance, if applicable.
paginator = client.get_paginator('describe_client_vpn_endpoints')
Creates an iterator that will paginate through responses from EC2.Client.describe_client_vpn_endpoints().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClientVpnEndpointIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the Client VPN endpoint.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ClientVpnEndpoints': [
{
'ClientVpnEndpointId': 'string',
'Description': 'string',
'Status': {
'Code': 'pending-associate'|'available'|'deleting'|'deleted',
'Message': 'string'
},
'CreationTime': 'string',
'DeletionTime': 'string',
'DnsName': 'string',
'ClientCidrBlock': 'string',
'DnsServers': [
'string',
],
'SplitTunnel': True|False,
'VpnProtocol': 'openvpn',
'TransportProtocol': 'tcp'|'udp',
'VpnPort': 123,
'AssociatedTargetNetworks': [
{
'NetworkId': 'string',
'NetworkType': 'vpc'
},
],
'ServerCertificateArn': 'string',
'AuthenticationOptions': [
{
'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication',
'ActiveDirectory': {
'DirectoryId': 'string'
},
'MutualAuthentication': {
'ClientRootCertificateChain': 'string'
},
'FederatedAuthentication': {
'SamlProviderArn': 'string',
'SelfServiceSamlProviderArn': 'string'
}
},
],
'ConnectionLogOptions': {
'Enabled': True|False,
'CloudwatchLogGroup': 'string',
'CloudwatchLogStream': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SecurityGroupIds': [
'string',
],
'VpcId': 'string',
'SelfServicePortalUrl': 'string',
'ClientConnectOptions': {
'Enabled': True|False,
'LambdaFunctionArn': 'string',
'Status': {
'Code': 'applying'|'applied',
'Message': 'string'
}
}
},
],
}
Response Structure
(dict) --
ClientVpnEndpoints (list) --
Information about the Client VPN endpoints.
(dict) --
Describes a Client VPN endpoint.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint.
Description (string) --
A brief description of the endpoint.
Status (dict) --
The current state of the Client VPN endpoint.
Code (string) --
The state of the Client VPN endpoint. Possible states include:
Message (string) --
A message about the status of the Client VPN endpoint.
CreationTime (string) --
The date and time the Client VPN endpoint was created.
DeletionTime (string) --
The date and time the Client VPN endpoint was deleted, if applicable.
DnsName (string) --
The DNS name to be used by clients when connecting to the Client VPN endpoint.
ClientCidrBlock (string) --
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
DnsServers (list) --
Information about the DNS servers to be used for DNS resolution.
SplitTunnel (boolean) --
Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide .
VpnProtocol (string) --
The protocol used by the VPN session.
TransportProtocol (string) --
The transport protocol used by the Client VPN endpoint.
VpnPort (integer) --
The port number for the Client VPN endpoint.
AssociatedTargetNetworks (list) --
Information about the associated target networks. A target network is a subnet in a VPC.
(dict) --
Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
NetworkId (string) --
The ID of the subnet.
NetworkType (string) --
The target network type.
ServerCertificateArn (string) --
The ARN of the server certificate.
AuthenticationOptions (list) --
Information about the authentication method used by the Client VPN endpoint.
(dict) --
Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the AWS Client VPN Administrator Guide .
Type (string) --
The authentication type used.
ActiveDirectory (dict) --
Information about the Active Directory, if applicable.
DirectoryId (string) --
The ID of the Active Directory used for authentication.
MutualAuthentication (dict) --
Information about the authentication certificates, if applicable.
ClientRootCertificateChain (string) --
The ARN of the client certificate.
FederatedAuthentication (dict) --
Information about the IAM SAML identity provider, if applicable.
SamlProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider.
SelfServiceSamlProviderArn (string) --
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
ConnectionLogOptions (dict) --
Information about the client connection logging options for the Client VPN endpoint.
Enabled (boolean) --
Indicates whether client connection logging is enabled for the Client VPN endpoint.
CloudwatchLogGroup (string) --
The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
CloudwatchLogStream (string) --
The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
Tags (list) --
Any tags assigned to the Client VPN endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
SecurityGroupIds (list) --
The IDs of the security groups for the target network.
VpcId (string) --
The ID of the VPC.
SelfServicePortalUrl (string) --
The URL of the self-service portal.
ClientConnectOptions (dict) --
The options for managing connection authorization for new client connections.
Enabled (boolean) --
Indicates whether client connect options are enabled.
LambdaFunctionArn (string) --
The Amazon Resource Name (ARN) of the AWS Lambda function used for connection authorization.
Status (dict) --
The status of any updates to the client connect options.
Code (string) --
The status code.
Message (string) --
The status message.
paginator = client.get_paginator('describe_client_vpn_routes')
Creates an iterator that will paginate through responses from EC2.Client.describe_client_vpn_routes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClientVpnEndpointId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the Client VPN endpoint.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Routes': [
{
'ClientVpnEndpointId': 'string',
'DestinationCidr': 'string',
'TargetSubnet': 'string',
'Type': 'string',
'Origin': 'string',
'Status': {
'Code': 'creating'|'active'|'failed'|'deleting',
'Message': 'string'
},
'Description': 'string'
},
],
}
Response Structure
(dict) --
Routes (list) --
Information about the Client VPN endpoint routes.
(dict) --
Information about a Client VPN endpoint route.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint with which the route is associated.
DestinationCidr (string) --
The IPv4 address range, in CIDR notation, of the route destination.
TargetSubnet (string) --
The ID of the subnet through which traffic is routed.
Type (string) --
The route type.
Origin (string) --
Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.
Status (dict) --
The current state of the route.
Code (string) --
The state of the Client VPN endpoint route.
Message (string) --
A message about the status of the Client VPN endpoint route, if applicable.
Description (string) --
A brief description of the route.
paginator = client.get_paginator('describe_client_vpn_target_networks')
Creates an iterator that will paginate through responses from EC2.Client.describe_client_vpn_target_networks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClientVpnEndpointId='string',
AssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the Client VPN endpoint.
The IDs of the target network associations.
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ClientVpnTargetNetworks': [
{
'AssociationId': 'string',
'VpcId': 'string',
'TargetNetworkId': 'string',
'ClientVpnEndpointId': 'string',
'Status': {
'Code': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated',
'Message': 'string'
},
'SecurityGroups': [
'string',
]
},
],
}
Response Structure
(dict) --
ClientVpnTargetNetworks (list) --
Information about the associated target networks.
(dict) --
Describes a target network associated with a Client VPN endpoint.
AssociationId (string) --
The ID of the association.
VpcId (string) --
The ID of the VPC in which the target network (subnet) is located.
TargetNetworkId (string) --
The ID of the subnet specified as the target network.
ClientVpnEndpointId (string) --
The ID of the Client VPN endpoint with which the target network is associated.
Status (dict) --
The current state of the target network association.
Code (string) --
The state of the target network association.
Message (string) --
A message about the status of the target network association, if applicable.
SecurityGroups (list) --
The IDs of the security groups applied to the target network association.
paginator = client.get_paginator('describe_coip_pools')
Creates an iterator that will paginate through responses from EC2.Client.describe_coip_pools().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PoolIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the address pools.
The filters. The following are the possible values:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CoipPools': [
{
'PoolId': 'string',
'PoolCidrs': [
'string',
],
'LocalGatewayRouteTableId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PoolArn': 'string'
},
],
}
Response Structure
(dict) --
CoipPools (list) --
Information about the address pools.
(dict) --
Describes a customer-owned address pool.
PoolId (string) --
The ID of the address pool.
PoolCidrs (list) --
The address ranges of the address pool.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
PoolArn (string) --
The ARN of the address pool.
paginator = client.get_paginator('describe_dhcp_options')
Creates an iterator that will paginate through responses from EC2.Client.describe_dhcp_options().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DhcpOptionsIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DhcpOptions': [
{
'DhcpConfigurations': [
{
'Key': 'string',
'Values': [
{
'Value': 'string'
},
]
},
],
'DhcpOptionsId': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
DhcpOptions (list) --
Information about one or more DHCP options sets.
(dict) --
Describes a set of DHCP options.
DhcpConfigurations (list) --
One or more DHCP options in the set.
(dict) --
Describes a DHCP configuration option.
Key (string) --
The name of a DHCP option.
Values (list) --
One or more values for the DHCP option.
(dict) --
Describes a value for a resource attribute that is a String.
Value (string) --
The attribute value. The value is case-sensitive.
DhcpOptionsId (string) --
The ID of the set of DHCP options.
OwnerId (string) --
The ID of the AWS account that owns the DHCP options set.
Tags (list) --
Any tags assigned to the DHCP options set.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_egress_only_internet_gateways')
Creates an iterator that will paginate through responses from EC2.Client.describe_egress_only_internet_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
EgressOnlyInternetGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more egress-only internet gateway IDs.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EgressOnlyInternetGateways': [
{
'Attachments': [
{
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
},
],
'EgressOnlyInternetGatewayId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
EgressOnlyInternetGateways (list) --
Information about the egress-only internet gateways.
(dict) --
Describes an egress-only internet gateway.
Attachments (list) --
Information about the attachment of the egress-only internet gateway.
(dict) --
Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
State (string) --
The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
VpcId (string) --
The ID of the VPC.
EgressOnlyInternetGatewayId (string) --
The ID of the egress-only internet gateway.
Tags (list) --
The tags assigned to the egress-only internet gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_export_image_tasks')
Creates an iterator that will paginate through responses from EC2.Client.describe_export_image_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ExportImageTaskIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filter tasks using the task-state filter and one of the following values: active , completed , deleting , or deleted .
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the export image tasks.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ExportImageTasks': [
{
'Description': 'string',
'ExportImageTaskId': 'string',
'ImageId': 'string',
'Progress': 'string',
'S3ExportLocation': {
'S3Bucket': 'string',
'S3Prefix': 'string'
},
'Status': 'string',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
ExportImageTasks (list) --
Information about the export image tasks.
(dict) --
Describes an export image task.
Description (string) --
A description of the image being exported.
ExportImageTaskId (string) --
The ID of the export image task.
ImageId (string) --
The ID of the image.
Progress (string) --
The percent complete of the export image task.
S3ExportLocation (dict) --
Information about the destination Amazon S3 bucket.
S3Bucket (string) --
The destination Amazon S3 bucket.
S3Prefix (string) --
The prefix (logical hierarchy) in the bucket.
Status (string) --
The status of the export image task. The possible values are active , completed , deleting , and deleted .
StatusMessage (string) --
The status message for the export image task.
Tags (list) --
Any tags assigned to the export image task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_fast_snapshot_restores')
Creates an iterator that will paginate through responses from EC2.Client.describe_fast_snapshot_restores().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FastSnapshotRestores': [
{
'SnapshotId': 'string',
'AvailabilityZone': 'string',
'State': 'enabling'|'optimizing'|'enabled'|'disabling'|'disabled',
'StateTransitionReason': 'string',
'OwnerId': 'string',
'OwnerAlias': 'string',
'EnablingTime': datetime(2015, 1, 1),
'OptimizingTime': datetime(2015, 1, 1),
'EnabledTime': datetime(2015, 1, 1),
'DisablingTime': datetime(2015, 1, 1),
'DisabledTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
FastSnapshotRestores (list) --
Information about the state of fast snapshot restores.
(dict) --
Describes fast snapshot restores for a snapshot.
SnapshotId (string) --
The ID of the snapshot.
AvailabilityZone (string) --
The Availability Zone.
State (string) --
The state of fast snapshot restores.
StateTransitionReason (string) --
The reason for the state transition. The possible values are as follows:
OwnerId (string) --
The ID of the AWS account that enabled fast snapshot restores on the snapshot.
OwnerAlias (string) --
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
EnablingTime (datetime) --
The time at which fast snapshot restores entered the enabling state.
OptimizingTime (datetime) --
The time at which fast snapshot restores entered the optimizing state.
EnabledTime (datetime) --
The time at which fast snapshot restores entered the enabled state.
DisablingTime (datetime) --
The time at which fast snapshot restores entered the disabling state.
DisabledTime (datetime) --
The time at which fast snapshot restores entered the disabled state.
paginator = client.get_paginator('describe_fleets')
Creates an iterator that will paginate through responses from EC2.Client.describe_fleets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
FleetIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the EC2 Fleets.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Fleets': [
{
'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled',
'CreateTime': datetime(2015, 1, 1),
'FleetId': 'string',
'FleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying',
'ClientToken': 'string',
'ExcessCapacityTerminationPolicy': 'no-termination'|'termination',
'FulfilledCapacity': 123.0,
'FulfilledOnDemandCapacity': 123.0,
'LaunchTemplateConfigs': [
{
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'GroupName': 'string'
}
},
]
},
],
'TargetCapacitySpecification': {
'TotalTargetCapacity': 123,
'OnDemandTargetCapacity': 123,
'SpotTargetCapacity': 123,
'DefaultTargetCapacityType': 'spot'|'on-demand'
},
'TerminateInstancesWithExpiration': True|False,
'Type': 'request'|'maintain'|'instant',
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'ReplaceUnhealthyInstances': True|False,
'SpotOptions': {
'AllocationStrategy': 'lowest-price'|'diversified'|'capacity-optimized'|'capacity-optimized-prioritized',
'MaintenanceStrategies': {
'CapacityRebalance': {
'ReplacementStrategy': 'launch'
}
},
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
'InstancePoolsToUseCount': 123,
'SingleInstanceType': True|False,
'SingleAvailabilityZone': True|False,
'MinTargetCapacity': 123,
'MaxTotalPrice': 'string'
},
'OnDemandOptions': {
'AllocationStrategy': 'lowest-price'|'prioritized',
'CapacityReservationOptions': {
'UsageStrategy': 'use-capacity-reservations-first'
},
'SingleInstanceType': True|False,
'SingleAvailabilityZone': True|False,
'MinTargetCapacity': 123,
'MaxTotalPrice': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Errors': [
{
'LaunchTemplateAndOverrides': {
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': {
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'GroupName': 'string'
}
}
},
'Lifecycle': 'spot'|'on-demand',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'Instances': [
{
'LaunchTemplateAndOverrides': {
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': {
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'MaxPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0,
'Placement': {
'GroupName': 'string'
}
}
},
'Lifecycle': 'spot'|'on-demand',
'InstanceIds': [
'string',
],
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'Platform': 'Windows'
},
],
'Context': 'string'
},
]
}
Response Structure
(dict) --
Fleets (list) --
Information about the EC2 Fleets.
(dict) --
Describes an EC2 Fleet.
ActivityStatus (string) --
The progress of the EC2 Fleet. If there is an error, the status is error . After all requests are placed, the status is pending_fulfillment . If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.
CreateTime (datetime) --
The creation date and time of the EC2 Fleet.
FleetId (string) --
The ID of the EC2 Fleet.
FleetState (string) --
The state of the EC2 Fleet.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
Constraints: Maximum 64 ASCII characters
ExcessCapacityTerminationPolicy (string) --
Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
FulfilledCapacity (float) --
The number of units fulfilled by this request compared to the set target capacity.
FulfilledOnDemandCapacity (float) --
The number of units fulfilled by this request compared to the set target On-Demand capacity.
LaunchTemplateConfigs (list) --
The launch template and overrides.
(dict) --
Describes a launch template and overrides.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (list) --
Any parameters that you specify override the same parameters in the launch template.
(dict) --
Describes overrides for a launch template.
InstanceType (string) --
The instance type.
MaxPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
Placement (dict) --
The location where the instance launched, if applicable.
GroupName (string) --
The name of the placement group that the instance is in.
TargetCapacitySpecification (dict) --
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
TotalTargetCapacity (integer) --
The number of units to request, filled using DefaultTargetCapacityType .
OnDemandTargetCapacity (integer) --
The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.
SpotTargetCapacity (integer) --
The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.
DefaultTargetCapacityType (string) --
The default TotalTargetCapacity , which is either Spot or On-Demand .
TerminateInstancesWithExpiration (boolean) --
Indicates whether running instances should be terminated when the EC2 Fleet expires.
Type (string) --
The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain .
ValidFrom (datetime) --
The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.
ValidUntil (datetime) --
The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
ReplaceUnhealthyInstances (boolean) --
Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain . For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide .
SpotOptions (dict) --
The configuration of Spot Instances in an EC2 Fleet.
AllocationStrategy (string) --
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
If the allocation strategy is lowest-price , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified , EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.
MaintenanceStrategies (dict) --
The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.
CapacityRebalance (dict) --
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
ReplacementStrategy (string) --
To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for an existing Spot Instance in the fleet, specify launch . Only available for fleets of type maintain .
Note
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for both instances while they are running.
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted. The default is terminate .
InstancePoolsToUseCount (integer) --
The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowest-price . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
SingleInstanceType (boolean) --
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant .
SingleAvailabilityZone (boolean) --
Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant .
MinTargetCapacity (integer) --
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
MaxTotalPrice (string) --
The maximum amount per hour for Spot Instances that you're willing to pay.
OnDemandOptions (dict) --
The allocation strategy of On-Demand Instances in an EC2 Fleet.
AllocationStrategy (string) --
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price , EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price .
CapacityReservationOptions (dict) --
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type instant .
UsageStrategy (string) --
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized ).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
SingleInstanceType (boolean) --
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported only for fleets of type instant .
SingleAvailabilityZone (boolean) --
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type instant .
MinTargetCapacity (integer) --
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
MaxTotalPrice (string) --
The maximum amount per hour for On-Demand Instances that you're willing to pay.
Tags (list) --
The tags for an EC2 Fleet resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Errors (list) --
Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant .
(dict) --
Describes the instances that could not be launched by the fleet.
LaunchTemplateAndOverrides (dict) --
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (dict) --
Any parameters that you specify override the same parameters in the launch template.
InstanceType (string) --
The instance type.
MaxPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
Placement (dict) --
The location where the instance launched, if applicable.
GroupName (string) --
The name of the placement group that the instance is in.
Lifecycle (string) --
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
ErrorCode (string) --
The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes .
ErrorMessage (string) --
The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes .
Instances (list) --
Information about the instances that were launched by the fleet. Valid only when Type is set to instant .
(dict) --
Describes the instances that were launched by the fleet.
LaunchTemplateAndOverrides (dict) --
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (dict) --
Any parameters that you specify override the same parameters in the launch template.
InstanceType (string) --
The instance type.
MaxPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
Placement (dict) --
The location where the instance launched, if applicable.
GroupName (string) --
The name of the placement group that the instance is in.
Lifecycle (string) --
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
InstanceIds (list) --
The IDs of the instances.
InstanceType (string) --
The instance type.
Platform (string) --
The value is Windows for Windows instances. Otherwise, the value is blank.
Context (string) --
Reserved.
paginator = client.get_paginator('describe_flow_logs')
Creates an iterator that will paginate through responses from EC2.Client.describe_flow_logs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
FlowLogIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FlowLogs': [
{
'CreationTime': datetime(2015, 1, 1),
'DeliverLogsErrorMessage': 'string',
'DeliverLogsPermissionArn': 'string',
'DeliverLogsStatus': 'string',
'FlowLogId': 'string',
'FlowLogStatus': 'string',
'LogGroupName': 'string',
'ResourceId': 'string',
'TrafficType': 'ACCEPT'|'REJECT'|'ALL',
'LogDestinationType': 'cloud-watch-logs'|'s3',
'LogDestination': 'string',
'LogFormat': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'MaxAggregationInterval': 123
},
],
}
Response Structure
(dict) --
FlowLogs (list) --
Information about the flow logs.
(dict) --
Describes a flow log.
CreationTime (datetime) --
The date and time the flow log was created.
DeliverLogsErrorMessage (string) --
Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.
DeliverLogsPermissionArn (string) --
The ARN of the IAM role that posts logs to CloudWatch Logs.
DeliverLogsStatus (string) --
The status of the logs delivery (SUCCESS | FAILED ).
FlowLogId (string) --
The flow log ID.
FlowLogStatus (string) --
The status of the flow log (ACTIVE ).
LogGroupName (string) --
The name of the flow log group.
ResourceId (string) --
The ID of the resource on which the flow log was created.
TrafficType (string) --
The type of traffic captured for the flow log.
LogDestinationType (string) --
Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
LogDestination (string) --
Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.
LogFormat (string) --
The format of the flow log record.
Tags (list) --
The tags for the flow log.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
MaxAggregationInterval (integer) --
The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
When a network interface is attached to a Nitro-based instance , the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
Valid Values: 60 | 600
paginator = client.get_paginator('describe_fpga_images')
Creates an iterator that will paginate through responses from EC2.Client.describe_fpga_images().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
FpgaImageIds=[
'string',
],
Owners=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The AFI IDs.
Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace ).
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FpgaImages': [
{
'FpgaImageId': 'string',
'FpgaImageGlobalId': 'string',
'Name': 'string',
'Description': 'string',
'ShellVersion': 'string',
'PciId': {
'DeviceId': 'string',
'VendorId': 'string',
'SubsystemId': 'string',
'SubsystemVendorId': 'string'
},
'State': {
'Code': 'pending'|'failed'|'available'|'unavailable',
'Message': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'OwnerId': 'string',
'OwnerAlias': 'string',
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Public': True|False,
'DataRetentionSupport': True|False
},
],
}
Response Structure
(dict) --
FpgaImages (list) --
Information about the FPGA images.
(dict) --
Describes an Amazon FPGA image (AFI).
FpgaImageId (string) --
The FPGA image identifier (AFI ID).
FpgaImageGlobalId (string) --
The global FPGA image identifier (AGFI ID).
Name (string) --
The name of the AFI.
Description (string) --
The description of the AFI.
ShellVersion (string) --
The version of the AWS Shell that was used to create the bitstream.
PciId (dict) --
Information about the PCI bus.
DeviceId (string) --
The ID of the device.
VendorId (string) --
The ID of the vendor.
SubsystemId (string) --
The ID of the subsystem.
SubsystemVendorId (string) --
The ID of the vendor for the subsystem.
State (dict) --
Information about the state of the AFI.
Code (string) --
The state. The following are the possible values:
Message (string) --
If the state is failed , this is the error message.
CreateTime (datetime) --
The date and time the AFI was created.
UpdateTime (datetime) --
The time of the most recent update to the AFI.
OwnerId (string) --
The AWS account ID of the AFI owner.
OwnerAlias (string) --
The alias of the AFI owner. Possible values include self , amazon , and aws-marketplace .
ProductCodes (list) --
The product codes for the AFI.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
Tags (list) --
Any tags assigned to the AFI.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Public (boolean) --
Indicates whether the AFI is public.
DataRetentionSupport (boolean) --
Indicates whether data retention support is enabled for the AFI.
paginator = client.get_paginator('describe_host_reservation_offerings')
Creates an iterator that will paginate through responses from EC2.Client.describe_host_reservation_offerings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxDuration=123,
MinDuration=123,
OfferingId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OfferingSet': [
{
'CurrencyCode': 'USD',
'Duration': 123,
'HourlyPrice': 'string',
'InstanceFamily': 'string',
'OfferingId': 'string',
'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
'UpfrontPrice': 'string'
},
]
}
Response Structure
(dict) --
OfferingSet (list) --
Information about the offerings.
(dict) --
Details about the Dedicated Host Reservation offering.
CurrencyCode (string) --
The currency of the offering.
Duration (integer) --
The duration of the offering (in seconds).
HourlyPrice (string) --
The hourly price of the offering.
InstanceFamily (string) --
The instance family of the offering.
OfferingId (string) --
The ID of the offering.
PaymentOption (string) --
The available payment option.
UpfrontPrice (string) --
The upfront price of the offering. Does not apply to No Upfront offerings.
paginator = client.get_paginator('describe_host_reservations')
Creates an iterator that will paginate through responses from EC2.Client.describe_host_reservations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
HostReservationIdSet=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The host reservation IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'HostReservationSet': [
{
'Count': 123,
'CurrencyCode': 'USD',
'Duration': 123,
'End': datetime(2015, 1, 1),
'HostIdSet': [
'string',
],
'HostReservationId': 'string',
'HourlyPrice': 'string',
'InstanceFamily': 'string',
'OfferingId': 'string',
'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
'Start': datetime(2015, 1, 1),
'State': 'payment-pending'|'payment-failed'|'active'|'retired',
'UpfrontPrice': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
HostReservationSet (list) --
Details about the reservation's configuration.
(dict) --
Details about the Dedicated Host Reservation and associated Dedicated Hosts.
Count (integer) --
The number of Dedicated Hosts the reservation is associated with.
CurrencyCode (string) --
The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD .
Duration (integer) --
The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years) .
End (datetime) --
The date and time that the reservation ends.
HostIdSet (list) --
The IDs of the Dedicated Hosts associated with the reservation.
HostReservationId (string) --
The ID of the reservation that specifies the associated Dedicated Hosts.
HourlyPrice (string) --
The hourly price of the reservation.
InstanceFamily (string) --
The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
OfferingId (string) --
The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
PaymentOption (string) --
The payment option selected for this reservation.
Start (datetime) --
The date and time that the reservation started.
State (string) --
The state of the reservation.
UpfrontPrice (string) --
The upfront price of the reservation.
Tags (list) --
Any tags assigned to the Dedicated Host Reservation.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_hosts')
Creates an iterator that will paginate through responses from EC2.Client.describe_hosts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
HostIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Hosts': [
{
'AutoPlacement': 'on'|'off',
'AvailabilityZone': 'string',
'AvailableCapacity': {
'AvailableInstanceCapacity': [
{
'AvailableCapacity': 123,
'InstanceType': 'string',
'TotalCapacity': 123
},
],
'AvailableVCpus': 123
},
'ClientToken': 'string',
'HostId': 'string',
'HostProperties': {
'Cores': 123,
'InstanceType': 'string',
'InstanceFamily': 'string',
'Sockets': 123,
'TotalVCpus': 123
},
'HostReservationId': 'string',
'Instances': [
{
'InstanceId': 'string',
'InstanceType': 'string',
'OwnerId': 'string'
},
],
'State': 'available'|'under-assessment'|'permanent-failure'|'released'|'released-permanent-failure'|'pending',
'AllocationTime': datetime(2015, 1, 1),
'ReleaseTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'HostRecovery': 'on'|'off',
'AllowsMultipleInstanceTypes': 'on'|'off',
'OwnerId': 'string',
'AvailabilityZoneId': 'string',
'MemberOfServiceLinkedResourceGroup': True|False
},
],
}
Response Structure
(dict) --
Hosts (list) --
Information about the Dedicated Hosts.
(dict) --
Describes the properties of the Dedicated Host.
AutoPlacement (string) --
Whether auto-placement is on or off.
AvailabilityZone (string) --
The Availability Zone of the Dedicated Host.
AvailableCapacity (dict) --
Information about the instances running on the Dedicated Host.
AvailableInstanceCapacity (list) --
The number of instances that can be launched onto the Dedicated Host depending on the host's available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.
(dict) --
Information about the number of instances that can be launched onto the Dedicated Host.
AvailableCapacity (integer) --
The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.
InstanceType (string) --
The instance type supported by the Dedicated Host.
TotalCapacity (integer) --
The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.
AvailableVCpus (integer) --
The number of vCPUs available for launching instances onto the Dedicated Host.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
HostId (string) --
The ID of the Dedicated Host.
HostProperties (dict) --
The hardware specifications of the Dedicated Host.
Cores (integer) --
The number of cores on the Dedicated Host.
InstanceType (string) --
The instance type supported by the Dedicated Host. For example, m5.large . If the host supports multiple instance types, no instanceType is returned.
InstanceFamily (string) --
The instance family supported by the Dedicated Host. For example, m5 .
Sockets (integer) --
The number of sockets on the Dedicated Host.
TotalVCpus (integer) --
The total number of vCPUs on the Dedicated Host.
HostReservationId (string) --
The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.
Instances (list) --
The IDs and instance type that are currently running on the Dedicated Host.
(dict) --
Describes an instance running on a Dedicated Host.
InstanceId (string) --
The ID of instance that is running on the Dedicated Host.
InstanceType (string) --
The instance type (for example, m3.medium ) of the running instance.
OwnerId (string) --
The ID of the account that owns the instance.
State (string) --
The Dedicated Host's state.
AllocationTime (datetime) --
The time that the Dedicated Host was allocated.
ReleaseTime (datetime) --
The time that the Dedicated Host was released.
Tags (list) --
Any tags assigned to the Dedicated Host.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
HostRecovery (string) --
Indicates whether host recovery is enabled or disabled for the Dedicated Host.
AllowsMultipleInstanceTypes (string) --
Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on , the Dedicated Host supports multiple instance types in the instance family. If the value is off , the Dedicated Host supports a single instance type only.
OwnerId (string) --
The ID of the account that owns the Dedicated Host.
AvailabilityZoneId (string) --
The ID of the Availability Zone in which the Dedicated Host is allocated.
MemberOfServiceLinkedResourceGroup (boolean) --
Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true , the host is in a host resource group; otherwise, it is not.
paginator = client.get_paginator('describe_iam_instance_profile_associations')
Creates an iterator that will paginate through responses from EC2.Client.describe_iam_instance_profile_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IAM instance profile associations.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'IamInstanceProfileAssociations': [
{
'AssociationId': 'string',
'InstanceId': 'string',
'IamInstanceProfile': {
'Arn': 'string',
'Id': 'string'
},
'State': 'associating'|'associated'|'disassociating'|'disassociated',
'Timestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
IamInstanceProfileAssociations (list) --
Information about the IAM instance profile associations.
(dict) --
Describes an association between an IAM instance profile and an instance.
AssociationId (string) --
The ID of the association.
InstanceId (string) --
The ID of the instance.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Id (string) --
The ID of the instance profile.
State (string) --
The state of the association.
Timestamp (datetime) --
The time the IAM instance profile was associated with the instance.
paginator = client.get_paginator('describe_import_image_tasks')
Creates an iterator that will paginate through responses from EC2.Client.describe_import_image_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ImportTaskIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filter tasks using the task-state filter and one of the following values: active , completed , deleting , or deleted .
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the import image tasks.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ImportImageTasks': [
{
'Architecture': 'string',
'Description': 'string',
'Encrypted': True|False,
'Hypervisor': 'string',
'ImageId': 'string',
'ImportTaskId': 'string',
'KmsKeyId': 'string',
'LicenseType': 'string',
'Platform': 'string',
'Progress': 'string',
'SnapshotDetails': [
{
'Description': 'string',
'DeviceName': 'string',
'DiskImageSize': 123.0,
'Format': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'Url': 'string',
'UserBucket': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
],
'Status': 'string',
'StatusMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
]
},
],
}
Response Structure
(dict) --
ImportImageTasks (list) --
A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.
(dict) --
Describes an import image task.
Architecture (string) --
The architecture of the virtual machine.
Valid values: i386 | x86_64 | arm64
Description (string) --
A description of the import task.
Encrypted (boolean) --
Indicates whether the image is encrypted.
Hypervisor (string) --
The target hypervisor for the import task.
Valid values: xen
ImageId (string) --
The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
ImportTaskId (string) --
The ID of the import image task.
KmsKeyId (string) --
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted image.
LicenseType (string) --
The license type of the virtual machine.
Platform (string) --
The description string for the import image task.
Progress (string) --
The percentage of progress of the import image task.
SnapshotDetails (list) --
Information about the snapshots.
(dict) --
Describes the snapshot created from the imported disk.
Description (string) --
A description for the snapshot.
DeviceName (string) --
The block device mapping for the snapshot.
DiskImageSize (float) --
The size of the disk in the snapshot, in GiB.
Format (string) --
The format of the disk image from which the snapshot is created.
Progress (string) --
The percentage of progress for the task.
SnapshotId (string) --
The snapshot ID of the disk being imported.
Status (string) --
A brief status of the snapshot creation.
StatusMessage (string) --
A detailed status message for the snapshot creation.
Url (string) --
The URL used to access the disk image.
UserBucket (dict) --
The Amazon S3 bucket for the disk image.
S3Bucket (string) --
The Amazon S3 bucket from which the disk image was created.
S3Key (string) --
The file name of the disk image.
Status (string) --
A brief status for the import image task.
StatusMessage (string) --
A descriptive status message for the import image task.
Tags (list) --
The tags for the import image task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
LicenseSpecifications (list) --
The ARNs of the license configurations that are associated with the import image task.
(dict) --
The response information for license configurations.
LicenseConfigurationArn (string) --
The ARN of a license configuration.
paginator = client.get_paginator('describe_import_snapshot_tasks')
Creates an iterator that will paginate through responses from EC2.Client.describe_import_snapshot_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ImportTaskIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A list of import snapshot task IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ImportSnapshotTasks': [
{
'Description': 'string',
'ImportTaskId': 'string',
'SnapshotTaskDetail': {
'Description': 'string',
'DiskImageSize': 123.0,
'Encrypted': True|False,
'Format': 'string',
'KmsKeyId': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'Url': 'string',
'UserBucket': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
ImportSnapshotTasks (list) --
A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
(dict) --
Describes an import snapshot task.
Description (string) --
A description of the import snapshot task.
ImportTaskId (string) --
The ID of the import snapshot task.
SnapshotTaskDetail (dict) --
Describes an import snapshot task.
Description (string) --
The description of the snapshot.
DiskImageSize (float) --
The size of the disk in the snapshot, in GiB.
Encrypted (boolean) --
Indicates whether the snapshot is encrypted.
Format (string) --
The format of the disk image from which the snapshot is created.
KmsKeyId (string) --
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted snapshot.
Progress (string) --
The percentage of completion for the import snapshot task.
SnapshotId (string) --
The snapshot ID of the disk being imported.
Status (string) --
A brief status for the import snapshot task.
StatusMessage (string) --
A detailed status message for the import snapshot task.
Url (string) --
The URL of the disk image from which the snapshot is created.
UserBucket (dict) --
The Amazon S3 bucket for the disk image.
S3Bucket (string) --
The Amazon S3 bucket from which the disk image was created.
S3Key (string) --
The file name of the disk image.
Tags (list) --
The tags for the import snapshot task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_instance_credit_specifications')
Creates an iterator that will paginate through responses from EC2.Client.describe_instance_credit_specifications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'InstanceCreditSpecifications': [
{
'InstanceId': 'string',
'CpuCredits': 'string'
},
],
}
Response Structure
(dict) --
InstanceCreditSpecifications (list) --
Information about the credit option for CPU usage of an instance.
(dict) --
Describes the credit option for CPU usage of a burstable performance instance.
InstanceId (string) --
The ID of the instance.
CpuCredits (string) --
The credit option for CPU usage of the instance. Valid values are standard and unlimited .
paginator = client.get_paginator('describe_instance_status')
Creates an iterator that will paginate through responses from EC2.Client.describe_instance_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
IncludeAllInstances=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
When true , includes the health status for all instances. When false , includes the health status for running instances only.
Default: false
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'InstanceStatuses': [
{
'AvailabilityZone': 'string',
'OutpostArn': 'string',
'Events': [
{
'InstanceEventId': 'string',
'Code': 'instance-reboot'|'system-reboot'|'system-maintenance'|'instance-retirement'|'instance-stop',
'Description': 'string',
'NotAfter': datetime(2015, 1, 1),
'NotBefore': datetime(2015, 1, 1),
'NotBeforeDeadline': datetime(2015, 1, 1)
},
],
'InstanceId': 'string',
'InstanceState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
},
'SystemStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
}
},
],
}
Response Structure
(dict) --
InstanceStatuses (list) --
Information about the status of the instances.
(dict) --
Describes the status of an instance.
AvailabilityZone (string) --
The Availability Zone of the instance.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Events (list) --
Any scheduled events associated with the instance.
(dict) --
Describes a scheduled event for an instance.
InstanceEventId (string) --
The ID of the event.
Code (string) --
The event code.
Description (string) --
A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
NotAfter (datetime) --
The latest scheduled end time for the event.
NotBefore (datetime) --
The earliest scheduled start time for the event.
NotBeforeDeadline (datetime) --
The deadline for starting the event.
InstanceId (string) --
The ID of the instance.
InstanceState (dict) --
The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceStatus (dict) --
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
Details (list) --
The system instance health or application instance health.
(dict) --
Describes the instance status.
ImpairedSince (datetime) --
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
Name (string) --
The type of instance status.
Status (string) --
The status.
Status (string) --
The status.
SystemStatus (dict) --
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
Details (list) --
The system instance health or application instance health.
(dict) --
Describes the instance status.
ImpairedSince (datetime) --
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
Name (string) --
The type of instance status.
Status (string) --
The status.
Status (string) --
The status.
paginator = client.get_paginator('describe_instance_type_offerings')
Creates an iterator that will paginate through responses from EC2.Client.describe_instance_type_offerings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
LocationType='region'|'availability-zone'|'availability-zone-id',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'InstanceTypeOfferings': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'LocationType': 'region'|'availability-zone'|'availability-zone-id',
'Location': 'string'
},
],
}
Response Structure
(dict) --
InstanceTypeOfferings (list) --
The instance types offered.
(dict) --
The instance types offered.
InstanceType (string) --
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .
LocationType (string) --
The location type.
Location (string) --
The identifier for the location. This depends on the location type. For example, if the location type is region , the location is the Region code (for example, us-east-2 .)
paginator = client.get_paginator('describe_instance_types')
Creates an iterator that will paginate through responses from EC2.Client.describe_instance_types().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
InstanceTypes=[
'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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The instance types. For more information, see Instance types in the Amazon EC2 User Guide .
One or more filters. Filter names and values are case-sensitive.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'InstanceTypes': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'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',
],
'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'
},
'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
}
},
'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',
]
},
],
}
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.
SupportedRootDeviceTypes (list) --
The supported root device types.
SupportedVirtualizationTypes (list) --
The supported virtualization types.
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.
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.
ValidThreadsPerCore (list) --
The valid number of threads per core that can be configured for the instance type.
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 the 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 for instance store.
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.
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.
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 .
paginator = client.get_paginator('describe_instances')
Creates an iterator that will paginate through responses from EC2.Client.describe_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Reservations': [
{
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'Instances': [
{
'AmiLaunchIndex': 123,
'ImageId': 'string',
'InstanceId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'LaunchTime': datetime(2015, 1, 1),
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
},
'Platform': 'Windows',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'PublicDnsName': 'string',
'PublicIpAddress': 'string',
'RamdiskId': 'string',
'State': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'StateTransitionReason': 'string',
'SubnetId': 'string',
'VpcId': 'string',
'Architecture': 'i386'|'x86_64'|'arm64',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'Ebs': {
'AttachTime': datetime(2015, 1, 1),
'DeleteOnTermination': True|False,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'VolumeId': 'string'
}
},
],
'ClientToken': 'string',
'EbsOptimized': True|False,
'EnaSupport': True|False,
'Hypervisor': 'ovm'|'xen',
'IamInstanceProfile': {
'Arn': 'string',
'Id': 'string'
},
'InstanceLifecycle': 'spot'|'scheduled',
'ElasticGpuAssociations': [
{
'ElasticGpuId': 'string',
'ElasticGpuAssociationId': 'string',
'ElasticGpuAssociationState': 'string',
'ElasticGpuAssociationTime': 'string'
},
],
'ElasticInferenceAcceleratorAssociations': [
{
'ElasticInferenceAcceleratorArn': 'string',
'ElasticInferenceAcceleratorAssociationId': 'string',
'ElasticInferenceAcceleratorAssociationState': 'string',
'ElasticInferenceAcceleratorAssociationTime': datetime(2015, 1, 1)
},
],
'NetworkInterfaces': [
{
'Association': {
'CarrierIp': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string'
},
'Attachment': {
'AttachTime': datetime(2015, 1, 1),
'AttachmentId': 'string',
'DeleteOnTermination': True|False,
'DeviceIndex': 123,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'NetworkCardIndex': 123
},
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OwnerId': 'string',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Association': {
'CarrierIp': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string'
},
'Primary': True|False,
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string'
},
],
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'VpcId': 'string',
'InterfaceType': 'string'
},
],
'OutpostArn': 'string',
'RootDeviceName': 'string',
'RootDeviceType': 'ebs'|'instance-store',
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'SourceDestCheck': True|False,
'SpotInstanceRequestId': 'string',
'SriovNetSupport': 'string',
'StateReason': {
'Code': 'string',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VirtualizationType': 'hvm'|'paravirtual',
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationId': 'string',
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'HibernationOptions': {
'Configured': True|False
},
'Licenses': [
{
'LicenseConfigurationArn': 'string'
},
],
'MetadataOptions': {
'State': 'pending'|'applied',
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
},
'BootMode': 'legacy-bios'|'uefi'
},
],
'OwnerId': 'string',
'RequesterId': 'string',
'ReservationId': 'string'
},
],
}
Response Structure
(dict) --
Reservations (list) --
Information about the reservations.
(dict) --
Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.
Groups (list) --
[EC2-Classic only] The security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
Instances (list) --
The instances.
(dict) --
Describes an instance.
AmiLaunchIndex (integer) --
The AMI launch index, which can be used to find this instance in the launch group.
ImageId (string) --
The ID of the AMI used to launch the instance.
InstanceId (string) --
The ID of the instance.
InstanceType (string) --
The instance type.
KernelId (string) --
The kernel associated with this instance, if applicable.
KeyName (string) --
The name of the key pair, if this instance was launched with an associated key pair.
LaunchTime (datetime) --
The time the instance was launched.
Monitoring (dict) --
The monitoring for the instance.
State (string) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Placement (dict) --
The location where the instance launched, if applicable.
AvailabilityZone (string) --
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
Affinity (string) --
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
GroupName (string) --
The name of the placement group the instance is in.
PartitionNumber (integer) --
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
HostId (string) --
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
SpreadDomain (string) --
Reserved for future use.
This parameter is not supported by CreateFleet .
HostResourceGroupArn (string) --
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
Platform (string) --
The value is Windows for Windows instances; otherwise blank.
PrivateDnsName (string) --
(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
PrivateIpAddress (string) --
The private IPv4 address assigned to the instance.
ProductCodes (list) --
The product codes attached to this instance, if applicable.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
PublicDnsName (string) --
(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.
PublicIpAddress (string) --
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
RamdiskId (string) --
The RAM disk associated with this instance, if applicable.
State (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
StateTransitionReason (string) --
The reason for the most recent state transition. This might be an empty string.
SubnetId (string) --
[EC2-VPC] The ID of the subnet in which the instance is running.
VpcId (string) --
[EC2-VPC] The ID of the VPC in which the instance is running.
Architecture (string) --
The architecture of the image.
BlockDeviceMappings (list) --
Any block device mapping entries for the instance.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
AttachTime (datetime) --
The time stamp when the attachment initiated.
DeleteOnTermination (boolean) --
Indicates whether the volume is deleted on instance termination.
Status (string) --
The attachment state.
VolumeId (string) --
The ID of the EBS volume.
ClientToken (string) --
The idempotency token you provided when you launched the instance, if applicable.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
EnaSupport (boolean) --
Specifies whether enhanced networking with ENA is enabled.
Hypervisor (string) --
The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.
IamInstanceProfile (dict) --
The IAM instance profile associated with the instance, if applicable.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Id (string) --
The ID of the instance profile.
InstanceLifecycle (string) --
Indicates whether this is a Spot Instance or a Scheduled Instance.
ElasticGpuAssociations (list) --
The Elastic GPU associated with the instance.
(dict) --
Describes the association between an instance and an Elastic Graphics accelerator.
ElasticGpuId (string) --
The ID of the Elastic Graphics accelerator.
ElasticGpuAssociationId (string) --
The ID of the association.
ElasticGpuAssociationState (string) --
The state of the association between the instance and the Elastic Graphics accelerator.
ElasticGpuAssociationTime (string) --
The time the Elastic Graphics accelerator was associated with the instance.
ElasticInferenceAcceleratorAssociations (list) --
The elastic inference accelerator associated with the instance.
(dict) --
Describes the association between an instance and an elastic inference accelerator.
ElasticInferenceAcceleratorArn (string) --
The Amazon Resource Name (ARN) of the elastic inference accelerator.
ElasticInferenceAcceleratorAssociationId (string) --
The ID of the association.
ElasticInferenceAcceleratorAssociationState (string) --
The state of the elastic inference accelerator.
ElasticInferenceAcceleratorAssociationTime (datetime) --
The time at which the elastic inference accelerator is associated with an instance.
NetworkInterfaces (list) --
[EC2-VPC] The network interfaces for the instance.
(dict) --
Describes a network interface.
Association (dict) --
The association information for an Elastic IPv4 associated with the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
IpOwnerId (string) --
The ID of the owner of the Elastic IP address.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The public IP address or Elastic IP address bound to the network interface.
Attachment (dict) --
The network interface attachment.
AttachTime (datetime) --
The time stamp 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 index of the device on the instance for the network interface attachment.
Status (string) --
The attachment state.
NetworkCardIndex (integer) --
The index of the network card.
Description (string) --
The description.
Groups (list) --
One or more security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
Ipv6Addresses (list) --
One or more IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OwnerId (string) --
The ID of the account that created the network interface.
PrivateDnsName (string) --
The private DNS name.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
PrivateIpAddresses (list) --
One or more private IPv4 addresses associated with the network interface.
(dict) --
Describes a private IPv4 address.
Association (dict) --
The association information for an Elastic IP address for the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
IpOwnerId (string) --
The ID of the owner of the Elastic IP address.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The public IP address or Elastic IP address bound to the network interface.
Primary (boolean) --
Indicates whether this IPv4 address is the primary private IP address of the network interface.
PrivateDnsName (string) --
The private IPv4 DNS name.
PrivateIpAddress (string) --
The private IPv4 address of the network interface.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
Status (string) --
The status of the network interface.
SubnetId (string) --
The ID of the subnet.
VpcId (string) --
The ID of the VPC.
InterfaceType (string) --
Describes the type of network interface.
Valid values: interface | efa | trunk
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
RootDeviceName (string) --
The device name of the root device volume (for example, /dev/sda1 ).
RootDeviceType (string) --
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
SecurityGroups (list) --
The security groups for the instance.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
SpotInstanceRequestId (string) --
If the request is a Spot Instance request, the ID of the request.
SriovNetSupport (string) --
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason (dict) --
The reason for the most recent state transition.
Code (string) --
The reason code for the state change.
Message (string) --
The message for the state change.
Tags (list) --
Any tags assigned to the instance.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VirtualizationType (string) --
The virtualization type of the instance.
CpuOptions (dict) --
The CPU options for the instance.
CoreCount (integer) --
The number of CPU cores for the instance.
ThreadsPerCore (integer) --
The number of threads per CPU core.
CapacityReservationId (string) --
The ID of the Capacity Reservation.
CapacityReservationSpecification (dict) --
Information about the Capacity Reservation targeting option.
CapacityReservationPreference (string) --
Describes the instance's Capacity Reservation preferences. Possible preferences include:
CapacityReservationTarget (dict) --
Information about the targeted Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) --
The ID of the targeted Capacity Reservation.
CapacityReservationResourceGroupArn (string) --
The ARN of the targeted Capacity Reservation group.
HibernationOptions (dict) --
Indicates whether the instance is enabled for hibernation.
Configured (boolean) --
If this parameter is set to true , your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
Licenses (list) --
The license configurations.
(dict) --
Describes a license configuration.
LicenseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the license configuration.
MetadataOptions (dict) --
The metadata options for the instance.
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
EnclaveOptions (dict) --
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
BootMode (string) --
The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide .
OwnerId (string) --
The ID of the account that owns the reservation.
RequesterId (string) --
The ID of the requester that launched the instances on your behalf (for example, Management Console or Auto Scaling).
ReservationId (string) --
The ID of the reservation.
paginator = client.get_paginator('describe_internet_gateways')
Creates an iterator that will paginate through responses from EC2.Client.describe_internet_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
InternetGatewayIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more internet gateway IDs.
Default: Describes all your internet gateways.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'InternetGateways': [
{
'Attachments': [
{
'State': 'attaching'|'attached'|'detaching'|'detached',
'VpcId': 'string'
},
],
'InternetGatewayId': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
InternetGateways (list) --
Information about one or more internet gateways.
(dict) --
Describes an internet gateway.
Attachments (list) --
Any VPCs attached to the internet gateway.
(dict) --
Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
State (string) --
The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
VpcId (string) --
The ID of the VPC.
InternetGatewayId (string) --
The ID of the internet gateway.
OwnerId (string) --
The ID of the AWS account that owns the internet gateway.
Tags (list) --
Any tags assigned to the internet gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_ipv6_pools')
Creates an iterator that will paginate through responses from EC2.Client.describe_ipv6_pools().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PoolIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the IPv6 address pools.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Ipv6Pools': [
{
'PoolId': 'string',
'Description': 'string',
'PoolCidrBlocks': [
{
'Cidr': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Ipv6Pools (list) --
Information about the IPv6 address pools.
(dict) --
Describes an IPv6 address pool.
PoolId (string) --
The ID of the address pool.
Description (string) --
The description for the address pool.
PoolCidrBlocks (list) --
The CIDR blocks for the address pool.
(dict) --
Describes a CIDR block for an address pool.
Cidr (string) --
The CIDR block.
Tags (list) --
Any tags for the address pool.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_launch_template_versions')
Creates an iterator that will paginate through responses from EC2.Client.describe_launch_template_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
LaunchTemplateId='string',
LaunchTemplateName='string',
Versions=[
'string',
],
MinVersion='string',
MaxVersion='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest , $Default , and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest . To describe all launch templates in your account that are defined as the default version, the valid value is $Default . You can specify $Latest and $Default in the same call. You cannot specify numbers.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LaunchTemplateVersions': [
{
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'VersionNumber': 123,
'VersionDescription': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersion': True|False,
'LaunchTemplateData': {
'KernelId': 'string',
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'Encrypted': True|False,
'DeleteOnTermination': True|False,
'Iops': 123,
'KmsKeyId': 'string',
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'Throughput': 123
},
'NoDevice': 'string'
},
],
'NetworkInterfaces': [
{
'AssociateCarrierIpAddress': True|False,
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'InterfaceType': 'string',
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'NetworkCardIndex': 123
},
],
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string',
'PartitionNumber': 123
},
'RamDiskId': 'string',
'DisableApiTermination': True|False,
'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
'UserData': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'ElasticGpuSpecifications': [
{
'Type': 'string'
},
],
'ElasticInferenceAccelerators': [
{
'Type': 'string',
'Count': 123
},
],
'SecurityGroupIds': [
'string',
],
'SecurityGroups': [
'string',
],
'InstanceMarketOptions': {
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
'CreditSpecification': {
'CpuCredits': 'string'
},
'CpuOptions': {
'CoreCount': 123,
'ThreadsPerCore': 123
},
'CapacityReservationSpecification': {
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
'HibernationOptions': {
'Configured': True|False
},
'MetadataOptions': {
'State': 'pending'|'applied',
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
'EnclaveOptions': {
'Enabled': True|False
}
}
},
],
}
Response Structure
(dict) --
LaunchTemplateVersions (list) --
Information about the launch template versions.
(dict) --
Describes a launch template version.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
VersionNumber (integer) --
The version number.
VersionDescription (string) --
The description for the version.
CreateTime (datetime) --
The time the version was created.
CreatedBy (string) --
The principal that created the version.
DefaultVersion (boolean) --
Indicates whether the version is the default version.
LaunchTemplateData (dict) --
Information about the launch template.
KernelId (string) --
The ID of the kernel, if applicable.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for Amazon EBS I/O.
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
BlockDeviceMappings (list) --
The block device mappings.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name.
VirtualName (string) --
The virtual device name (ephemeralN).
Ebs (dict) --
Information about the block device for an EBS volume.
Encrypted (boolean) --
Indicates whether the EBS volume is encrypted.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports.
KmsKeyId (string) --
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiB.
VolumeType (string) --
The volume type.
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
NetworkInterfaces (list) --
The network interfaces.
(dict) --
Describes a network interface.
AssociateCarrierIpAddress (boolean) --
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide .
AssociatePublicIpAddress (boolean) --
Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
DeleteOnTermination (boolean) --
Indicates whether the network interface is deleted when the instance is terminated.
Description (string) --
A description for the network interface.
DeviceIndex (integer) --
The device index for the network interface attachment.
Groups (list) --
The IDs of one or more security groups.
InterfaceType (string) --
The type of network interface.
Ipv6AddressCount (integer) --
The number of IPv6 addresses for the network interface.
Ipv6Addresses (list) --
The IPv6 addresses for the network interface.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
PrivateIpAddress (string) --
The primary private IPv4 address of the network interface.
PrivateIpAddresses (list) --
One or more private IPv4 addresses.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses for the network interface.
SubnetId (string) --
The ID of the subnet for the network interface.
NetworkCardIndex (integer) --
The index of the network card.
ImageId (string) --
The ID of the AMI that was used to launch the instance.
InstanceType (string) --
The instance type.
KeyName (string) --
The name of the key pair.
Monitoring (dict) --
The monitoring for the instance.
Enabled (boolean) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Placement (dict) --
The placement of the instance.
AvailabilityZone (string) --
The Availability Zone of the instance.
Affinity (string) --
The affinity setting for the instance on the Dedicated Host.
GroupName (string) --
The name of the placement group for the instance.
HostId (string) --
The ID of the Dedicated Host for the instance.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
SpreadDomain (string) --
Reserved for future use.
HostResourceGroupArn (string) --
The ARN of the host resource group in which to launch the instances.
PartitionNumber (integer) --
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .
RamDiskId (string) --
The ID of the RAM disk, if applicable.
DisableApiTermination (boolean) --
If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
InstanceInitiatedShutdownBehavior (string) --
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
UserData (string) --
The user data for the instance.
TagSpecifications (list) --
The tags.
(dict) --
The tag specification for the launch template.
ResourceType (string) --
The type of resource.
Tags (list) --
The tags for the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ElasticGpuSpecifications (list) --
The elastic GPU specification.
(dict) --
Describes an elastic GPU.
Type (string) --
The elastic GPU type.
ElasticInferenceAccelerators (list) --
The elastic inference accelerator for the instance.
(dict) --
Describes an elastic inference accelerator.
Type (string) --
The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
Count (integer) --
The number of elastic inference accelerators to attach to the instance.
Default: 1
SecurityGroupIds (list) --
The security group IDs.
SecurityGroups (list) --
The security group names.
InstanceMarketOptions (dict) --
The market (purchasing) option for the instances.
MarketType (string) --
The market type.
SpotOptions (dict) --
The options for Spot Instances.
MaxPrice (string) --
The maximum hourly price you're willing to pay for the Spot Instances.
SpotInstanceType (string) --
The Spot Instance request type.
BlockDurationMinutes (integer) --
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
ValidUntil (datetime) --
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted.
CreditSpecification (dict) --
The credit option for CPU usage of the instance.
CpuCredits (string) --
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
CpuOptions (dict) --
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide .
CoreCount (integer) --
The number of CPU cores for the instance.
ThreadsPerCore (integer) --
The number of threads per CPU core.
CapacityReservationSpecification (dict) --
Information about the Capacity Reservation targeting option.
CapacityReservationPreference (string) --
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
CapacityReservationTarget (dict) --
Information about the target Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) --
The ID of the targeted Capacity Reservation.
CapacityReservationResourceGroupArn (string) --
The ARN of the targeted Capacity Reservation group.
LicenseSpecifications (list) --
The license configurations.
(dict) --
Describes a license configuration.
LicenseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the license configuration.
HibernationOptions (dict) --
Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide .
Configured (boolean) --
If this parameter is set to true , the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
MetadataOptions (dict) --
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide .
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
EnclaveOptions (dict) --
Indicates whether the instance is enabled for AWS Nitro Enclaves.
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.
paginator = client.get_paginator('describe_launch_templates')
Creates an iterator that will paginate through responses from EC2.Client.describe_launch_templates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
LaunchTemplateIds=[
'string',
],
LaunchTemplateNames=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more launch template IDs.
One or more launch template names.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LaunchTemplates': [
{
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersionNumber': 123,
'LatestVersionNumber': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
LaunchTemplates (list) --
Information about the launch templates.
(dict) --
Describes a launch template.
LaunchTemplateId (string) --
The ID of the launch template.
LaunchTemplateName (string) --
The name of the launch template.
CreateTime (datetime) --
The time launch template was created.
CreatedBy (string) --
The principal that created the launch template.
DefaultVersionNumber (integer) --
The version number of the default version of the launch template.
LatestVersionNumber (integer) --
The version number of the latest version of the launch template.
Tags (list) --
The tags for the launch template.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_local_gateway_route_table_virtual_interface_group_associations')
Creates an iterator that will paginate through responses from EC2.Client.describe_local_gateway_route_table_virtual_interface_group_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the associations.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LocalGatewayRouteTableVirtualInterfaceGroupAssociations': [
{
'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
LocalGatewayRouteTableVirtualInterfaceGroupAssociations (list) --
Information about the associations.
(dict) --
Describes an association between a local gateway route table and a virtual interface group.
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId (string) --
The ID of the association.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
LocalGatewayId (string) --
The ID of the local gateway.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
OwnerId (string) --
The AWS account ID that owns the local gateway virtual interface group association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_local_gateway_route_table_vpc_associations')
Creates an iterator that will paginate through responses from EC2.Client.describe_local_gateway_route_table_vpc_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LocalGatewayRouteTableVpcAssociationIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the associations.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LocalGatewayRouteTableVpcAssociations': [
{
'LocalGatewayRouteTableVpcAssociationId': 'string',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
LocalGatewayRouteTableVpcAssociations (list) --
Information about the associations.
(dict) --
Describes an association between a local gateway route table and a VPC.
LocalGatewayRouteTableVpcAssociationId (string) --
The ID of the association.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table for the association.
LocalGatewayId (string) --
The ID of the local gateway.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The AWS account ID that owns the local gateway route table for the association.
State (string) --
The state of the association.
Tags (list) --
The tags assigned to the association.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_local_gateway_route_tables')
Creates an iterator that will paginate through responses from EC2.Client.describe_local_gateway_route_tables().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LocalGatewayRouteTableIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the local gateway route tables.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LocalGatewayRouteTables': [
{
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'LocalGatewayId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
LocalGatewayRouteTables (list) --
Information about the local gateway route tables.
(dict) --
Describes a local gateway route table.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
LocalGatewayId (string) --
The ID of the local gateway.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The AWS account ID that owns the local gateway route table.
State (string) --
The state of the local gateway route table.
Tags (list) --
The tags assigned to the local gateway route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_local_gateway_virtual_interface_groups')
Creates an iterator that will paginate through responses from EC2.Client.describe_local_gateway_virtual_interface_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LocalGatewayVirtualInterfaceGroupIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the virtual interface groups.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LocalGatewayVirtualInterfaceGroups': [
{
'LocalGatewayVirtualInterfaceGroupId': 'string',
'LocalGatewayVirtualInterfaceIds': [
'string',
],
'LocalGatewayId': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
LocalGatewayVirtualInterfaceGroups (list) --
The virtual interface groups.
(dict) --
Describes a local gateway virtual interface group.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
LocalGatewayVirtualInterfaceIds (list) --
The IDs of the virtual interfaces.
LocalGatewayId (string) --
The ID of the local gateway.
OwnerId (string) --
The AWS account ID that owns the local gateway virtual interface group.
Tags (list) --
The tags assigned to the virtual interface group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_local_gateway_virtual_interfaces')
Creates an iterator that will paginate through responses from EC2.Client.describe_local_gateway_virtual_interfaces().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LocalGatewayVirtualInterfaceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the virtual interfaces.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LocalGatewayVirtualInterfaces': [
{
'LocalGatewayVirtualInterfaceId': 'string',
'LocalGatewayId': 'string',
'Vlan': 123,
'LocalAddress': 'string',
'PeerAddress': 'string',
'LocalBgpAsn': 123,
'PeerBgpAsn': 123,
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
LocalGatewayVirtualInterfaces (list) --
Information about the virtual interfaces.
(dict) --
Describes a local gateway virtual interface.
LocalGatewayVirtualInterfaceId (string) --
The ID of the virtual interface.
LocalGatewayId (string) --
The ID of the local gateway.
Vlan (integer) --
The ID of the VLAN.
LocalAddress (string) --
The local address.
PeerAddress (string) --
The peer address.
LocalBgpAsn (integer) --
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
PeerBgpAsn (integer) --
The peer BGP ASN.
OwnerId (string) --
The AWS account ID that owns the local gateway virtual interface.
Tags (list) --
The tags assigned to the virtual interface.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_local_gateways')
Creates an iterator that will paginate through responses from EC2.Client.describe_local_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LocalGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LocalGateways': [
{
'LocalGatewayId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'State': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
LocalGateways (list) --
Information about the local gateways.
(dict) --
Describes a local gateway.
LocalGatewayId (string) --
The ID of the local gateway.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The AWS account ID that owns the local gateway.
State (string) --
The state of the local gateway.
Tags (list) --
The tags assigned to the local gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_managed_prefix_lists')
Creates an iterator that will paginate through responses from EC2.Client.describe_managed_prefix_lists().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PrefixListIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more prefix list IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PrefixLists': [
{
'PrefixListId': 'string',
'AddressFamily': 'string',
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
'StateMessage': 'string',
'PrefixListArn': 'string',
'PrefixListName': 'string',
'MaxEntries': 123,
'Version': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string'
},
]
}
Response Structure
(dict) --
PrefixLists (list) --
Information about the prefix lists.
(dict) --
Describes a managed prefix list.
PrefixListId (string) --
The ID of the prefix list.
AddressFamily (string) --
The IP address version.
State (string) --
The state of the prefix list.
StateMessage (string) --
The state message.
PrefixListArn (string) --
The Amazon Resource Name (ARN) for the prefix list.
PrefixListName (string) --
The name of the prefix list.
MaxEntries (integer) --
The maximum number of entries for the prefix list.
Version (integer) --
The version of the prefix list.
Tags (list) --
The tags for the prefix list.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the owner of the prefix list.
paginator = client.get_paginator('describe_moving_addresses')
Creates an iterator that will paginate through responses from EC2.Client.describe_moving_addresses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PublicIps=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more Elastic IP addresses.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'MovingAddressStatuses': [
{
'MoveStatus': 'movingToVpc'|'restoringToClassic',
'PublicIp': 'string'
},
],
}
Response Structure
(dict) --
MovingAddressStatuses (list) --
The status for each Elastic IP address.
(dict) --
Describes the status of a moving Elastic IP address.
MoveStatus (string) --
The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.
PublicIp (string) --
The Elastic IP address.
paginator = client.get_paginator('describe_nat_gateways')
Creates an iterator that will paginate through responses from EC2.Client.describe_nat_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NatGatewayIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more NAT gateway IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NatGateways': [
{
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'FailureCode': 'string',
'FailureMessage': 'string',
'NatGatewayAddresses': [
{
'AllocationId': 'string',
'NetworkInterfaceId': 'string',
'PrivateIp': 'string',
'PublicIp': 'string'
},
],
'NatGatewayId': 'string',
'ProvisionedBandwidth': {
'ProvisionTime': datetime(2015, 1, 1),
'Provisioned': 'string',
'RequestTime': datetime(2015, 1, 1),
'Requested': 'string',
'Status': 'string'
},
'State': 'pending'|'failed'|'available'|'deleting'|'deleted',
'SubnetId': 'string',
'VpcId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConnectivityType': 'private'|'public'
},
],
}
Response Structure
(dict) --
NatGateways (list) --
Information about the NAT gateways.
(dict) --
Describes a NAT gateway.
CreateTime (datetime) --
The date and time the NAT gateway was created.
DeleteTime (datetime) --
The date and time the NAT gateway was deleted, if applicable.
FailureCode (string) --
If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound )
FailureMessage (string) --
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
NatGatewayAddresses (list) --
Information about the IP addresses and network interface associated with the NAT gateway.
(dict) --
Describes the IP addresses and network interface associated with a NAT gateway.
AllocationId (string) --
[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
NetworkInterfaceId (string) --
The ID of the network interface associated with the NAT gateway.
PrivateIp (string) --
The private IP address associated with the NAT gateway.
PublicIp (string) --
[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
NatGatewayId (string) --
The ID of the NAT gateway.
ProvisionedBandwidth (dict) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
ProvisionTime (datetime) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Provisioned (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
RequestTime (datetime) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Requested (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
Status (string) --
Reserved. If you need to sustain traffic greater than the documented limits , contact us through the Support Center .
State (string) --
The state of the NAT gateway.
SubnetId (string) --
The ID of the subnet in which the NAT gateway is located.
VpcId (string) --
The ID of the VPC in which the NAT gateway is located.
Tags (list) --
The tags for the NAT gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ConnectivityType (string) --
Indicates whether the NAT gateway supports public or private connectivity.
paginator = client.get_paginator('describe_network_acls')
Creates an iterator that will paginate through responses from EC2.Client.describe_network_acls().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NetworkAclIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more network ACL IDs.
Default: Describes all your network ACLs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NetworkAcls': [
{
'Associations': [
{
'NetworkAclAssociationId': 'string',
'NetworkAclId': 'string',
'SubnetId': 'string'
},
],
'Entries': [
{
'CidrBlock': 'string',
'Egress': True|False,
'IcmpTypeCode': {
'Code': 123,
'Type': 123
},
'Ipv6CidrBlock': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'allow'|'deny',
'RuleNumber': 123
},
],
'IsDefault': True|False,
'NetworkAclId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string',
'OwnerId': 'string'
},
],
}
Response Structure
(dict) --
NetworkAcls (list) --
Information about one or more network ACLs.
(dict) --
Describes a network ACL.
Associations (list) --
Any associations between the network ACL and one or more subnets
(dict) --
Describes an association between a network ACL and a subnet.
NetworkAclAssociationId (string) --
The ID of the association between a network ACL and a subnet.
NetworkAclId (string) --
The ID of the network ACL.
SubnetId (string) --
The ID of the subnet.
Entries (list) --
One or more entries (rules) in the network ACL.
(dict) --
Describes an entry in a network ACL.
CidrBlock (string) --
The IPv4 network range to allow or deny, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
IcmpTypeCode (dict) --
ICMP protocol: The ICMP type and code.
Code (integer) --
The ICMP code. A value of -1 means all codes for the specified ICMP type.
Type (integer) --
The ICMP type. A value of -1 means all types.
Ipv6CidrBlock (string) --
The IPv6 network range to allow or deny, in CIDR notation.
PortRange (dict) --
TCP or UDP protocols: The range of ports the rule applies to.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol number. A value of "-1" means all protocols.
RuleAction (string) --
Indicates whether to allow or deny the traffic that matches the rule.
RuleNumber (integer) --
The rule number for the entry. ACL entries are processed in ascending order by rule number.
IsDefault (boolean) --
Indicates whether this is the default network ACL for the VPC.
NetworkAclId (string) --
The ID of the network ACL.
Tags (list) --
Any tags assigned to the network ACL.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC for the network ACL.
OwnerId (string) --
The ID of the AWS account that owns the network ACL.
paginator = client.get_paginator('describe_network_insights_analyses')
Creates an iterator that will paginate through responses from EC2.Client.describe_network_insights_analyses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
NetworkInsightsAnalysisIds=[
'string',
],
NetworkInsightsPathId='string',
AnalysisStartTime=datetime(2015, 1, 1),
AnalysisEndTime=datetime(2015, 1, 1),
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
The filters. The following are possible values:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NetworkInsightsAnalyses': [
{
'NetworkInsightsAnalysisId': 'string',
'NetworkInsightsAnalysisArn': 'string',
'NetworkInsightsPathId': 'string',
'FilterInArns': [
'string',
],
'StartDate': datetime(2015, 1, 1),
'Status': 'running'|'succeeded'|'failed',
'StatusMessage': 'string',
'NetworkPathFound': True|False,
'ForwardPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Component': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': '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'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
}
},
],
'ReturnPathComponents': [
{
'SequenceNumber': 123,
'AclRule': {
'Cidr': 'string',
'Egress': True|False,
'PortRange': {
'From': 123,
'To': 123
},
'Protocol': 'string',
'RuleAction': 'string',
'RuleNumber': 123
},
'Component': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': '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'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
}
},
],
'Explanations': [
{
'Acl': {
'Id': 'string',
'Arn': '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'
},
'AvailabilityZones': [
'string',
],
'Cidrs': [
'string',
],
'Component': {
'Id': 'string',
'Arn': 'string'
},
'CustomerGateway': {
'Id': 'string',
'Arn': 'string'
},
'Destination': {
'Id': 'string',
'Arn': 'string'
},
'DestinationVpc': {
'Id': 'string',
'Arn': 'string'
},
'Direction': 'string',
'ExplanationCode': 'string',
'IngressRouteTable': {
'Id': 'string',
'Arn': 'string'
},
'InternetGateway': {
'Id': 'string',
'Arn': 'string'
},
'LoadBalancerArn': 'string',
'ClassicLoadBalancerListener': {
'LoadBalancerPort': 123,
'InstancePort': 123
},
'LoadBalancerListenerPort': 123,
'LoadBalancerTarget': {
'Address': 'string',
'AvailabilityZone': 'string',
'Instance': {
'Id': 'string',
'Arn': 'string'
},
'Port': 123
},
'LoadBalancerTargetGroup': {
'Id': 'string',
'Arn': 'string'
},
'LoadBalancerTargetGroups': [
{
'Id': 'string',
'Arn': 'string'
},
],
'LoadBalancerTargetPort': 123,
'ElasticLoadBalancerListener': {
'Id': 'string',
'Arn': 'string'
},
'MissingComponent': 'string',
'NatGateway': {
'Id': 'string',
'Arn': 'string'
},
'NetworkInterface': {
'Id': 'string',
'Arn': 'string'
},
'PacketField': 'string',
'VpcPeeringConnection': {
'Id': 'string',
'Arn': 'string'
},
'Port': 123,
'PortRanges': [
{
'From': 123,
'To': 123
},
],
'PrefixList': {
'Id': 'string',
'Arn': 'string'
},
'Protocols': [
'string',
],
'RouteTableRoute': {
'DestinationCidr': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'NatGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'string',
'TransitGatewayId': 'string',
'VpcPeeringConnectionId': 'string'
},
'RouteTable': {
'Id': 'string',
'Arn': 'string'
},
'SecurityGroup': {
'Id': 'string',
'Arn': 'string'
},
'SecurityGroupRule': {
'Cidr': 'string',
'Direction': 'string',
'SecurityGroupId': 'string',
'PortRange': {
'From': 123,
'To': 123
},
'PrefixListId': 'string',
'Protocol': 'string'
},
'SecurityGroups': [
{
'Id': 'string',
'Arn': 'string'
},
],
'SourceVpc': {
'Id': 'string',
'Arn': 'string'
},
'State': 'string',
'Subnet': {
'Id': 'string',
'Arn': 'string'
},
'SubnetRouteTable': {
'Id': 'string',
'Arn': 'string'
},
'Vpc': {
'Id': 'string',
'Arn': 'string'
},
'VpcEndpoint': {
'Id': 'string',
'Arn': 'string'
},
'VpnConnection': {
'Id': 'string',
'Arn': 'string'
},
'VpnGateway': {
'Id': 'string',
'Arn': 'string'
}
},
],
'AlternatePathHints': [
{
'ComponentId': 'string',
'ComponentArn': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
NetworkInsightsAnalyses (list) --
Information about the network insights analyses.
(dict) --
Describes a network insights analysis.
NetworkInsightsAnalysisId (string) --
The ID of the network insights analysis.
NetworkInsightsAnalysisArn (string) --
The Amazon Resource Name (ARN) of the network insights analysis.
NetworkInsightsPathId (string) --
The ID of the path.
FilterInArns (list) --
The Amazon Resource Names (ARN) of the AWS resources that the path must traverse.
StartDate (datetime) --
The time the analysis started.
Status (string) --
The status of the network insights analysis.
StatusMessage (string) --
The status message, if the status is failed .
NetworkPathFound (boolean) --
Indicates whether the destination is reachable from the source.
ForwardPathComponents (list) --
The components in the path from source to destination.
(dict) --
Describes a path component.
SequenceNumber (integer) --
The sequence number.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
OutboundHeader (dict) --
The outbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
InboundHeader (dict) --
The inbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
ReturnPathComponents (list) --
The components in the path from destination to source.
(dict) --
Describes a path component.
SequenceNumber (integer) --
The sequence number.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
OutboundHeader (dict) --
The outbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
InboundHeader (dict) --
The inbound header.
DestinationAddresses (list) --
The destination addresses.
DestinationPortRanges (list) --
The destination port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
SourceAddresses (list) --
The source addresses.
SourcePortRanges (list) --
The source port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Explanations (list) --
The explanations. For more information, see Reachability Analyzer explanation codes .
(dict) --
Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes .
Acl (dict) --
The network ACL.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AclRule (dict) --
The network ACL rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an outbound rule.
PortRange (dict) --
The range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol.
RuleAction (string) --
Indicates whether to allow or deny traffic that matches the rule.
RuleNumber (integer) --
The rule number.
Address (string) --
The IPv4 address, in CIDR notation.
Addresses (list) --
The IPv4 addresses, in CIDR notation.
AttachedTo (dict) --
The resource to which the component is attached.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AvailabilityZones (list) --
The Availability Zones.
Cidrs (list) --
The CIDR ranges.
Component (dict) --
The component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
CustomerGateway (dict) --
The customer gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Destination (dict) --
The destination.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
DestinationVpc (dict) --
The destination VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Direction (string) --
The direction. The following are possible values:
ExplanationCode (string) --
The explanation code.
IngressRouteTable (dict) --
The route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
InternetGateway (dict) --
The internet gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the load balancer.
ClassicLoadBalancerListener (dict) --
The listener for a Classic Load Balancer.
LoadBalancerPort (integer) --
The port on which the load balancer is listening.
InstancePort (integer) --
[Classic Load Balancers] The back-end port for the listener.
LoadBalancerListenerPort (integer) --
The listener port of the load balancer.
LoadBalancerTarget (dict) --
The target.
Address (string) --
The IP address.
AvailabilityZone (string) --
The Availability Zone.
Instance (dict) --
Information about the instance.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Port (integer) --
The port on which the target is listening.
LoadBalancerTargetGroup (dict) --
The target group.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerTargetGroups (list) --
The target groups.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
LoadBalancerTargetPort (integer) --
The target port.
ElasticLoadBalancerListener (dict) --
The load balancer listener.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
MissingComponent (string) --
The missing component.
NatGateway (dict) --
The NAT gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
NetworkInterface (dict) --
The network interface.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
PacketField (string) --
The packet field.
VpcPeeringConnection (dict) --
The VPC peering connection.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Port (integer) --
The port.
PortRanges (list) --
The port ranges.
(dict) --
Describes a range of ports.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixList (dict) --
The prefix list.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Protocols (list) --
The protocols.
RouteTableRoute (dict) --
The route table route.
DestinationCidr (string) --
The destination IPv4 address, in CIDR notation.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of an egress-only internet gateway.
GatewayId (string) --
The ID of the gateway, such as an internet gateway or virtual private gateway.
InstanceId (string) --
The ID of the instance, such as a NAT instance.
NatGatewayId (string) --
The ID of a NAT gateway.
NetworkInterfaceId (string) --
The ID of a network interface.
Origin (string) --
Describes how the route was created. The following are possible values:
TransitGatewayId (string) --
The ID of a transit gateway.
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
RouteTable (dict) --
The route table.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SecurityGroup (dict) --
The security group.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SecurityGroupRule (dict) --
The security group rule.
Cidr (string) --
The IPv4 address range, in CIDR notation.
Direction (string) --
The direction. The following are possible values:
SecurityGroupId (string) --
The security group ID.
PortRange (dict) --
The port range.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
PrefixListId (string) --
The prefix list ID.
Protocol (string) --
The protocol name.
SecurityGroups (list) --
The security groups.
(dict) --
Describes a path component.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SourceVpc (dict) --
The source VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
State (string) --
The state.
Subnet (dict) --
The subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
SubnetRouteTable (dict) --
The route table for the subnet.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
Vpc (dict) --
The component VPC.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpcEndpoint (dict) --
The VPC endpoint.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpnConnection (dict) --
The VPN connection.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
VpnGateway (dict) --
The VPN gateway.
Id (string) --
The ID of the component.
Arn (string) --
The Amazon Resource Name (ARN) of the component.
AlternatePathHints (list) --
Potential intermediate components.
(dict) --
Describes an potential intermediate component of a feasible path.
ComponentId (string) --
The ID of the component.
ComponentArn (string) --
The Amazon Resource Name (ARN) of the component.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_network_insights_paths')
Creates an iterator that will paginate through responses from EC2.Client.describe_network_insights_paths().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
NetworkInsightsPathIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the paths.
The filters. The following are possible values:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NetworkInsightsPaths': [
{
'NetworkInsightsPathId': 'string',
'NetworkInsightsPathArn': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Source': 'string',
'Destination': 'string',
'SourceIp': 'string',
'DestinationIp': 'string',
'Protocol': 'tcp'|'udp',
'DestinationPort': 123,
'Tags': [
{
'Key': 'string',
'Value': '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 AWS resource that is the source of the path.
Destination (string) --
The AWS resource that is the destination of the path.
SourceIp (string) --
The IP address of the AWS resource that is the source of the path.
DestinationIp (string) --
The IP address of the AWS 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 255 Unicode characters.
paginator = client.get_paginator('describe_network_interface_permissions')
Creates an iterator that will paginate through responses from EC2.Client.describe_network_interface_permissions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
NetworkInterfacePermissionIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more network interface permission IDs.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NetworkInterfacePermissions': [
{
'NetworkInterfacePermissionId': 'string',
'NetworkInterfaceId': 'string',
'AwsAccountId': 'string',
'AwsService': 'string',
'Permission': 'INSTANCE-ATTACH'|'EIP-ASSOCIATE',
'PermissionState': {
'State': 'pending'|'granted'|'revoking'|'revoked',
'StatusMessage': 'string'
}
},
],
}
Response Structure
(dict) --
Contains the output for DescribeNetworkInterfacePermissions.
NetworkInterfacePermissions (list) --
The network interface permissions.
(dict) --
Describes a permission for a network interface.
NetworkInterfacePermissionId (string) --
The ID of the network interface permission.
NetworkInterfaceId (string) --
The ID of the network interface.
AwsAccountId (string) --
The account ID.
AwsService (string) --
The Amazon Web Service.
Permission (string) --
The type of permission.
PermissionState (dict) --
Information about the state of the permission.
State (string) --
The state of the permission.
StatusMessage (string) --
A status message, if applicable.
paginator = client.get_paginator('describe_network_interfaces')
Creates an iterator that will paginate through responses from EC2.Client.describe_network_interfaces().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NetworkInterfaceIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more network interface IDs.
Default: Describes all your network interfaces.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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'
},
'AvailabilityZone': 'string',
'Description': 'string',
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa'|'trunk',
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Association': {
'AllocationId': 'string',
'AssociationId': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string',
'CustomerOwnedIp': 'string',
'CarrierIp': 'string'
},
'Primary': True|False,
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string'
},
],
'RequesterId': 'string',
'RequesterManaged': True|False,
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'TagSet': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
],
}
Response Structure
(dict) --
Contains the output of 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 account ID of the owner of the instance.
Status (string) --
The attachment state.
AvailabilityZone (string) --
The Availability Zone.
Description (string) --
A description.
Groups (list) --
Any security groups for the network interface.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
InterfaceType (string) --
The type of network interface.
Ipv6Addresses (list) --
The IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address associated with a network interface.
Ipv6Address (string) --
The IPv6 address.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The 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.
RequesterId (string) --
The alias or 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 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
paginator = client.get_paginator('describe_prefix_lists')
Creates an iterator that will paginate through responses from EC2.Client.describe_prefix_lists().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PrefixListIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more prefix list IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PrefixLists': [
{
'Cidrs': [
'string',
],
'PrefixListId': 'string',
'PrefixListName': 'string'
},
]
}
Response Structure
(dict) --
PrefixLists (list) --
All available prefix lists.
(dict) --
Describes prefixes for Amazon Web Services services.
Cidrs (list) --
The IP address range of the Amazon Web Service.
PrefixListId (string) --
The ID of the prefix.
PrefixListName (string) --
The name of the prefix.
paginator = client.get_paginator('describe_principal_id_format')
Creates an iterator that will paginate through responses from EC2.Client.describe_principal_id_format().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Resources=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Principals': [
{
'Arn': 'string',
'Statuses': [
{
'Deadline': datetime(2015, 1, 1),
'Resource': 'string',
'UseLongIds': True|False
},
]
},
],
}
Response Structure
(dict) --
Principals (list) --
Information about the ID format settings for the ARN.
(dict) --
PrincipalIdFormat description
Arn (string) --
PrincipalIdFormatARN description
Statuses (list) --
PrincipalIdFormatStatuses description
(dict) --
Describes the ID format for a resource.
Deadline (datetime) --
The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
Resource (string) --
The type of resource.
UseLongIds (boolean) --
Indicates whether longer IDs (17-character IDs) are enabled for the resource.
paginator = client.get_paginator('describe_public_ipv4_pools')
Creates an iterator that will paginate through responses from EC2.Client.describe_public_ipv4_pools().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PoolIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the address pools.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PublicIpv4Pools': [
{
'PoolId': 'string',
'Description': 'string',
'PoolAddressRanges': [
{
'FirstAddress': 'string',
'LastAddress': 'string',
'AddressCount': 123,
'AvailableAddressCount': 123
},
],
'TotalAddressCount': 123,
'TotalAvailableAddressCount': 123,
'NetworkBorderGroup': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
PublicIpv4Pools (list) --
Information about the address pools.
(dict) --
Describes an IPv4 address pool.
PoolId (string) --
The ID of the address pool.
Description (string) --
A description of the address pool.
PoolAddressRanges (list) --
The address ranges.
(dict) --
Describes an address range of an IPv4 address pool.
FirstAddress (string) --
The first IP address in the range.
LastAddress (string) --
The last IP address in the range.
AddressCount (integer) --
The number of addresses in the range.
AvailableAddressCount (integer) --
The number of available addresses in the range.
TotalAddressCount (integer) --
The total number of addresses.
TotalAvailableAddressCount (integer) --
The total number of available addresses.
NetworkBorderGroup (string) --
The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.
Tags (list) --
Any tags for the address pool.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_replace_root_volume_tasks')
Creates an iterator that will paginate through responses from EC2.Client.describe_replace_root_volume_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReplaceRootVolumeTaskIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the root volume replacement task to view.
Filter to use:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReplaceRootVolumeTasks': [
{
'ReplaceRootVolumeTaskId': 'string',
'InstanceId': 'string',
'TaskState': 'pending'|'in-progress'|'failing'|'succeeded'|'failed'|'failed-detached',
'StartTime': 'string',
'CompleteTime': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
ReplaceRootVolumeTasks (list) --
Information about the root volume replacement task.
(dict) --
Information about a root volume replacement task.
ReplaceRootVolumeTaskId (string) --
The ID of the root volume replacement task.
InstanceId (string) --
The ID of the instance for which the root volume replacement task was created.
TaskState (string) --
The state of the task. The task can be in one of the following states:
StartTime (string) --
The time the task was started.
CompleteTime (string) --
The time the task completed.
Tags (list) --
The tags assigned to the task.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_reserved_instances_modifications')
Creates an iterator that will paginate through responses from EC2.Client.describe_reserved_instances_modifications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ReservedInstancesModificationIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
IDs for the submitted modification request.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReservedInstancesModifications': [
{
'ClientToken': 'string',
'CreateDate': datetime(2015, 1, 1),
'EffectiveDate': datetime(2015, 1, 1),
'ModificationResults': [
{
'ReservedInstancesId': 'string',
'TargetConfiguration': {
'AvailabilityZone': 'string',
'InstanceCount': 123,
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'Platform': 'string',
'Scope': 'Availability Zone'|'Region'
}
},
],
'ReservedInstancesIds': [
{
'ReservedInstancesId': 'string'
},
],
'ReservedInstancesModificationId': 'string',
'Status': 'string',
'StatusMessage': 'string',
'UpdateDate': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Contains the output of DescribeReservedInstancesModifications.
ReservedInstancesModifications (list) --
The Reserved Instance modification information.
(dict) --
Describes a Reserved Instance modification.
ClientToken (string) --
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency .
CreateDate (datetime) --
The time when the modification request was created.
EffectiveDate (datetime) --
The time for the modification to become effective.
ModificationResults (list) --
Contains target configurations along with their corresponding new Reserved Instance IDs.
(dict) --
Describes the modification request/s.
ReservedInstancesId (string) --
The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
TargetConfiguration (dict) --
The target Reserved Instances configurations supplied as part of the modification request.
AvailabilityZone (string) --
The Availability Zone for the modified Reserved Instances.
InstanceCount (integer) --
The number of modified Reserved Instances.
Note
This is a required field for a request.
InstanceType (string) --
The instance type for the modified Reserved Instances.
Platform (string) --
The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
Scope (string) --
Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
ReservedInstancesIds (list) --
The IDs of one or more Reserved Instances.
(dict) --
Describes the ID of a Reserved Instance.
ReservedInstancesId (string) --
The ID of the Reserved Instance.
ReservedInstancesModificationId (string) --
A unique ID for the Reserved Instance modification.
Status (string) --
The status of the Reserved Instances modification request.
StatusMessage (string) --
The reason for the status.
UpdateDate (datetime) --
The time when the modification request was last updated.
paginator = client.get_paginator('describe_reserved_instances_offerings')
Creates an iterator that will paginate through responses from EC2.Client.describe_reserved_instances_offerings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AvailabilityZone='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeMarketplace=True|False,
InstanceType='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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
MaxDuration=123,
MaxInstanceCount=123,
MinDuration=123,
OfferingClass='standard'|'convertible',
ProductDescription='Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
ReservedInstancesOfferingIds=[
'string',
],
DryRun=True|False,
InstanceTenancy='default'|'dedicated'|'host',
OfferingType='Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
The maximum number of instances to filter when searching for offerings.
Default: 20
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
One or more Reserved Instances offering IDs.
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReservedInstancesOfferings': [
{
'AvailabilityZone': 'string',
'Duration': 123,
'FixedPrice': ...,
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
'ReservedInstancesOfferingId': 'string',
'UsagePrice': ...,
'CurrencyCode': 'USD',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Marketplace': True|False,
'OfferingClass': 'standard'|'convertible',
'OfferingType': 'Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront',
'PricingDetails': [
{
'Count': 123,
'Price': 123.0
},
],
'RecurringCharges': [
{
'Amount': 123.0,
'Frequency': 'Hourly'
},
],
'Scope': 'Availability Zone'|'Region'
},
],
}
Response Structure
(dict) --
Contains the output of DescribeReservedInstancesOfferings.
ReservedInstancesOfferings (list) --
A list of Reserved Instances offerings.
(dict) --
Describes a Reserved Instance offering.
AvailabilityZone (string) --
The Availability Zone in which the Reserved Instance can be used.
Duration (integer) --
The duration of the Reserved Instance, in seconds.
FixedPrice (float) --
The purchase price of the Reserved Instance.
InstanceType (string) --
The instance type on which the Reserved Instance can be used.
ProductDescription (string) --
The Reserved Instance product platform description.
ReservedInstancesOfferingId (string) --
The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
UsagePrice (float) --
The usage price of the Reserved Instance, per hour.
CurrencyCode (string) --
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD .
InstanceTenancy (string) --
The tenancy of the instance.
Marketplace (boolean) --
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is true .
OfferingClass (string) --
If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard , it is not possible to perform an exchange.
OfferingType (string) --
The Reserved Instance offering type.
PricingDetails (list) --
The pricing details of the Reserved Instance offering.
(dict) --
Describes a Reserved Instance offering.
Count (integer) --
The number of reservations available for the price.
Price (float) --
The price per instance.
RecurringCharges (list) --
The recurring charge tag assigned to the resource.
(dict) --
Describes a recurring charge.
Amount (float) --
The amount of the recurring charge.
Frequency (string) --
The frequency of the recurring charge.
Scope (string) --
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
paginator = client.get_paginator('describe_route_tables')
Creates an iterator that will paginate through responses from EC2.Client.describe_route_tables().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
RouteTableIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more route table IDs.
Default: Describes all your route tables.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RouteTables': [
{
'Associations': [
{
'Main': True|False,
'RouteTableAssociationId': 'string',
'RouteTableId': 'string',
'SubnetId': 'string',
'GatewayId': 'string',
'AssociationState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failed',
'StatusMessage': 'string'
}
},
],
'PropagatingVgws': [
{
'GatewayId': 'string'
},
],
'RouteTableId': 'string',
'Routes': [
{
'DestinationCidrBlock': 'string',
'DestinationIpv6CidrBlock': 'string',
'DestinationPrefixListId': 'string',
'EgressOnlyInternetGatewayId': 'string',
'GatewayId': 'string',
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'NatGatewayId': 'string',
'TransitGatewayId': 'string',
'LocalGatewayId': 'string',
'CarrierGatewayId': 'string',
'NetworkInterfaceId': 'string',
'Origin': 'CreateRouteTable'|'CreateRoute'|'EnableVgwRoutePropagation',
'State': 'active'|'blackhole',
'VpcPeeringConnectionId': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string',
'OwnerId': 'string'
},
],
}
Response Structure
(dict) --
Contains the output of DescribeRouteTables.
RouteTables (list) --
Information about one or more route tables.
(dict) --
Describes a route table.
Associations (list) --
The associations between the route table and one or more subnets or a gateway.
(dict) --
Describes an association between a route table and a subnet or gateway.
Main (boolean) --
Indicates whether this is the main route table.
RouteTableAssociationId (string) --
The ID of the association.
RouteTableId (string) --
The ID of the route table.
SubnetId (string) --
The ID of the subnet. A subnet ID is not returned for an implicit association.
GatewayId (string) --
The ID of the internet gateway or virtual private gateway.
AssociationState (dict) --
The state of the association.
State (string) --
The state of the association.
StatusMessage (string) --
The status message, if applicable.
PropagatingVgws (list) --
Any virtual private gateway (VGW) propagating routes.
(dict) --
Describes a virtual private gateway propagating route.
GatewayId (string) --
The ID of the virtual private gateway.
RouteTableId (string) --
The ID of the route table.
Routes (list) --
The routes in the route table.
(dict) --
Describes a route in a route table.
DestinationCidrBlock (string) --
The IPv4 CIDR block used for the destination match.
DestinationIpv6CidrBlock (string) --
The IPv6 CIDR block used for the destination match.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of the egress-only internet gateway.
GatewayId (string) --
The ID of a gateway attached to your VPC.
InstanceId (string) --
The ID of a NAT instance in your VPC.
InstanceOwnerId (string) --
The AWS account ID of the owner of the instance.
NatGatewayId (string) --
The ID of a NAT gateway.
TransitGatewayId (string) --
The ID of a transit gateway.
LocalGatewayId (string) --
The ID of the local gateway.
CarrierGatewayId (string) --
The ID of the carrier gateway.
NetworkInterfaceId (string) --
The ID of the network interface.
Origin (string) --
Describes how the route was created.
State (string) --
The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
Tags (list) --
Any tags assigned to the route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The ID of the AWS account that owns the route table.
paginator = client.get_paginator('describe_scheduled_instance_availability')
Creates an iterator that will paginate through responses from EC2.Client.describe_scheduled_instance_availability().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
FirstSlotStartTimeRange={
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
MaxSlotDurationInHours=123,
MinSlotDurationInHours=123,
Recurrence={
'Frequency': 'string',
'Interval': 123,
'OccurrenceDays': [
123,
],
'OccurrenceRelativeToEnd': True|False,
'OccurrenceUnit': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
[REQUIRED]
The time period for the first schedule to start.
The earliest date and time, in UTC, for the Scheduled Instance to start.
The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
[REQUIRED]
The schedule recurrence.
The frequency (Daily , Weekly , or Monthly ).
The interval quantity. The interval unit depends on the value of Frequency . For example, every 2 weeks or every 2 months.
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
The unit for OccurrenceDays (DayOfWeek or DayOfMonth ). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ScheduledInstanceAvailabilitySet': [
{
'AvailabilityZone': 'string',
'AvailableInstanceCount': 123,
'FirstSlotStartTime': datetime(2015, 1, 1),
'HourlyPrice': 'string',
'InstanceType': 'string',
'MaxTermDurationInDays': 123,
'MinTermDurationInDays': 123,
'NetworkPlatform': 'string',
'Platform': 'string',
'PurchaseToken': 'string',
'Recurrence': {
'Frequency': 'string',
'Interval': 123,
'OccurrenceDaySet': [
123,
],
'OccurrenceRelativeToEnd': True|False,
'OccurrenceUnit': 'string'
},
'SlotDurationInHours': 123,
'TotalScheduledInstanceHours': 123
},
]
}
Response Structure
(dict) --
Contains the output of DescribeScheduledInstanceAvailability.
ScheduledInstanceAvailabilitySet (list) --
Information about the available Scheduled Instances.
(dict) --
Describes a schedule that is available for your Scheduled Instances.
AvailabilityZone (string) --
The Availability Zone.
AvailableInstanceCount (integer) --
The number of available instances.
FirstSlotStartTime (datetime) --
The time period for the first schedule to start.
HourlyPrice (string) --
The hourly price for a single instance.
InstanceType (string) --
The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
MaxTermDurationInDays (integer) --
The maximum term. The only possible value is 365 days.
MinTermDurationInDays (integer) --
The minimum term. The only possible value is 365 days.
NetworkPlatform (string) --
The network platform (EC2-Classic or EC2-VPC ).
Platform (string) --
The platform (Linux/UNIX or Windows ).
PurchaseToken (string) --
The purchase token. This token expires in two hours.
Recurrence (dict) --
The schedule recurrence.
Frequency (string) --
The frequency (Daily , Weekly , or Monthly ).
Interval (integer) --
The interval quantity. The interval unit depends on the value of frequency . For example, every 2 weeks or every 2 months.
OccurrenceDaySet (list) --
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
OccurrenceRelativeToEnd (boolean) --
Indicates whether the occurrence is relative to the end of the specified week or month.
OccurrenceUnit (string) --
The unit for occurrenceDaySet (DayOfWeek or DayOfMonth ).
SlotDurationInHours (integer) --
The number of hours in the schedule.
TotalScheduledInstanceHours (integer) --
The total number of hours for a single instance for the entire term.
paginator = client.get_paginator('describe_scheduled_instances')
Creates an iterator that will paginate through responses from EC2.Client.describe_scheduled_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ScheduledInstanceIds=[
'string',
],
SlotStartTimeRange={
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The Scheduled Instance IDs.
The time period for the first schedule to start.
The earliest date and time, in UTC, for the Scheduled Instance to start.
The latest date and time, in UTC, for the Scheduled Instance to start.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ScheduledInstanceSet': [
{
'AvailabilityZone': 'string',
'CreateDate': datetime(2015, 1, 1),
'HourlyPrice': 'string',
'InstanceCount': 123,
'InstanceType': 'string',
'NetworkPlatform': 'string',
'NextSlotStartTime': datetime(2015, 1, 1),
'Platform': 'string',
'PreviousSlotEndTime': datetime(2015, 1, 1),
'Recurrence': {
'Frequency': 'string',
'Interval': 123,
'OccurrenceDaySet': [
123,
],
'OccurrenceRelativeToEnd': True|False,
'OccurrenceUnit': 'string'
},
'ScheduledInstanceId': 'string',
'SlotDurationInHours': 123,
'TermEndDate': datetime(2015, 1, 1),
'TermStartDate': datetime(2015, 1, 1),
'TotalScheduledInstanceHours': 123
},
]
}
Response Structure
(dict) --
Contains the output of DescribeScheduledInstances.
ScheduledInstanceSet (list) --
Information about the Scheduled Instances.
(dict) --
Describes a Scheduled Instance.
AvailabilityZone (string) --
The Availability Zone.
CreateDate (datetime) --
The date when the Scheduled Instance was purchased.
HourlyPrice (string) --
The hourly price for a single instance.
InstanceCount (integer) --
The number of instances.
InstanceType (string) --
The instance type.
NetworkPlatform (string) --
The network platform (EC2-Classic or EC2-VPC ).
NextSlotStartTime (datetime) --
The time for the next schedule to start.
Platform (string) --
The platform (Linux/UNIX or Windows ).
PreviousSlotEndTime (datetime) --
The time that the previous schedule ended or will end.
Recurrence (dict) --
The schedule recurrence.
Frequency (string) --
The frequency (Daily , Weekly , or Monthly ).
Interval (integer) --
The interval quantity. The interval unit depends on the value of frequency . For example, every 2 weeks or every 2 months.
OccurrenceDaySet (list) --
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
OccurrenceRelativeToEnd (boolean) --
Indicates whether the occurrence is relative to the end of the specified week or month.
OccurrenceUnit (string) --
The unit for occurrenceDaySet (DayOfWeek or DayOfMonth ).
ScheduledInstanceId (string) --
The Scheduled Instance ID.
SlotDurationInHours (integer) --
The number of hours in the schedule.
TermEndDate (datetime) --
The end date for the Scheduled Instance.
TermStartDate (datetime) --
The start date for the Scheduled Instance.
TotalScheduledInstanceHours (integer) --
The total number of hours for a single instance for the entire term.
paginator = client.get_paginator('describe_security_group_rules')
Creates an iterator that will paginate through responses from EC2.Client.describe_security_group_rules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
SecurityGroupRuleIds=[
'string',
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the security group rules.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SecurityGroupRules': [
{
'SecurityGroupRuleId': 'string',
'GroupId': 'string',
'GroupOwnerId': 'string',
'IsEgress': True|False,
'IpProtocol': 'string',
'FromPort': 123,
'ToPort': 123,
'CidrIpv4': 'string',
'CidrIpv6': 'string',
'PrefixListId': 'string',
'ReferencedGroupInfo': {
'GroupId': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
SecurityGroupRules (list) --
Information about security group rules.
(dict) --
Describes a security group rule.
SecurityGroupRuleId (string) --
The ID of the security group rule.
GroupId (string) --
The ID of the security group.
GroupOwnerId (string) --
The ID of the account that owns the security group.
IsEgress (boolean) --
Indicates whether the security group rule is an outbound rule.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
Use -1 to specify all protocols.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
CidrIpv4 (string) --
The IPv4 CIDR range.
CidrIpv6 (string) --
The IPv6 CIDR range.
PrefixListId (string) --
The ID of the prefix list.
ReferencedGroupInfo (dict) --
Describes the security group that is referenced in the rule.
GroupId (string) --
The ID of the security group.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The account ID.
VpcId (string) --
The ID of the VPC.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Description (string) --
The security group rule description.
Tags (list) --
The tags applied to the security group rule.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_security_groups')
Creates an iterator that will paginate through responses from EC2.Client.describe_security_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
GroupIds=[
'string',
],
GroupNames=[
'string',
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SecurityGroups': [
{
'Description': 'string',
'GroupName': 'string',
'IpPermissions': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
'OwnerId': 'string',
'GroupId': 'string',
'IpPermissionsEgress': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string'
},
],
}
Response Structure
(dict) --
SecurityGroups (list) --
Information about the security groups.
(dict) --
Describes a security group.
Description (string) --
A description of the security group.
GroupName (string) --
The name of the security group.
IpPermissions (list) --
The inbound rules associated with the security group.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the security group.
GroupId (string) --
The ID of the security group.
IpPermissionsEgress (list) --
[VPC only] The outbound rules associated with the security group.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
Tags (list) --
Any tags assigned to the security group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcId (string) --
[VPC only] The ID of the VPC for the security group.
paginator = client.get_paginator('describe_snapshots')
Creates an iterator that will paginate through responses from EC2.Client.describe_snapshots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
OwnerIds=[
'string',
],
RestorableByUserIds=[
'string',
],
SnapshotIds=[
'string',
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self , and amazon .
The IDs of the AWS accounts that can create volumes from the snapshot.
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Snapshots': [
{
'DataEncryptionKeyId': 'string',
'Description': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'OwnerId': 'string',
'Progress': 'string',
'SnapshotId': 'string',
'StartTime': datetime(2015, 1, 1),
'State': 'pending'|'completed'|'error',
'StateMessage': 'string',
'VolumeId': 'string',
'VolumeSize': 123,
'OwnerAlias': 'string',
'OutpostArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Snapshots (list) --
Information about the snapshots.
(dict) --
Describes a snapshot.
DataEncryptionKeyId (string) --
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots .
Description (string) --
The description for the snapshot.
Encrypted (boolean) --
Indicates whether the snapshot is encrypted.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
OwnerId (string) --
The AWS account ID of the EBS snapshot owner.
Progress (string) --
The progress of the snapshot, as a percentage.
SnapshotId (string) --
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
StartTime (datetime) --
The time stamp when the snapshot was initiated.
State (string) --
The snapshot state.
StateMessage (string) --
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots .
VolumeId (string) --
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
VolumeSize (integer) --
The size of the volume, in GiB.
OwnerAlias (string) --
The AWS owner alias, from an Amazon-maintained list (amazon ). This is not the user-configured AWS account alias set using the IAM console.
OutpostArn (string) --
The ARN of the AWS Outpost on which the snapshot is stored. For more information, see EBS Local Snapshot on Outposts in the Amazon Elastic Compute Cloud User Guide .
Tags (list) --
Any tags assigned to the snapshot.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_spot_fleet_instances')
Creates an iterator that will paginate through responses from EC2.Client.describe_spot_fleet_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
SpotFleetRequestId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the Spot Fleet request.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ActiveInstances': [
{
'InstanceId': 'string',
'InstanceType': 'string',
'SpotInstanceRequestId': 'string',
'InstanceHealth': 'healthy'|'unhealthy'
},
],
'SpotFleetRequestId': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeSpotFleetInstances.
ActiveInstances (list) --
The running instances. This list is refreshed periodically and might be out of date.
(dict) --
Describes a running instance in a Spot Fleet.
InstanceId (string) --
The ID of the instance.
InstanceType (string) --
The instance type.
SpotInstanceRequestId (string) --
The ID of the Spot Instance request.
InstanceHealth (string) --
The health status of the instance. If the status of either the instance status check or the system status check is impaired , the health status of the instance is unhealthy . Otherwise, the health status is healthy .
SpotFleetRequestId (string) --
The ID of the Spot Fleet request.
paginator = client.get_paginator('describe_spot_fleet_requests')
Creates an iterator that will paginate through responses from EC2.Client.describe_spot_fleet_requests().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
SpotFleetRequestIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the Spot Fleet requests.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SpotFleetRequestConfigs': [
{
'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled',
'CreateTime': datetime(2015, 1, 1),
'SpotFleetRequestConfig': {
'AllocationStrategy': 'lowestPrice'|'diversified'|'capacityOptimized'|'capacityOptimizedPrioritized',
'OnDemandAllocationStrategy': 'lowestPrice'|'prioritized',
'SpotMaintenanceStrategies': {
'CapacityRebalance': {
'ReplacementStrategy': 'launch'
}
},
'ClientToken': 'string',
'ExcessCapacityTerminationPolicy': 'noTermination'|'default',
'FulfilledCapacity': 123.0,
'OnDemandFulfilledCapacity': 123.0,
'IamFleetRole': 'string',
'LaunchSpecifications': [
{
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'AddressingType': 'string',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'Monitoring': {
'Enabled': True|False
},
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'RamdiskId': 'string',
'SpotPrice': 'string',
'SubnetId': 'string',
'UserData': 'string',
'WeightedCapacity': 123.0,
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
],
'LaunchTemplateConfigs': [
{
'LaunchTemplateSpecification': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
'Overrides': [
{
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'SpotPrice': 'string',
'SubnetId': 'string',
'AvailabilityZone': 'string',
'WeightedCapacity': 123.0,
'Priority': 123.0
},
]
},
],
'SpotPrice': 'string',
'TargetCapacity': 123,
'OnDemandTargetCapacity': 123,
'OnDemandMaxTotalPrice': 'string',
'SpotMaxTotalPrice': 'string',
'TerminateInstancesWithExpiration': True|False,
'Type': 'request'|'maintain'|'instant',
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'ReplaceUnhealthyInstances': True|False,
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
'LoadBalancersConfig': {
'ClassicLoadBalancersConfig': {
'ClassicLoadBalancers': [
{
'Name': 'string'
},
]
},
'TargetGroupsConfig': {
'TargetGroups': [
{
'Arn': 'string'
},
]
}
},
'InstancePoolsToUseCount': 123,
'Context': 'string',
'TagSpecifications': [
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'SpotFleetRequestId': 'string',
'SpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the output of DescribeSpotFleetRequests.
SpotFleetRequestConfigs (list) --
Information about the configuration of your Spot Fleet.
(dict) --
Describes a Spot Fleet request.
ActivityStatus (string) --
The progress of the Spot Fleet request. If there is an error, the status is error . After all requests are placed, the status is pending_fulfillment . If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.
CreateTime (datetime) --
The creation date and time of the request.
SpotFleetRequestConfig (dict) --
The configuration of the Spot Fleet request.
AllocationStrategy (string) --
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.
If the allocation strategy is lowestPrice , Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified , Spot Fleet launches instances from all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.
OnDemandAllocationStrategy (string) --
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice .
SpotMaintenanceStrategies (dict) --
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
CapacityRebalance (dict) --
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
ReplacementStrategy (string) --
The replacement strategy to use. Only available for fleets of type maintain . You must specify a value, otherwise you get an error.
To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for a Spot Instance in the fleet, specify launch .
Note
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
ClientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency .
ExcessCapacityTerminationPolicy (string) --
Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
FulfilledCapacity (float) --
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
OnDemandFulfilledCapacity (float) --
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
IamFleetRole (string) --
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration .
LaunchSpecifications (list) --
The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications , you can't specify LaunchTemplateConfigs . If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs .
(dict) --
Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use SpotFleetLaunchSpecification ; you must use LaunchTemplateConfig .
SecurityGroups (list) --
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
AddressingType (string) --
Deprecated.
BlockDeviceMappings (list) --
One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
EbsOptimized (boolean) --
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
ImageId (string) --
The ID of the AMI.
InstanceType (string) --
The instance type.
KernelId (string) --
The ID of the kernel.
KeyName (string) --
The name of the key pair.
Monitoring (dict) --
Enable or disable monitoring for the instances.
Enabled (boolean) --
Enables monitoring for the instance.
Default: false
NetworkInterfaces (list) --
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
Note
SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig .
(dict) --
Describes a network interface.
AssociatePublicIpAddress (boolean) --
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
DeleteOnTermination (boolean) --
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
Description (string) --
The description of the network interface. Applies only if creating a network interface when launching an instance.
DeviceIndex (integer) --
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
Groups (list) --
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
Ipv6AddressCount (integer) --
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
Ipv6Addresses (list) --
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
PrivateIpAddress (string) --
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
PrivateIpAddresses (list) --
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
SubnetId (string) --
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
AssociateCarrierIpAddress (boolean) --
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
InterfaceType (string) --
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
NetworkCardIndex (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.
Placement (dict) --
The placement information.
AvailabilityZone (string) --
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
GroupName (string) --
The name of the placement group.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
RamdiskId (string) --
The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
SpotPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity .
SubnetId (string) --
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
UserData (string) --
The Base64-encoded user data that instances use when starting up.
WeightedCapacity (float) --
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
TagSpecifications (list) --
The tags to apply during creation.
(dict) --
The tags for a Spot Fleet resource.
ResourceType (string) --
The type of resource. Currently, the only resource type that is supported is instance . To tag the Spot Fleet request on creation, use the TagSpecifications parameter in ` SpotFleetRequestConfigData https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html`__ .
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
LaunchTemplateConfigs (list) --
The launch template and overrides. If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications . If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs .
(dict) --
Describes a launch template and overrides.
LaunchTemplateSpecification (dict) --
The launch template.
LaunchTemplateId (string) --
The ID of the launch template. If you specify the template ID, you can't specify the template name.
LaunchTemplateName (string) --
The name of the launch template. If you specify the template name, you can't specify the template ID.
Version (string) --
The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.
If the value is $Latest , Amazon EC2 uses the latest version of the launch template.
If the value is $Default , Amazon EC2 uses the default version of the launch template.
Overrides (list) --
Any parameters that you specify override the same parameters in the launch template.
(dict) --
Describes overrides for a launch template.
InstanceType (string) --
The instance type.
SpotPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance.
SubnetId (string) --
The ID of the subnet in which to launch the instances.
AvailabilityZone (string) --
The Availability Zone in which to launch the instances.
WeightedCapacity (float) --
The number of units provided by the specified instance type.
Priority (float) --
The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized , Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized , Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
SpotPrice (string) --
The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
TargetCapacity (integer) --
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
OnDemandTargetCapacity (integer) --
The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
OnDemandMaxTotalPrice (string) --
The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
SpotMaxTotalPrice (string) --
The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
TerminateInstancesWithExpiration (boolean) --
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
Type (string) --
The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain . instant is listed but is not used by Spot Fleet.
ValidFrom (datetime) --
The start date and time of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). By default, Amazon EC2 starts fulfilling the request immediately.
ValidUntil (datetime) --
The end date and time of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
ReplaceUnhealthyInstances (boolean) --
Indicates whether Spot Fleet should replace unhealthy instances.
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted. The default is terminate .
LoadBalancersConfig (dict) --
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
ClassicLoadBalancersConfig (dict) --
The Classic Load Balancers.
ClassicLoadBalancers (list) --
One or more Classic Load Balancers.
(dict) --
Describes a Classic Load Balancer.
Name (string) --
The name of the load balancer.
TargetGroupsConfig (dict) --
The target groups.
TargetGroups (list) --
One or more target groups.
(dict) --
Describes a load balancer target group.
Arn (string) --
The Amazon Resource Name (ARN) of the target group.
InstancePoolsToUseCount (integer) --
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
Context (string) --
Reserved.
TagSpecifications (list) --
The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs ) or in the ` SpotFleetTagSpecification https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html`__ (valid only if you use LaunchSpecifications ). For information about tagging after launch, see Tagging Your Resources .
(dict) --
The tags to apply to a resource when the resource is being created.
ResourceType (string) --
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
SpotFleetRequestId (string) --
The ID of the Spot Fleet request.
SpotFleetRequestState (string) --
The state of the Spot Fleet request.
Tags (list) --
The tags for a Spot Fleet resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_spot_instance_requests')
Creates an iterator that will paginate through responses from EC2.Client.describe_spot_instance_requests().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
SpotInstanceRequestIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more Spot Instance request IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SpotInstanceRequests': [
{
'ActualBlockHourlyPrice': 'string',
'AvailabilityZoneGroup': 'string',
'BlockDurationMinutes': 123,
'CreateTime': datetime(2015, 1, 1),
'Fault': {
'Code': 'string',
'Message': 'string'
},
'InstanceId': 'string',
'LaunchGroup': 'string',
'LaunchSpecification': {
'UserData': 'string',
'SecurityGroups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'AddressingType': 'string',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'EbsOptimized': True|False,
'IamInstanceProfile': {
'Arn': 'string',
'Name': 'string'
},
'ImageId': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'KernelId': 'string',
'KeyName': 'string',
'NetworkInterfaces': [
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
'Placement': {
'AvailabilityZone': 'string',
'GroupName': 'string',
'Tenancy': 'default'|'dedicated'|'host'
},
'RamdiskId': 'string',
'SubnetId': 'string',
'Monitoring': {
'Enabled': True|False
}
},
'LaunchedAvailabilityZone': 'string',
'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
'SpotInstanceRequestId': 'string',
'SpotPrice': 'string',
'State': 'open'|'active'|'closed'|'cancelled'|'failed',
'Status': {
'Code': 'string',
'Message': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Type': 'one-time'|'persistent',
'ValidFrom': datetime(2015, 1, 1),
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
},
],
}
Response Structure
(dict) --
Contains the output of DescribeSpotInstanceRequests.
SpotInstanceRequests (list) --
One or more Spot Instance requests.
(dict) --
Describes a Spot Instance request.
ActualBlockHourlyPrice (string) --
Deprecated.
AvailabilityZoneGroup (string) --
The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
BlockDurationMinutes (integer) --
Deprecated.
CreateTime (datetime) --
The date and time when the Spot Instance request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Fault (dict) --
The fault codes for the Spot Instance request, if any.
Code (string) --
The reason code for the Spot Instance state change.
Message (string) --
The message for the Spot Instance state change.
InstanceId (string) --
The instance ID, if an instance has been launched to fulfill the Spot Instance request.
LaunchGroup (string) --
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
LaunchSpecification (dict) --
Additional information for launching instances.
UserData (string) --
The Base64-encoded user data for the instance.
SecurityGroups (list) --
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
AddressingType (string) --
Deprecated.
BlockDeviceMappings (list) --
One or more block device mapping entries.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
EbsOptimized (boolean) --
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfile (dict) --
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
ImageId (string) --
The ID of the AMI.
InstanceType (string) --
The instance type.
KernelId (string) --
The ID of the kernel.
KeyName (string) --
The name of the key pair.
NetworkInterfaces (list) --
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
(dict) --
Describes a network interface.
AssociatePublicIpAddress (boolean) --
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
DeleteOnTermination (boolean) --
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
Description (string) --
The description of the network interface. Applies only if creating a network interface when launching an instance.
DeviceIndex (integer) --
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
Groups (list) --
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
Ipv6AddressCount (integer) --
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
Ipv6Addresses (list) --
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
NetworkInterfaceId (string) --
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
PrivateIpAddress (string) --
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
PrivateIpAddresses (list) --
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 addresses.
SecondaryPrivateIpAddressCount (integer) --
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
SubnetId (string) --
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
AssociateCarrierIpAddress (boolean) --
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
InterfaceType (string) --
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
NetworkCardIndex (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.
Placement (dict) --
The placement information for the instance.
AvailabilityZone (string) --
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
GroupName (string) --
The name of the placement group.
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
RamdiskId (string) --
The ID of the RAM disk.
SubnetId (string) --
The ID of the subnet in which to launch the instance.
Monitoring (dict) --
Describes the monitoring of an instance.
Enabled (boolean) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
LaunchedAvailabilityZone (string) --
The Availability Zone in which the request is launched.
ProductDescription (string) --
The product description associated with the Spot Instance.
SpotInstanceRequestId (string) --
The ID of the Spot Instance request.
SpotPrice (string) --
The maximum price per hour that you are willing to pay for a Spot Instance.
State (string) --
The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot status in the Amazon EC2 User Guide for Linux Instances .
Status (dict) --
The status code and status message describing the Spot Instance request.
Code (string) --
The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances .
Message (string) --
The description for the status code.
UpdateTime (datetime) --
The date and time of the most recent status update, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Type (string) --
The Spot Instance request type.
ValidFrom (datetime) --
The start date of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The request becomes active at this date and time.
ValidUntil (datetime) --
The end date of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z).
InstanceInterruptionBehavior (string) --
The behavior when a Spot Instance is interrupted.
paginator = client.get_paginator('describe_spot_price_history')
Creates an iterator that will paginate through responses from EC2.Client.describe_spot_price_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
AvailabilityZone='string',
DryRun=True|False,
EndTime=datetime(2015, 1, 1),
InstanceTypes=[
'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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
],
ProductDescriptions=[
'string',
],
StartTime=datetime(2015, 1, 1),
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
Filters the results by the specified instance types.
Filters the results by the specified basic product descriptions.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SpotPriceHistory': [
{
'AvailabilityZone': 'string',
'InstanceType': '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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
'SpotPrice': 'string',
'Timestamp': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Contains the output of DescribeSpotPriceHistory.
SpotPriceHistory (list) --
The historical Spot prices.
(dict) --
Describes the maximum price per hour that you are willing to pay for a Spot Instance.
AvailabilityZone (string) --
The Availability Zone.
InstanceType (string) --
The instance type.
ProductDescription (string) --
A general description of the AMI.
SpotPrice (string) --
The maximum price per hour that you are willing to pay for a Spot Instance.
Timestamp (datetime) --
The date and time the request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
paginator = client.get_paginator('describe_stale_security_groups')
Creates an iterator that will paginate through responses from EC2.Client.describe_stale_security_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
VpcId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the VPC.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'StaleSecurityGroupSet': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'StaleIpPermissions': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
'string',
],
'PrefixListIds': [
'string',
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
'StaleIpPermissionsEgress': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
'string',
],
'PrefixListIds': [
'string',
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
'VpcId': 'string'
},
]
}
Response Structure
(dict) --
StaleSecurityGroupSet (list) --
Information about the stale security groups.
(dict) --
Describes a stale security group (a security group that contains stale rules).
Description (string) --
The description of the security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
StaleIpPermissions (list) --
Information about the stale inbound rules in the security group.
(dict) --
Describes a stale rule in a security group.
FromPort (integer) --
The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
IpProtocol (string) --
The IP protocol name (for tcp , udp , and icmp ) or number (see Protocol Numbers) .
IpRanges (list) --
The IP ranges. Not applicable for stale security group rules.
PrefixListIds (list) --
The prefix list IDs. Not applicable for stale security group rules.
ToPort (integer) --
The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
UserIdGroupPairs (list) --
The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
StaleIpPermissionsEgress (list) --
Information about the stale outbound rules in the security group.
(dict) --
Describes a stale rule in a security group.
FromPort (integer) --
The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
IpProtocol (string) --
The IP protocol name (for tcp , udp , and icmp ) or number (see Protocol Numbers) .
IpRanges (list) --
The IP ranges. Not applicable for stale security group rules.
PrefixListIds (list) --
The prefix list IDs. Not applicable for stale security group rules.
ToPort (integer) --
The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
UserIdGroupPairs (list) --
The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
VpcId (string) --
The ID of the VPC for the security group.
paginator = client.get_paginator('describe_store_image_tasks')
Creates an iterator that will paginate through responses from EC2.Client.describe_store_image_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ImageIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'StoreImageTaskResults': [
{
'AmiId': 'string',
'TaskStartTime': datetime(2015, 1, 1),
'Bucket': 'string',
'S3objectKey': 'string',
'ProgressPercentage': 123,
'StoreTaskState': 'string',
'StoreTaskFailureReason': 'string'
},
],
}
Response Structure
(dict) --
StoreImageTaskResults (list) --
The information about the AMI store tasks.
(dict) --
The information about the AMI store task, including the progress of the task.
AmiId (string) --
The ID of the AMI that is being stored.
TaskStartTime (datetime) --
The time the task started.
Bucket (string) --
The name of the S3 bucket that contains the stored AMI object.
S3objectKey (string) --
The name of the stored AMI object in the bucket.
ProgressPercentage (integer) --
The progress of the task as a percentage.
StoreTaskState (string) --
The state of the store task (InProgress , Completed , or Failed ).
StoreTaskFailureReason (string) --
If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.
paginator = client.get_paginator('describe_subnets')
Creates an iterator that will paginate through responses from EC2.Client.describe_subnets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
SubnetIds=[
'string',
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more subnet IDs.
Default: Describes all your subnets.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Subnets': [
{
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'AvailableIpAddressCount': 123,
'CidrBlock': 'string',
'DefaultForAz': True|False,
'MapPublicIpOnLaunch': True|False,
'MapCustomerOwnedIpOnLaunch': True|False,
'CustomerOwnedIpv4Pool': 'string',
'State': 'pending'|'available',
'SubnetId': 'string',
'VpcId': 'string',
'OwnerId': 'string',
'AssignIpv6AddressOnCreation': True|False,
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SubnetArn': 'string',
'OutpostArn': 'string'
},
],
}
Response Structure
(dict) --
Subnets (list) --
Information about one or more subnets.
(dict) --
Describes a subnet.
AvailabilityZone (string) --
The Availability Zone of the subnet.
AvailabilityZoneId (string) --
The AZ ID of the subnet.
AvailableIpAddressCount (integer) --
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
CidrBlock (string) --
The IPv4 CIDR block assigned to the subnet.
DefaultForAz (boolean) --
Indicates whether this is the default subnet for the Availability Zone.
MapPublicIpOnLaunch (boolean) --
Indicates whether instances launched in this subnet receive a public IPv4 address.
MapCustomerOwnedIpOnLaunch (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives a customer-owned IPv4 address.
CustomerOwnedIpv4Pool (string) --
The customer-owned IPv4 address pool associated with the subnet.
State (string) --
The current state of the subnet.
SubnetId (string) --
The ID of the subnet.
VpcId (string) --
The ID of the VPC the subnet is in.
OwnerId (string) --
The ID of the AWS account that owns the subnet.
AssignIpv6AddressOnCreation (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives an IPv6 address.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the subnet.
(dict) --
Describes an IPv6 CIDR block associated with a subnet.
AssociationId (string) --
The association ID for the CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of a CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
Tags (list) --
Any tags assigned to the subnet.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
paginator = client.get_paginator('describe_tags')
Creates an iterator that will paginate through responses from EC2.Client.describe_tags().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'ResourceId': 'string',
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type.
Value (string) --
The tag value.
paginator = client.get_paginator('describe_traffic_mirror_filters')
Creates an iterator that will paginate through responses from EC2.Client.describe_traffic_mirror_filters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TrafficMirrorFilterIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the Traffic Mirror filter.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TrafficMirrorFilters': [
{
'TrafficMirrorFilterId': 'string',
'IngressFilterRules': [
{
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
],
'EgressFilterRules': [
{
'TrafficMirrorFilterRuleId': 'string',
'TrafficMirrorFilterId': 'string',
'TrafficDirection': 'ingress'|'egress',
'RuleNumber': 123,
'RuleAction': 'accept'|'reject',
'Protocol': 123,
'DestinationPortRange': {
'FromPort': 123,
'ToPort': 123
},
'SourcePortRange': {
'FromPort': 123,
'ToPort': 123
},
'DestinationCidrBlock': 'string',
'SourceCidrBlock': 'string',
'Description': 'string'
},
],
'NetworkServices': [
'amazon-dns',
],
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TrafficMirrorFilters (list) --
Information about one or more Traffic Mirror filters.
(dict) --
Describes the Traffic Mirror filter.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
IngressFilterRules (list) --
Information about the ingress rules that are associated with the Traffic Mirror filter.
(dict) --
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
EgressFilterRules (list) --
Information about the egress rules that are associated with the Traffic Mirror filter.
(dict) --
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) --
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) --
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) --
The rule number of the Traffic Mirror rule.
RuleAction (string) --
The action assigned to the Traffic Mirror rule.
Protocol (integer) --
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) --
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) --
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) --
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) --
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) --
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) --
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) --
The description of the Traffic Mirror rule.
NetworkServices (list) --
The network service traffic that is associated with the Traffic Mirror filter.
Description (string) --
The description of the Traffic Mirror filter.
Tags (list) --
The tags assigned to the Traffic Mirror filter.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_traffic_mirror_sessions')
Creates an iterator that will paginate through responses from EC2.Client.describe_traffic_mirror_sessions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TrafficMirrorSessionIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the Traffic Mirror session.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TrafficMirrorSessions': [
{
'TrafficMirrorSessionId': 'string',
'TrafficMirrorTargetId': 'string',
'TrafficMirrorFilterId': 'string',
'NetworkInterfaceId': 'string',
'OwnerId': 'string',
'PacketLength': 123,
'SessionNumber': 123,
'VirtualNetworkId': 123,
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TrafficMirrorSessions (list) --
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
(dict) --
Describes a Traffic Mirror session.
TrafficMirrorSessionId (string) --
The ID for the Traffic Mirror session.
TrafficMirrorTargetId (string) --
The ID of the Traffic Mirror target.
TrafficMirrorFilterId (string) --
The ID of the Traffic Mirror filter.
NetworkInterfaceId (string) --
The ID of the Traffic Mirror session's network interface.
OwnerId (string) --
The ID of the account that owns the Traffic Mirror session.
PacketLength (integer) --
The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet
SessionNumber (integer) --
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
VirtualNetworkId (integer) --
The virtual network ID associated with the Traffic Mirror session.
Description (string) --
The description of the Traffic Mirror session.
Tags (list) --
The tags assigned to the Traffic Mirror session.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_traffic_mirror_targets')
Creates an iterator that will paginate through responses from EC2.Client.describe_traffic_mirror_targets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TrafficMirrorTargetIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the Traffic Mirror targets.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TrafficMirrorTargets': [
{
'TrafficMirrorTargetId': 'string',
'NetworkInterfaceId': 'string',
'NetworkLoadBalancerArn': 'string',
'Type': 'network-interface'|'network-load-balancer',
'Description': 'string',
'OwnerId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TrafficMirrorTargets (list) --
Information about one or more Traffic Mirror targets.
(dict) --
Describes a Traffic Mirror target.
TrafficMirrorTargetId (string) --
The ID of the Traffic Mirror target.
NetworkInterfaceId (string) --
The network interface ID that is attached to the target.
NetworkLoadBalancerArn (string) --
The Amazon Resource Name (ARN) of the Network Load Balancer.
Type (string) --
The type of Traffic Mirror target.
Description (string) --
Information about the Traffic Mirror target.
OwnerId (string) --
The ID of the account that owns the Traffic Mirror target.
Tags (list) --
The tags assigned to the Traffic Mirror target.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_transit_gateway_attachments')
Creates an iterator that will paginate through responses from EC2.Client.describe_transit_gateway_attachments().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the attachments.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayOwnerId': 'string',
'ResourceOwnerId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'Association': {
'TransitGatewayRouteTableId': 'string',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
},
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TransitGatewayAttachments (list) --
Information about the attachments.
(dict) --
Describes an attachment between a resource and a transit gateway.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayOwnerId (string) --
The ID of the AWS account that owns the transit gateway.
ResourceOwnerId (string) --
The ID of the AWS account that owns the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
State (string) --
The attachment state. Note that the initiating state has been deprecated.
Association (dict) --
The association.
TransitGatewayRouteTableId (string) --
The ID of the route table for the transit gateway.
State (string) --
The state of the association.
CreationTime (datetime) --
The creation time.
Tags (list) --
The tags for the attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_transit_gateway_connect_peers')
Creates an iterator that will paginate through responses from EC2.Client.describe_transit_gateway_connect_peers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayConnectPeerIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the Connect peers.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayConnectPeers': [
{
'TransitGatewayAttachmentId': 'string',
'TransitGatewayConnectPeerId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'CreationTime': datetime(2015, 1, 1),
'ConnectPeerConfiguration': {
'TransitGatewayAddress': 'string',
'PeerAddress': 'string',
'InsideCidrBlocks': [
'string',
],
'Protocol': 'gre',
'BgpConfigurations': [
{
'TransitGatewayAsn': 123,
'PeerAsn': 123,
'TransitGatewayAddress': 'string',
'PeerAddress': 'string',
'BgpStatus': 'up'|'down'
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TransitGatewayConnectPeers (list) --
Information about the Connect peers.
(dict) --
Describes a transit gateway Connect peer.
TransitGatewayAttachmentId (string) --
The ID of the Connect attachment.
TransitGatewayConnectPeerId (string) --
The ID of the Connect peer.
State (string) --
The state of the Connect peer.
CreationTime (datetime) --
The creation time.
ConnectPeerConfiguration (dict) --
The Connect peer details.
TransitGatewayAddress (string) --
The Connect peer IP address on the transit gateway side of the tunnel.
PeerAddress (string) --
The Connect peer IP address on the appliance side of the tunnel.
InsideCidrBlocks (list) --
The range of interior BGP peer IP addresses.
Protocol (string) --
The tunnel protocol.
BgpConfigurations (list) --
The BGP configuration details.
(dict) --
The BGP configuration information.
TransitGatewayAsn (integer) --
The transit gateway Autonomous System Number (ASN).
PeerAsn (integer) --
The peer Autonomous System Number (ASN).
TransitGatewayAddress (string) --
The interior BGP peer IP address for the transit gateway.
PeerAddress (string) --
The interior BGP peer IP address for the appliance.
BgpStatus (string) --
The BGP status.
Tags (list) --
The tags for the Connect peer.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_transit_gateway_connects')
Creates an iterator that will paginate through responses from EC2.Client.describe_transit_gateway_connects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the attachments.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayConnects': [
{
'TransitGatewayAttachmentId': 'string',
'TransportTransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'Protocol': 'gre'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TransitGatewayConnects (list) --
Information about the Connect attachments.
(dict) --
Describes a transit gateway Connect attachment.
TransitGatewayAttachmentId (string) --
The ID of the Connect attachment.
TransportTransitGatewayAttachmentId (string) --
The ID of the attachment from which the Connect attachment was created.
TransitGatewayId (string) --
The ID of the transit gateway.
State (string) --
The state of the attachment.
CreationTime (datetime) --
The creation time.
Options (dict) --
The Connect attachment options.
Protocol (string) --
The tunnel protocol.
Tags (list) --
The tags for the attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_transit_gateway_multicast_domains')
Creates an iterator that will paginate through responses from EC2.Client.describe_transit_gateway_multicast_domains().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayMulticastDomainIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the transit gateway multicast domain.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayMulticastDomains': [
{
'TransitGatewayMulticastDomainId': 'string',
'TransitGatewayId': 'string',
'TransitGatewayMulticastDomainArn': 'string',
'OwnerId': 'string',
'Options': {
'Igmpv2Support': 'enable'|'disable',
'StaticSourcesSupport': 'enable'|'disable',
'AutoAcceptSharedAssociations': 'enable'|'disable'
},
'State': 'pending'|'available'|'deleting'|'deleted',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TransitGatewayMulticastDomains (list) --
Information about the transit gateway multicast domains.
(dict) --
Describes the transit gateway multicast domain.
TransitGatewayMulticastDomainId (string) --
The ID of the transit gateway multicast domain.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayMulticastDomainArn (string) --
The Amazon Resource Name (ARN) of the transit gateway multicast domain.
OwnerId (string) --
The ID of the AWS account that owns the transit gateway multiicast domain.
Options (dict) --
The options for the transit gateway multicast domain.
Igmpv2Support (string) --
Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
StaticSourcesSupport (string) --
Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
AutoAcceptSharedAssociations (string) --
Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
State (string) --
The state of the transit gateway multicast domain.
CreationTime (datetime) --
The time the transit gateway multicast domain was created.
Tags (list) --
The tags for the transit gateway multicast domain.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_transit_gateway_peering_attachments')
Creates an iterator that will paginate through responses from EC2.Client.describe_transit_gateway_peering_attachments().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more IDs of the transit gateway peering attachments.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayPeeringAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'RequesterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'AccepterTgwInfo': {
'TransitGatewayId': 'string',
'OwnerId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'string',
'Message': 'string'
},
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TransitGatewayPeeringAttachments (list) --
The transit gateway peering attachments.
(dict) --
Describes the transit gateway peering attachment.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway peering attachment.
RequesterTgwInfo (dict) --
Information about the requester transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
AccepterTgwInfo (dict) --
Information about the accepter transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
OwnerId (string) --
The AWS account ID of the owner of the transit gateway.
Region (string) --
The Region of the transit gateway.
Status (dict) --
The status of the transit gateway peering attachment.
Code (string) --
The status code.
Message (string) --
The status message, if applicable.
State (string) --
The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime (datetime) --
The time the transit gateway peering attachment was created.
Tags (list) --
The tags for the transit gateway peering attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_transit_gateway_route_tables')
Creates an iterator that will paginate through responses from EC2.Client.describe_transit_gateway_route_tables().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayRouteTableIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the transit gateway route tables.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayRouteTables': [
{
'TransitGatewayRouteTableId': 'string',
'TransitGatewayId': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'DefaultAssociationRouteTable': True|False,
'DefaultPropagationRouteTable': True|False,
'CreationTime': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TransitGatewayRouteTables (list) --
Information about the transit gateway route tables.
(dict) --
Describes a transit gateway route table.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
TransitGatewayId (string) --
The ID of the transit gateway.
State (string) --
The state of the transit gateway route table.
DefaultAssociationRouteTable (boolean) --
Indicates whether this is the default association route table for the transit gateway.
DefaultPropagationRouteTable (boolean) --
Indicates whether this is the default propagation route table for the transit gateway.
CreationTime (datetime) --
The creation time.
Tags (list) --
Any tags assigned to the route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_transit_gateway_vpc_attachments')
Creates an iterator that will paginate through responses from EC2.Client.describe_transit_gateway_vpc_attachments().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayAttachmentIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the attachments.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayVpcAttachments': [
{
'TransitGatewayAttachmentId': 'string',
'TransitGatewayId': 'string',
'VpcId': 'string',
'VpcOwnerId': 'string',
'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
'SubnetIds': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Options': {
'DnsSupport': 'enable'|'disable',
'Ipv6Support': 'enable'|'disable',
'ApplianceModeSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TransitGatewayVpcAttachments (list) --
Information about the VPC attachments.
(dict) --
Describes a VPC attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
TransitGatewayId (string) --
The ID of the transit gateway.
VpcId (string) --
The ID of the VPC.
VpcOwnerId (string) --
The ID of the AWS account that owns the VPC.
State (string) --
The state of the VPC attachment. Note that the initiating state has been deprecated.
SubnetIds (list) --
The IDs of the subnets.
CreationTime (datetime) --
The creation time.
Options (dict) --
The VPC attachment options.
DnsSupport (string) --
Indicates whether DNS support is enabled.
Ipv6Support (string) --
Indicates whether IPv6 support is disabled.
ApplianceModeSupport (string) --
Indicates whether appliance mode support is enabled.
Tags (list) --
The tags for the VPC attachment.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_transit_gateways')
Creates an iterator that will paginate through responses from EC2.Client.describe_transit_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the transit gateways.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGateways': [
{
'TransitGatewayId': 'string',
'TransitGatewayArn': 'string',
'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
'OwnerId': 'string',
'Description': 'string',
'CreationTime': datetime(2015, 1, 1),
'Options': {
'AmazonSideAsn': 123,
'TransitGatewayCidrBlocks': [
'string',
],
'AutoAcceptSharedAttachments': 'enable'|'disable',
'DefaultRouteTableAssociation': 'enable'|'disable',
'AssociationDefaultRouteTableId': 'string',
'DefaultRouteTablePropagation': 'enable'|'disable',
'PropagationDefaultRouteTableId': 'string',
'VpnEcmpSupport': 'enable'|'disable',
'DnsSupport': 'enable'|'disable',
'MulticastSupport': 'enable'|'disable'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
TransitGateways (list) --
Information about the transit gateways.
(dict) --
Describes a transit gateway.
TransitGatewayId (string) --
The ID of the transit gateway.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
State (string) --
The state of the transit gateway.
OwnerId (string) --
The ID of the AWS account ID that owns the transit gateway.
Description (string) --
The description of the transit gateway.
CreationTime (datetime) --
The creation time.
Options (dict) --
The transit gateway options.
AmazonSideAsn (integer) --
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
TransitGatewayCidrBlocks (list) --
The transit gateway CIDR blocks.
AutoAcceptSharedAttachments (string) --
Indicates whether attachment requests are automatically accepted.
DefaultRouteTableAssociation (string) --
Indicates whether resource attachments are automatically associated with the default association route table.
AssociationDefaultRouteTableId (string) --
The ID of the default association route table.
DefaultRouteTablePropagation (string) --
Indicates whether resource attachments automatically propagate routes to the default propagation route table.
PropagationDefaultRouteTableId (string) --
The ID of the default propagation route table.
VpnEcmpSupport (string) --
Indicates whether Equal Cost Multipath Protocol support is enabled.
DnsSupport (string) --
Indicates whether DNS support is enabled.
MulticastSupport (string) --
Indicates whether multicast is enabled on the transit gateway
Tags (list) --
The tags for the transit gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_volume_status')
Creates an iterator that will paginate through responses from EC2.Client.describe_volume_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VolumeIds=[
'string',
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the volumes.
Default: Describes all your volumes.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'VolumeStatuses': [
{
'Actions': [
{
'Code': 'string',
'Description': 'string',
'EventId': 'string',
'EventType': 'string'
},
],
'AvailabilityZone': 'string',
'OutpostArn': 'string',
'Events': [
{
'Description': 'string',
'EventId': 'string',
'EventType': 'string',
'NotAfter': datetime(2015, 1, 1),
'NotBefore': datetime(2015, 1, 1),
'InstanceId': 'string'
},
],
'VolumeId': 'string',
'VolumeStatus': {
'Details': [
{
'Name': 'io-enabled'|'io-performance',
'Status': 'string'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'
},
'AttachmentStatuses': [
{
'IoPerformance': 'string',
'InstanceId': 'string'
},
]
},
]
}
Response Structure
(dict) --
VolumeStatuses (list) --
Information about the status of the volumes.
(dict) --
Describes the volume status.
Actions (list) --
The details of the operation.
(dict) --
Describes a volume status operation code.
Code (string) --
The code identifying the operation, for example, enable-volume-io .
Description (string) --
A description of the operation.
EventId (string) --
The ID of the event associated with this operation.
EventType (string) --
The event type associated with this operation.
AvailabilityZone (string) --
The Availability Zone of the volume.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Events (list) --
A list of events associated with the volume.
(dict) --
Describes a volume status event.
Description (string) --
A description of the event.
EventId (string) --
The ID of this event.
EventType (string) --
The type of this event.
NotAfter (datetime) --
The latest end time of the event.
NotBefore (datetime) --
The earliest start time of the event.
InstanceId (string) --
The ID of the instance associated with the event.
VolumeId (string) --
The volume ID.
VolumeStatus (dict) --
The volume status.
Details (list) --
The details of the volume status.
(dict) --
Describes a volume status.
Name (string) --
The name of the volume status.
Status (string) --
The intended status of the volume status.
Status (string) --
The status of the volume.
AttachmentStatuses (list) --
Information about the instances to which the volume is attached.
(dict) --
Information about the instances to which the volume is attached.
IoPerformance (string) --
The maximum IOPS supported by the attached instance.
InstanceId (string) --
The ID of the attached instance.
paginator = client.get_paginator('describe_volumes')
Creates an iterator that will paginate through responses from EC2.Client.describe_volumes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VolumeIds=[
'string',
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The volume IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Volumes': [
{
'Attachments': [
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
},
],
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Encrypted': True|False,
'KmsKeyId': 'string',
'OutpostArn': 'string',
'Size': 123,
'SnapshotId': 'string',
'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
'VolumeId': 'string',
'Iops': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'FastRestored': True|False,
'MultiAttachEnabled': True|False,
'Throughput': 123
},
],
}
Response Structure
(dict) --
Volumes (list) --
Information about the volumes.
(dict) --
Describes a volume.
Attachments (list) --
Information about the volume attachments.
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
AvailabilityZone (string) --
The Availability Zone for the volume.
CreateTime (datetime) --
The time stamp when volume creation was initiated.
Encrypted (boolean) --
Indicates whether the volume is encrypted.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Size (integer) --
The size of the volume, in GiBs.
SnapshotId (string) --
The snapshot from which the volume was created, if applicable.
State (string) --
The volume state.
VolumeId (string) --
The ID of the volume.
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
Tags (list) --
Any tags assigned to the volume.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VolumeType (string) --
The volume type.
FastRestored (boolean) --
Indicates whether the volume was created using fast snapshot restore.
MultiAttachEnabled (boolean) --
Indicates whether Amazon EBS Multi-Attach is enabled.
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
paginator = client.get_paginator('describe_volumes_modifications')
Creates an iterator that will paginate through responses from EC2.Client.describe_volumes_modifications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
VolumeIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the volumes.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'VolumesModifications': [
{
'VolumeId': 'string',
'ModificationState': 'modifying'|'optimizing'|'completed'|'failed',
'StatusMessage': 'string',
'TargetSize': 123,
'TargetIops': 123,
'TargetVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'TargetThroughput': 123,
'TargetMultiAttachEnabled': True|False,
'OriginalSize': 123,
'OriginalIops': 123,
'OriginalVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'OriginalThroughput': 123,
'OriginalMultiAttachEnabled': True|False,
'Progress': 123,
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
VolumesModifications (list) --
Information about the volume modifications.
(dict) --
Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
VolumeId (string) --
The ID of the volume.
ModificationState (string) --
The current modification state. The modification state is null for unmodified volumes.
StatusMessage (string) --
A status message about the modification progress or failure.
TargetSize (integer) --
The target size of the volume, in GiB.
TargetIops (integer) --
The target IOPS rate of the volume.
TargetVolumeType (string) --
The target EBS volume type of the volume.
TargetThroughput (integer) --
The target throughput of the volume, in MiB/s.
TargetMultiAttachEnabled (boolean) --
The target setting for Amazon EBS Multi-Attach.
OriginalSize (integer) --
The original size of the volume, in GiB.
OriginalIops (integer) --
The original IOPS rate of the volume.
OriginalVolumeType (string) --
The original EBS volume type of the volume.
OriginalThroughput (integer) --
The original throughput of the volume, in MiB/s.
OriginalMultiAttachEnabled (boolean) --
The original setting for Amazon EBS Multi-Attach.
Progress (integer) --
The modification progress, from 0 to 100 percent complete.
StartTime (datetime) --
The modification start time.
EndTime (datetime) --
The modification completion or failure time.
paginator = client.get_paginator('describe_vpc_classic_link_dns_support')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpc_classic_link_dns_support().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
VpcIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more VPC IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Vpcs': [
{
'ClassicLinkDnsSupported': True|False,
'VpcId': 'string'
},
]
}
Response Structure
(dict) --
Vpcs (list) --
Information about the ClassicLink DNS support status of the VPCs.
(dict) --
Describes the ClassicLink DNS support status of a VPC.
ClassicLinkDnsSupported (boolean) --
Indicates whether ClassicLink DNS support is enabled for the VPC.
VpcId (string) --
The ID of the VPC.
paginator = client.get_paginator('describe_vpc_endpoint_connection_notifications')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpc_endpoint_connection_notifications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
ConnectionNotificationId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConnectionNotificationSet': [
{
'ConnectionNotificationId': 'string',
'ServiceId': 'string',
'VpcEndpointId': 'string',
'ConnectionNotificationType': 'Topic',
'ConnectionNotificationArn': 'string',
'ConnectionEvents': [
'string',
],
'ConnectionNotificationState': 'Enabled'|'Disabled'
},
],
}
Response Structure
(dict) --
ConnectionNotificationSet (list) --
One or more notifications.
(dict) --
Describes a connection notification for a VPC endpoint or VPC endpoint service.
ConnectionNotificationId (string) --
The ID of the notification.
ServiceId (string) --
The ID of the endpoint service.
VpcEndpointId (string) --
The ID of the VPC endpoint.
ConnectionNotificationType (string) --
The type of notification.
ConnectionNotificationArn (string) --
The ARN of the SNS topic for the notification.
ConnectionEvents (list) --
The events for the notification. Valid values are Accept , Connect , Delete , and Reject .
ConnectionNotificationState (string) --
The state of the notification.
paginator = client.get_paginator('describe_vpc_endpoint_connections')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpc_endpoint_connections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'VpcEndpointConnections': [
{
'ServiceId': 'string',
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'VpcEndpointState': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'CreationTimestamp': datetime(2015, 1, 1),
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'NetworkLoadBalancerArns': [
'string',
],
'GatewayLoadBalancerArns': [
'string',
]
},
],
}
Response Structure
(dict) --
VpcEndpointConnections (list) --
Information about one or more VPC endpoint connections.
(dict) --
Describes a VPC endpoint connection to a service.
ServiceId (string) --
The ID of the service to which the endpoint is connected.
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcEndpointOwner (string) --
The AWS account ID of the owner of the VPC endpoint.
VpcEndpointState (string) --
The state of the VPC endpoint.
CreationTimestamp (datetime) --
The date and time that the VPC endpoint was created.
DnsEntries (list) --
The DNS entries for the VPC endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
NetworkLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the network load balancers for the service.
GatewayLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
paginator = client.get_paginator('describe_vpc_endpoint_service_configurations')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpc_endpoint_service_configurations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
ServiceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of one or more services.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ServiceConfigurations': [
{
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
},
],
'ServiceId': 'string',
'ServiceName': 'string',
'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
'AvailabilityZones': [
'string',
],
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'NetworkLoadBalancerArns': [
'string',
],
'GatewayLoadBalancerArns': [
'string',
],
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'PrivateDnsNameConfiguration': {
'State': 'pendingVerification'|'verified'|'failed',
'Type': 'string',
'Value': 'string',
'Name': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
ServiceConfigurations (list) --
Information about one or more services.
(dict) --
Describes a service configuration for a VPC endpoint service.
ServiceType (list) --
The type of service.
(dict) --
Describes the type of service for a VPC endpoint.
ServiceType (string) --
The type of service.
ServiceId (string) --
The ID of the service.
ServiceName (string) --
The name of the service.
ServiceState (string) --
The service state.
AvailabilityZones (list) --
The Availability Zones in which the service is available.
AcceptanceRequired (boolean) --
Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
ManagesVpcEndpoints (boolean) --
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
NetworkLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
GatewayLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
BaseEndpointDnsNames (list) --
The DNS names for the service.
PrivateDnsName (string) --
The private DNS name for the service.
PrivateDnsNameConfiguration (dict) --
Information about the endpoint service private DNS name configuration.
State (string) --
The verification state of the VPC endpoint service.
>Consumers of the endpoint service can use the private name only when the state is verified .
Type (string) --
The endpoint service verification type, for example TXT.
Value (string) --
The value the service provider adds to the private DNS name domain record before verification.
Name (string) --
The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name .
Tags (list) --
Any tags assigned to the service.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('describe_vpc_endpoint_service_permissions')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpc_endpoint_service_permissions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
ServiceId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the service.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AllowedPrincipals': [
{
'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role',
'Principal': 'string'
},
],
}
Response Structure
(dict) --
AllowedPrincipals (list) --
Information about one or more allowed principals.
(dict) --
Describes a principal.
PrincipalType (string) --
The type of principal.
Principal (string) --
The Amazon Resource Name (ARN) of the principal.
paginator = client.get_paginator('describe_vpc_endpoint_services')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpc_endpoint_services().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
ServiceNames=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more service names.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ServiceNames': [
'string',
],
'ServiceDetails': [
{
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
},
],
'AvailabilityZones': [
'string',
],
'Owner': 'string',
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'PrivateDnsNames': [
{
'PrivateDnsName': 'string'
},
],
'VpcEndpointPolicySupported': True|False,
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PrivateDnsNameVerificationState': 'pendingVerification'|'verified'|'failed'
},
],
}
Response Structure
(dict) --
Contains the output of DescribeVpcEndpointServices.
ServiceNames (list) --
A list of supported services.
ServiceDetails (list) --
Information about the service.
(dict) --
Describes a VPC endpoint service.
ServiceName (string) --
The Amazon Resource Name (ARN) of the service.
ServiceId (string) --
The ID of the endpoint service.
ServiceType (list) --
The type of service.
(dict) --
Describes the type of service for a VPC endpoint.
ServiceType (string) --
The type of service.
AvailabilityZones (list) --
The Availability Zones in which the service is available.
Owner (string) --
The AWS account ID of the service owner.
BaseEndpointDnsNames (list) --
The DNS names for the service.
PrivateDnsName (string) --
The private DNS name for the service.
PrivateDnsNames (list) --
The private DNS names assigned to the VPC endpoint service.
(dict) --
Information about the Private DNS name for interface endpoints.
PrivateDnsName (string) --
The private DNS name assigned to the VPC endpoint service.
VpcEndpointPolicySupported (boolean) --
Indicates whether the service supports endpoint policies.
AcceptanceRequired (boolean) --
Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
ManagesVpcEndpoints (boolean) --
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
Tags (list) --
Any tags assigned to the service.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
PrivateDnsNameVerificationState (string) --
The verification state of the VPC endpoint service.
Consumers of the endpoint service cannot use the private name when the state is not verified .
paginator = client.get_paginator('describe_vpc_endpoints')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpc_endpoints().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
VpcEndpointIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more endpoint IDs.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer',
'VpcId': 'string',
'ServiceName': 'string',
'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
'PolicyDocument': 'string',
'RouteTableIds': [
'string',
],
'SubnetIds': [
'string',
],
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'PrivateDnsEnabled': True|False,
'RequesterManaged': True|False,
'NetworkInterfaceIds': [
'string',
],
'DnsEntries': [
{
'DnsName': 'string',
'HostedZoneId': 'string'
},
],
'CreationTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'OwnerId': 'string',
'LastError': {
'Message': 'string',
'Code': 'string'
}
},
],
}
Response Structure
(dict) --
Contains the output of DescribeVpcEndpoints.
VpcEndpoints (list) --
Information about the endpoints.
(dict) --
Describes a VPC endpoint.
VpcEndpointId (string) --
The ID of the VPC endpoint.
VpcEndpointType (string) --
The type of endpoint.
VpcId (string) --
The ID of the VPC to which the endpoint is associated.
ServiceName (string) --
The name of the service to which the endpoint is associated.
State (string) --
The state of the VPC endpoint.
PolicyDocument (string) --
The policy document associated with the endpoint, if applicable.
RouteTableIds (list) --
(Gateway endpoint) One or more route tables associated with the endpoint.
SubnetIds (list) --
(Interface endpoint) One or more subnets in which the endpoint is located.
Groups (list) --
(Interface endpoint) Information about the security groups that are associated with the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
PrivateDnsEnabled (boolean) --
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
RequesterManaged (boolean) --
Indicates whether the VPC endpoint is being managed by its service.
NetworkInterfaceIds (list) --
(Interface endpoint) One or more network interfaces for the endpoint.
DnsEntries (list) --
(Interface endpoint) The DNS entries for the endpoint.
(dict) --
Describes a DNS entry.
DnsName (string) --
The DNS name.
HostedZoneId (string) --
The ID of the private hosted zone.
CreationTimestamp (datetime) --
The date and time that the VPC endpoint was created.
Tags (list) --
Any tags assigned to the VPC endpoint.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
OwnerId (string) --
The ID of the AWS account that owns the VPC endpoint.
LastError (dict) --
The last error that occurred for VPC endpoint.
Message (string) --
The error message for the VPC endpoint error.
Code (string) --
The error code for the VPC endpoint error.
paginator = client.get_paginator('describe_vpc_peering_connections')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpc_peering_connections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
VpcPeeringConnectionIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'VpcPeeringConnections': [
{
'AccepterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'ExpirationTime': datetime(2015, 1, 1),
'RequesterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcPeeringConnectionId': 'string'
},
],
}
Response Structure
(dict) --
VpcPeeringConnections (list) --
Information about the VPC peering connections.
(dict) --
Describes a VPC peering connection.
AccepterVpcInfo (dict) --
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
ExpirationTime (datetime) --
The time that an unaccepted VPC peering connection will expire.
RequesterVpcInfo (dict) --
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
Status (dict) --
The status of the VPC peering connection.
Code (string) --
The status of the VPC peering connection.
Message (string) --
A message that provides more information about the status, if applicable.
Tags (list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
paginator = client.get_paginator('describe_vpcs')
Creates an iterator that will paginate through responses from EC2.Client.describe_vpcs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpcIds=[
'string',
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC IDs.
Default: Describes all your VPCs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Vpcs': [
{
'CidrBlock': 'string',
'DhcpOptionsId': 'string',
'State': 'pending'|'available',
'VpcId': 'string',
'OwnerId': 'string',
'InstanceTenancy': 'default'|'dedicated'|'host',
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'NetworkBorderGroup': 'string',
'Ipv6Pool': 'string'
},
],
'CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'CidrBlock': 'string',
'CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
}
},
],
'IsDefault': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Vpcs (list) --
Information about one or more VPCs.
(dict) --
Describes a VPC.
CidrBlock (string) --
The primary IPv4 CIDR block for the VPC.
DhcpOptionsId (string) --
The ID of the set of DHCP options you've associated with the VPC.
State (string) --
The current state of the VPC.
VpcId (string) --
The ID of the VPC.
OwnerId (string) --
The ID of the AWS account that owns the VPC.
InstanceTenancy (string) --
The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1 .
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
CidrBlockAssociationSet (list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
IsDefault (boolean) --
Indicates whether the VPC is the default VPC.
Tags (list) --
Any tags assigned to the VPC.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
paginator = client.get_paginator('get_associated_ipv6_pool_cidrs')
Creates an iterator that will paginate through responses from EC2.Client.get_associated_ipv6_pool_cidrs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PoolId='string',
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the IPv6 address pool.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Ipv6CidrAssociations': [
{
'Ipv6Cidr': 'string',
'AssociatedResource': 'string'
},
],
}
Response Structure
(dict) --
Ipv6CidrAssociations (list) --
Information about the IPv6 CIDR block associations.
(dict) --
Describes an IPv6 CIDR block association.
Ipv6Cidr (string) --
The IPv6 CIDR block.
AssociatedResource (string) --
The resource that's associated with the IPv6 CIDR block.
paginator = client.get_paginator('get_groups_for_capacity_reservation')
Creates an iterator that will paginate through responses from EC2.Client.get_groups_for_capacity_reservation().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CapacityReservationId='string',
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the Capacity Reservation.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CapacityReservationGroups': [
{
'GroupArn': 'string',
'OwnerId': 'string'
},
]
}
Response Structure
(dict) --
CapacityReservationGroups (list) --
Information about the resource groups to which the Capacity Reservation has been added.
(dict) --
Describes a resource group to which a Capacity Reservation has been added.
GroupArn (string) --
The ARN of the resource group.
OwnerId (string) --
The ID of the account that owns the resource group.
paginator = client.get_paginator('get_managed_prefix_list_associations')
Creates an iterator that will paginate through responses from EC2.Client.get_managed_prefix_list_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
PrefixListId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the prefix list.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PrefixListAssociations': [
{
'ResourceId': 'string',
'ResourceOwner': 'string'
},
],
}
Response Structure
(dict) --
PrefixListAssociations (list) --
Information about the associations.
(dict) --
Describes the resource with which a prefix list is associated.
ResourceId (string) --
The ID of the resource.
ResourceOwner (string) --
The owner of the resource.
paginator = client.get_paginator('get_managed_prefix_list_entries')
Creates an iterator that will paginate through responses from EC2.Client.get_managed_prefix_list_entries().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DryRun=True|False,
PrefixListId='string',
TargetVersion=123,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the prefix list.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Entries': [
{
'Cidr': 'string',
'Description': 'string'
},
],
}
Response Structure
(dict) --
Entries (list) --
Information about the prefix list entries.
(dict) --
Describes a prefix list entry.
Cidr (string) --
The CIDR block.
Description (string) --
The description.
paginator = client.get_paginator('get_transit_gateway_attachment_propagations')
Creates an iterator that will paginate through responses from EC2.Client.get_transit_gateway_attachment_propagations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayAttachmentId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the attachment.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayAttachmentPropagations': [
{
'TransitGatewayRouteTableId': 'string',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
},
],
}
Response Structure
(dict) --
TransitGatewayAttachmentPropagations (list) --
Information about the propagation route tables.
(dict) --
Describes a propagation route table.
TransitGatewayRouteTableId (string) --
The ID of the propagation route table.
State (string) --
The state of the propagation route table.
paginator = client.get_paginator('get_transit_gateway_multicast_domain_associations')
Creates an iterator that will paginate through responses from EC2.Client.get_transit_gateway_multicast_domain_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayMulticastDomainId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'MulticastDomainAssociations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceOwnerId': 'string',
'Subnet': {
'SubnetId': 'string',
'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
}
},
],
}
Response Structure
(dict) --
MulticastDomainAssociations (list) --
Information about the multicast domain associations.
(dict) --
Describes the resources associated with the transit gateway multicast domain.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the AWS account that owns the transit gateway multicast domain association resource.
Subnet (dict) --
The subnet associated with the transit gateway multicast domain.
SubnetId (string) --
The ID of the subnet.
State (string) --
The state of the subnet association.
paginator = client.get_paginator('get_transit_gateway_prefix_list_references')
Creates an iterator that will paginate through responses from EC2.Client.get_transit_gateway_prefix_list_references().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the transit gateway route table.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayPrefixListReferences': [
{
'TransitGatewayRouteTableId': 'string',
'PrefixListId': 'string',
'PrefixListOwnerId': 'string',
'State': 'pending'|'available'|'modifying'|'deleting',
'Blackhole': True|False,
'TransitGatewayAttachment': {
'TransitGatewayAttachmentId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceId': 'string'
}
},
],
}
Response Structure
(dict) --
TransitGatewayPrefixListReferences (list) --
Information about the prefix list references.
(dict) --
Describes a prefix list reference.
TransitGatewayRouteTableId (string) --
The ID of the transit gateway route table.
PrefixListId (string) --
The ID of the prefix list.
PrefixListOwnerId (string) --
The ID of the prefix list owner.
State (string) --
The state of the prefix list reference.
Blackhole (boolean) --
Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment (dict) --
Information about the transit gateway attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId (string) --
The ID of the resource.
paginator = client.get_paginator('get_transit_gateway_route_table_associations')
Creates an iterator that will paginate through responses from EC2.Client.get_transit_gateway_route_table_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the transit gateway route table.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Associations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'State': 'associating'|'associated'|'disassociating'|'disassociated'
},
],
}
Response Structure
(dict) --
Associations (list) --
Information about the associations.
(dict) --
Describes an association between a route table and a resource attachment.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the association.
paginator = client.get_paginator('get_transit_gateway_route_table_propagations')
Creates an iterator that will paginate through responses from EC2.Client.get_transit_gateway_route_table_propagations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the transit gateway route table.
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TransitGatewayRouteTablePropagations': [
{
'TransitGatewayAttachmentId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'State': 'enabling'|'enabled'|'disabling'|'disabled'
},
],
}
Response Structure
(dict) --
TransitGatewayRouteTablePropagations (list) --
Information about the route table propagations.
(dict) --
Describes a route table propagation.
TransitGatewayAttachmentId (string) --
The ID of the attachment.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource. Note that the tgw-peering resource type has been deprecated.
State (string) --
The state of the resource.
paginator = client.get_paginator('search_local_gateway_routes')
Creates an iterator that will paginate through responses from EC2.Client.search_local_gateway_routes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LocalGatewayRouteTableId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the local gateway route table.
[REQUIRED]
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Routes': [
{
'DestinationCidrBlock': 'string',
'LocalGatewayVirtualInterfaceGroupId': 'string',
'Type': 'static'|'propagated',
'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted',
'LocalGatewayRouteTableId': 'string',
'LocalGatewayRouteTableArn': 'string',
'OwnerId': 'string'
},
],
}
Response Structure
(dict) --
Routes (list) --
Information about the routes.
(dict) --
Describes a route for a local gateway route table.
DestinationCidrBlock (string) --
The CIDR block used for destination matches.
LocalGatewayVirtualInterfaceGroupId (string) --
The ID of the virtual interface group.
Type (string) --
The route type.
State (string) --
The state of the route.
LocalGatewayRouteTableId (string) --
The ID of the local gateway route table.
LocalGatewayRouteTableArn (string) --
The Amazon Resource Name (ARN) of the local gateway route table.
OwnerId (string) --
The AWS account ID that owns the local gateway route.
paginator = client.get_paginator('search_transit_gateway_multicast_groups')
Creates an iterator that will paginate through responses from EC2.Client.search_transit_gateway_multicast_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TransitGatewayMulticastDomainId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
One or more filters. The possible values are:
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'MulticastGroups': [
{
'GroupIpAddress': 'string',
'TransitGatewayAttachmentId': 'string',
'SubnetId': 'string',
'ResourceId': 'string',
'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
'ResourceOwnerId': 'string',
'NetworkInterfaceId': 'string',
'GroupMember': True|False,
'GroupSource': True|False,
'MemberType': 'static'|'igmp',
'SourceType': 'static'|'igmp'
},
],
}
Response Structure
(dict) --
MulticastGroups (list) --
Information about the transit gateway multicast group.
(dict) --
Describes the transit gateway multicast group resources.
GroupIpAddress (string) --
The IP address assigned to the transit gateway multicast group.
TransitGatewayAttachmentId (string) --
The ID of the transit gateway attachment.
SubnetId (string) --
The ID of the subnet.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The type of resource, for example a VPC attachment.
ResourceOwnerId (string) --
The ID of the AWS account that owns the transit gateway multicast domain group resource.
NetworkInterfaceId (string) --
The ID of the transit gateway attachment.
GroupMember (boolean) --
Indicates that the resource is a transit gateway multicast group member.
GroupSource (boolean) --
Indicates that the resource is a transit gateway multicast group member.
MemberType (string) --
The member type (for example, static ).
SourceType (string) --
The source type.
The available waiters are:
waiter = client.get_waiter('bundle_task_complete')
Polls EC2.Client.describe_bundle_tasks() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
BundleIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The bundle task IDs.
Default: Describes all your bundle tasks.
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('conversion_task_cancelled')
Polls EC2.Client.describe_conversion_tasks() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ConversionTaskIds=[
'string',
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The conversion task IDs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('conversion_task_completed')
Polls EC2.Client.describe_conversion_tasks() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ConversionTaskIds=[
'string',
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The conversion task IDs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('conversion_task_deleted')
Polls EC2.Client.describe_conversion_tasks() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ConversionTaskIds=[
'string',
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The conversion task IDs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('customer_gateway_available')
Polls EC2.Client.describe_customer_gateways() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
CustomerGatewayIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more customer gateway IDs.
Default: Describes all your customer gateways.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('export_task_cancelled')
Polls EC2.Client.describe_export_tasks() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ExportTaskIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The export task IDs.
the filters for the export tasks.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('export_task_completed')
Polls EC2.Client.describe_export_tasks() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ExportTaskIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The export task IDs.
the filters for the export tasks.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('image_available')
Polls EC2.Client.describe_images() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ExecutableUsers=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ImageIds=[
'string',
],
Owners=[
'string',
],
IncludeDeprecated=True|False,
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The image IDs.
Default: Describes all images available to you.
Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, self , amazon , and aws-marketplace . If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.
If true , all deprecated AMIs are included in the response. If false , no deprecated AMIs are included in the response. If no value is specified, the default value is false .
Note
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false ) that you set for this parameter.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('image_exists')
Polls EC2.Client.describe_images() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ExecutableUsers=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ImageIds=[
'string',
],
Owners=[
'string',
],
IncludeDeprecated=True|False,
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The image IDs.
Default: Describes all images available to you.
Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, self , amazon , and aws-marketplace . If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.
If true , all deprecated AMIs are included in the response. If false , no deprecated AMIs are included in the response. If no value is specified, the default value is false .
Note
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false ) that you set for this parameter.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('instance_exists')
Polls EC2.Client.describe_instances() every 5 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('instance_running')
Polls EC2.Client.describe_instances() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('instance_status_ok')
Polls EC2.Client.describe_instance_status() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
MaxResults=123,
NextToken='string',
DryRun=True|False,
IncludeAllInstances=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
When true , includes the health status for all instances. When false , includes the health status for running instances only.
Default: false
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('instance_stopped')
Polls EC2.Client.describe_instances() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('instance_terminated')
Polls EC2.Client.describe_instances() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('key_pair_exists')
Polls EC2.Client.describe_key_pairs() every 5 seconds until a successful state is reached. An error is returned after 6 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
KeyNames=[
'string',
],
KeyPairIds=[
'string',
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The key pair names.
Default: Describes all of your key pairs.
The IDs of the key pairs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 6
None
waiter = client.get_waiter('nat_gateway_available')
Polls EC2.Client.describe_nat_gateways() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NatGatewayIds=[
'string',
],
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more NAT gateway IDs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('network_interface_available')
Polls EC2.Client.describe_network_interfaces() every 20 seconds until a successful state is reached. An error is returned after 10 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NetworkInterfaceIds=[
'string',
],
NextToken='string',
MaxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more network interface IDs.
Default: Describes all your network interfaces.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 20
The maximum number of attempts to be made. Default: 10
None
waiter = client.get_waiter('password_data_available')
Polls EC2.Client.get_password_data() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
InstanceId='string',
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The ID of the Windows instance.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('security_group_exists')
Polls EC2.Client.describe_security_groups() every 5 seconds until a successful state is reached. An error is returned after 6 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
GroupIds=[
'string',
],
GroupNames=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 6
None
waiter = client.get_waiter('snapshot_completed')
Polls EC2.Client.describe_snapshots() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
OwnerIds=[
'string',
],
RestorableByUserIds=[
'string',
],
SnapshotIds=[
'string',
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self , and amazon .
The IDs of the AWS accounts that can create volumes from the snapshot.
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('spot_instance_request_fulfilled')
Polls EC2.Client.describe_spot_instance_requests() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
SpotInstanceRequestIds=[
'string',
],
NextToken='string',
MaxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more Spot Instance request IDs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('subnet_available')
Polls EC2.Client.describe_subnets() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
SubnetIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more subnet IDs.
Default: Describes all your subnets.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('system_status_ok')
Polls EC2.Client.describe_instance_status() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
MaxResults=123,
NextToken='string',
DryRun=True|False,
IncludeAllInstances=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
When true , includes the health status for all instances. When false , includes the health status for running instances only.
Default: false
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('volume_available')
Polls EC2.Client.describe_volumes() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VolumeIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The volume IDs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('volume_deleted')
Polls EC2.Client.describe_volumes() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VolumeIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The volume IDs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('volume_in_use')
Polls EC2.Client.describe_volumes() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VolumeIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The volume IDs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('vpc_available')
Polls EC2.Client.describe_vpcs() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpcIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC IDs.
Default: Describes all your VPCs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('vpc_exists')
Polls EC2.Client.describe_vpcs() every 1 seconds until a successful state is reached. An error is returned after 5 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpcIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC IDs.
Default: Describes all your VPCs.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 1
The maximum number of attempts to be made. Default: 5
None
waiter = client.get_waiter('vpc_peering_connection_deleted')
Polls EC2.Client.describe_vpc_peering_connections() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
VpcPeeringConnectionIds=[
'string',
],
NextToken='string',
MaxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('vpc_peering_connection_exists')
Polls EC2.Client.describe_vpc_peering_connections() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
VpcPeeringConnectionIds=[
'string',
],
NextToken='string',
MaxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('vpn_connection_available')
Polls EC2.Client.describe_vpn_connections() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpnConnectionIds=[
'string',
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPN connection IDs.
Default: Describes your VPN connections.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('vpn_connection_deleted')
Polls EC2.Client.describe_vpn_connections() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpnConnectionIds=[
'string',
],
DryRun=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPN connection IDs.
Default: Describes your VPN connections.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
A resource representing Amazon Elastic Compute Cloud (EC2):
import boto3
ec2 = boto3.resource('ec2')
These are the resource's available actions:
These are the resource's available sub-resources:
These are the resource's available collections:
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132 .
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
dhcp_options = ec2.create_dhcp_options(
DhcpConfigurations=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
A DHCP configuration option.
The tags to assign to the DHCP option.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.DhcpOptions
DhcpOptions resource
Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
You can create a launch template , which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances , you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances . You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources .
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs .
For troubleshooting, see What to do if an instance immediately terminates , and Troubleshooting connecting to your instance .
See also: AWS API Documentation
Request Syntax
instance = ec2.create_instances(
BlockDeviceMappings=[
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
ImageId='string',
InstanceType='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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
Ipv6AddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string'
},
],
KernelId='string',
KeyName='string',
MaxCount=123,
MinCount=123,
Monitoring={
'Enabled': True|False
},
Placement={
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
},
RamdiskId='string',
SecurityGroupIds=[
'string',
],
SecurityGroups=[
'string',
],
SubnetId='string',
UserData='string',
AdditionalInfo='string',
ClientToken='string',
DisableApiTermination=True|False,
DryRun=True|False,
EbsOptimized=True|False,
IamInstanceProfile={
'Arn': 'string',
'Name': 'string'
},
InstanceInitiatedShutdownBehavior='stop'|'terminate',
NetworkInterfaces=[
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
PrivateIpAddress='string',
ElasticGpuSpecification=[
{
'Type': 'string'
},
],
ElasticInferenceAccelerators=[
{
'Type': 'string',
'Count': 123
},
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
LaunchTemplate={
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
InstanceMarketOptions={
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
CreditSpecification={
'CpuCredits': 'string'
},
CpuOptions={
'CoreCount': 123,
'ThreadsPerCore': 123
},
CapacityReservationSpecification={
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
HibernationOptions={
'Configured': True|False
},
LicenseSpecifications=[
{
'LicenseConfigurationArn': 'string'
},
],
MetadataOptions={
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
EnclaveOptions={
'Enabled': True|False
}
)
The block device mapping entries.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .
Default: m1.small
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
Describes an IPv6 address.
The IPv6 address.
The ID of the kernel.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .
Warning
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
[REQUIRED]
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount .
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
[REQUIRED]
The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
Specifies whether detailed monitoring is enabled for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
The placement for the instance.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The name of the placement group the instance is in.
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Reserved for future use.
This parameter is not supported by CreateFleet .
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .
The IDs of the security groups. You can create a security group using CreateSecurityGroup .
If you specify a network interface, you must specify any security groups as part of the network interface.
[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
[EC2-VPC] The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
The user data to make available to the instance. For more information, see Running commands on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency .
Constraints: Maximum 64 ASCII characters
This field is autopopulated if not provided.
If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.
Default: false
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The name or Amazon Resource Name (ARN) of an IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
Describes a network interface.
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
The description of the network interface. Applies only if creating a network interface when launching an instance.
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
Describes an IPv6 address.
The IPv6 address.
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
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.
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide .
A specification for an Elastic Graphics accelerator.
The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see Elastic Graphics Basics , specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances .
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Describes an elastic inference accelerator.
The type of elastic inference accelerator. The possible values are eia1.medium , eia1.large , eia1.xlarge , eia2.medium , eia2.large , and eia2.xlarge .
The number of elastic inference accelerators to attach to the instance.
Default: 1
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
The ID of the launch template.
The name of the launch template.
The version number of the launch template.
Default: The default version for the launch template.
The market (purchasing) option for the instances.
For RunInstances , persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop .
The market type.
The options for Spot Instances.
The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price.
The Spot Instance request type. For RunInstances , persistent Spot Instance requests are only supported when the instance interruption behavior is either hibernate or stop .
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
You can't specify an Availability Zone group or a launch group if you specify a duration.
New accounts or accounts with no previous billing history with Amazon Web Services are not eligible for Spot Instances with a defined duration (also known as Spot blocks).
The end date of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). Supported only for persistent requests.
The behavior when a Spot Instance is interrupted. The default is terminate .
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited . To change this attribute after launch, use ModifyInstanceCreditSpecification . For more information, see Burstable performance instances in the Amazon EC2 User Guide .
Default: standard (T2 instances) or unlimited (T3/T3a instances)
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon EC2 User Guide .
The number of CPU cores for the instance.
The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1 . Otherwise, specify the default value of 2 .
Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
Information about the target Capacity Reservation or Capacity Reservation group.
The ID of the Capacity Reservation in which to run the instance.
The ARN of the Capacity Reservation resource group in which to run the instance.
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
If you set this parameter to true , your instance is enabled for hibernation.
Default: false
The license configurations.
Describes a license configuration.
The Amazon Resource Name (ARN) of the license configuration.
The metadata options for the instance. For more information, see Instance metadata and user data .
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide .
You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true .
list(ec2.Instance)
A list of Instance resources
Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway .
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
internet_gateway = ec2.create_internet_gateway(
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
The tags to assign to the internet gateway.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.InternetGateway
InternetGateway resource
Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair .
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
key_pair = ec2.create_key_pair(
KeyName='string',
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
A unique name for the key pair.
Constraints: Up to 255 ASCII characters
The tags to apply to the new key pair.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.KeyPair
KeyPair resource
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
network_acl = ec2.create_network_acl(
DryRun=True|False,
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the VPC.
The tags to assign to the network ACL.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.NetworkAcl
NetworkAcl resource
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
network_interface = ec2.create_network_interface(
Description='string',
DryRun=True|False,
Groups=[
'string',
],
Ipv6AddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string'
},
],
PrivateIpAddress='string',
PrivateIpAddresses=[
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
SecondaryPrivateIpAddressCount=123,
InterfaceType='efa'|'branch'|'trunk',
SubnetId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
The IDs of one or more security groups.
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
Describes an IPv6 address.
The IPv6 address.
One or more private IPv4 addresses.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .
[REQUIRED]
The ID of the subnet to associate with the network interface.
The tags to apply to the new network interface.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
ec2.NetworkInterface
NetworkInterface resource
Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
placement_group = ec2.create_placement_group(
DryRun=True|False,
GroupName='string',
Strategy='cluster'|'spread'|'partition',
PartitionCount=123,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
The tags to apply to the new placement group.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.PlacementGroup
PlacementGroup resource
Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
route_table = ec2.create_route_table(
DryRun=True|False,
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The ID of the VPC.
The tags to assign to the route table.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.RouteTable
RouteTable resource
Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress , AuthorizeSecurityGroupEgress , RevokeSecurityGroupIngress , and RevokeSecurityGroupEgress .
For more information about VPC security group limits, see Amazon VPC Limits .
See also: AWS API Documentation
Request Syntax
security_group = ec2.create_security_group(
Description='string',
GroupName='string',
VpcId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[REQUIRED]
The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg- .
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
The tags to assign to the security group.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.SecurityGroup
SecurityGroup resource
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending .
To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide .
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
snapshot = ec2.create_snapshot(
Description='string',
OutpostArn='string',
VolumeId='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.
For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide .
[REQUIRED]
The ID of the EBS volume.
The tags to apply to the snapshot during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.Snapshot
Snapshot resource
Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
Warning
AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
subnet = ec2.create_subnet(
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
AvailabilityZone='string',
AvailabilityZoneId='string',
CidrBlock='string',
Ipv6CidrBlock='string',
OutpostArn='string',
VpcId='string',
DryRun=True|False
)
The tags to assign to the subnet.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The Availability Zone or Local Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a . For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide .
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
[REQUIRED]
The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .
[REQUIRED]
The ID of the VPC.
ec2.Subnet
Subnet resource
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = ec2.create_tags(
DryRun=True|False,
Resources=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
None
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
You can tag your volumes during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide .
For more information, see Creating an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
volume = ec2.create_volume(
AvailabilityZone='string',
Encrypted=True|False,
Iops=123,
KmsKeyId='string',
OutpostArn='string',
Size=123,
SnapshotId='string',
VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiAttachEnabled=True|False,
Throughput=123
)
[REQUIRED]
The Availability Zone in which to create the volume.
Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide .
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true .
You can specify the CMK using any of the following:
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. This parameter can be one of the following values:
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .
Default: gp2
The tags to apply to the volume during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
ec2.Volume
Volume resource
Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP ).
By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .
You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
vpc = ec2.create_vpc(
CidrBlock='string',
AmazonProvidedIpv6CidrBlock=True|False,
Ipv6Pool='string',
Ipv6CidrBlock='string',
DryRun=True|False,
InstanceTenancy='default'|'dedicated'|'host',
Ipv6CidrBlockNetworkBorderGroup='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .
The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
The tenancy options for instances launched into the VPC. For default , instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated , instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
The tags to assign to the VPC.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.Vpc
Vpc resource
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Note
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide .
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed .
See also: AWS API Documentation
Request Syntax
vpc_peering_connection = ec2.create_vpc_peering_connection(
DryRun=True|False,
PeerOwnerId='string',
PeerVpcId='string',
VpcId='string',
PeerRegion='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
The tags to assign to the peering connection.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.VpcPeeringConnection
VpcPeeringConnection resource
Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = ec2.disassociate_route_table(
AssociationId='string',
DryRun=True|False
)
[REQUIRED]
The association ID representing the current association between the route table and subnet or gateway.
None
Returns a list of all the available sub-resources for this Resource.
Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair , in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
key_pair_info = ec2.import_key_pair(
DryRun=True|False,
KeyName='string',
PublicKeyMaterial=b'bytes',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
A unique name for the key pair.
[REQUIRED]
The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
The tags to apply to the imported key pair.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.KeyPairInfo
KeyPairInfo resource
Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide .
Note
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide .
AWS Marketplace product codes
If any snapshots have AWS Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Obtaining billing information in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
image = ec2.register_image(
ImageLocation='string',
Architecture='i386'|'x86_64'|'arm64',
BlockDeviceMappings=[
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
Description='string',
DryRun=True|False,
EnaSupport=True|False,
KernelId='string',
Name='string',
BillingProducts=[
'string',
],
RamdiskId='string',
RootDeviceName='string',
SriovNetSupport='string',
VirtualizationType='string',
BootMode='legacy-bios'|'uefi'
)
The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386 . For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an EBS volume using the ID of an EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide .
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
[REQUIRED]
A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
The type of virtualization (hvm | paravirtual ).
Default: paravirtual
ec2.Image
Image resource
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Creates a ClassicAddress resource.:
classic_address = ec2.ClassicAddress('public_ip')
Creates a DhcpOptions resource.:
dhcp_options = ec2.DhcpOptions('id')
Creates a Image resource.:
image = ec2.Image('id')
Creates a Instance resource.:
instance = ec2.Instance('id')
Creates a InternetGateway resource.:
internet_gateway = ec2.InternetGateway('id')
Creates a KeyPairInfo resource.:
key_pair_info = ec2.KeyPair('name')
Creates a NetworkAcl resource.:
network_acl = ec2.NetworkAcl('id')
Creates a NetworkInterface resource.:
network_interface = ec2.NetworkInterface('id')
Creates a NetworkInterfaceAssociation resource.:
network_interface_association = ec2.NetworkInterfaceAssociation('id')
Creates a PlacementGroup resource.:
placement_group = ec2.PlacementGroup('name')
Creates a Route resource.:
route = ec2.Route('route_table_id','destination_cidr_block')
A Route resource
Creates a RouteTable resource.:
route_table = ec2.RouteTable('id')
Creates a RouteTableAssociation resource.:
route_table_association = ec2.RouteTableAssociation('id')
Creates a SecurityGroup resource.:
security_group = ec2.SecurityGroup('id')
Creates a Snapshot resource.:
snapshot = ec2.Snapshot('id')
Creates a Subnet resource.:
subnet = ec2.Subnet('id')
Creates a Tag resource.:
tag = ec2.Tag('resource_id','key','value')
A Tag resource
Creates a Volume resource.:
volume = ec2.Volume('id')
Creates a Vpc resource.:
vpc = ec2.Vpc('id')
Creates a VpcAddress resource.:
vpc_address = ec2.VpcAddress('allocation_id')
Creates a VpcPeeringConnection resource.:
vpc_peering_connection = ec2.VpcPeeringConnection('id')
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
A collection of ClassicAddress resources.A ClassicAddress Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all ClassicAddress resources in the collection.
See also: AWS API Documentation
Request Syntax
classic_address_iterator = ec2.classic_addresses.all()
Creates an iterable of all ClassicAddress resources in the collection filtered by kwargs passed to method.A ClassicAddress collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
classic_address_iterator = ec2.classic_addresses.filter(
PublicIps=[
'string',
],
AllocationIds=[
'string',
],
DryRun=True|False
)
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
[EC2-VPC] Information about the allocation IDs.
list(ec2.ClassicAddress)
A list of ClassicAddress resources
Creates an iterable up to a specified amount of ClassicAddress resources in the collection.
See also: AWS API Documentation
Request Syntax
classic_address_iterator = ec2.classic_addresses.limit(
count=123
)
Creates an iterable of all ClassicAddress resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
classic_address_iterator = ec2.classic_addresses.page_size(
count=123
)
A collection of DhcpOptions resources.A DhcpOptions Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all DhcpOptions resources in the collection.
See also: AWS API Documentation
Request Syntax
dhcp_options_iterator = ec2.dhcp_options_sets.all()
Creates an iterable of all DhcpOptions resources in the collection filtered by kwargs passed to method.A DhcpOptions collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
dhcp_options_iterator = ec2.dhcp_options_sets.filter(
DhcpOptionsIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
list(ec2.DhcpOptions)
A list of DhcpOptions resources
Creates an iterable up to a specified amount of DhcpOptions resources in the collection.
See also: AWS API Documentation
Request Syntax
dhcp_options_iterator = ec2.dhcp_options_sets.limit(
count=123
)
Creates an iterable of all DhcpOptions resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
dhcp_options_iterator = ec2.dhcp_options_sets.page_size(
count=123
)
A collection of Image resources.A Image Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Image resources in the collection.
See also: AWS API Documentation
Request Syntax
image_iterator = ec2.images.all()
Creates an iterable of all Image resources in the collection filtered by kwargs passed to method.A Image collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
image_iterator = ec2.images.filter(
ExecutableUsers=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
ImageIds=[
'string',
],
Owners=[
'string',
],
IncludeDeprecated=True|False,
DryRun=True|False
)
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The image IDs.
Default: Describes all images available to you.
Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, self , amazon , and aws-marketplace . If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.
If true , all deprecated AMIs are included in the response. If false , no deprecated AMIs are included in the response. If no value is specified, the default value is false .
Note
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false ) that you set for this parameter.
list(ec2.Image)
A list of Image resources
Creates an iterable up to a specified amount of Image resources in the collection.
See also: AWS API Documentation
Request Syntax
image_iterator = ec2.images.limit(
count=123
)
Creates an iterable of all Image resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
image_iterator = ec2.images.page_size(
count=123
)
A collection of Instance resources.A Instance Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Instance resources in the collection.
See also: AWS API Documentation
Request Syntax
instance_iterator = ec2.instances.all()
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = ec2.instances.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
None
Creates an iterable of all Instance resources in the collection filtered by kwargs passed to method.A Instance collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
instance_iterator = ec2.instances.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The instance IDs.
Default: Describes all your instances.
list(ec2.Instance)
A list of Instance resources
Creates an iterable up to a specified amount of Instance resources in the collection.
See also: AWS API Documentation
Request Syntax
instance_iterator = ec2.instances.limit(
count=123
)
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
To disable detailed monitoring, see .
See also: AWS API Documentation
Request Syntax
response = ec2.instances.monitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Creates an iterable of all Instance resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
instance_iterator = ec2.instances.page_size(
count=123
)
Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = ec2.instances.reboot(
DryRun=True|False
)
Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = ec2.instances.start(
AdditionalInfo='string',
DryRun=True|False
)
dict
Response Syntax
{
'StartingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StartingInstances (list) --
Information about the started instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon EC2 User Guide .
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide .
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = ec2.instances.stop(
Hibernate=True|False,
DryRun=True|False,
Force=True|False
)
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
Default: false
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
dict
Response Syntax
{
'StoppingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StoppingInstances (list) --
Information about the stopped instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
For example, say you have the following instances:
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = ec2.instances.terminate(
DryRun=True|False
)
{
'TerminatingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
Information about the terminated instances.
Describes an instance state change.
The current state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
The ID of the instance.
The previous state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = ec2.instances.unmonitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
A collection of InternetGateway resources.A InternetGateway Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all InternetGateway resources in the collection.
See also: AWS API Documentation
Request Syntax
internet_gateway_iterator = ec2.internet_gateways.all()
Creates an iterable of all InternetGateway resources in the collection filtered by kwargs passed to method.A InternetGateway collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
internet_gateway_iterator = ec2.internet_gateways.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
InternetGatewayIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more internet gateway IDs.
Default: Describes all your internet gateways.
list(ec2.InternetGateway)
A list of InternetGateway resources
Creates an iterable up to a specified amount of InternetGateway resources in the collection.
See also: AWS API Documentation
Request Syntax
internet_gateway_iterator = ec2.internet_gateways.limit(
count=123
)
Creates an iterable of all InternetGateway resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
internet_gateway_iterator = ec2.internet_gateways.page_size(
count=123
)
A collection of KeyPairInfo resources.A KeyPairInfo Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all KeyPairInfo resources in the collection.
See also: AWS API Documentation
Request Syntax
key_pair_info_iterator = ec2.key_pairs.all()
Creates an iterable of all KeyPairInfo resources in the collection filtered by kwargs passed to method.A KeyPairInfo collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
key_pair_info_iterator = ec2.key_pairs.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
KeyNames=[
'string',
],
KeyPairIds=[
'string',
],
DryRun=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The key pair names.
Default: Describes all of your key pairs.
The IDs of the key pairs.
list(ec2.KeyPairInfo)
A list of KeyPairInfo resources
Creates an iterable up to a specified amount of KeyPairInfo resources in the collection.
See also: AWS API Documentation
Request Syntax
key_pair_info_iterator = ec2.key_pairs.limit(
count=123
)
Creates an iterable of all KeyPairInfo resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
key_pair_info_iterator = ec2.key_pairs.page_size(
count=123
)
A collection of NetworkAcl resources.A NetworkAcl Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all NetworkAcl resources in the collection.
See also: AWS API Documentation
Request Syntax
network_acl_iterator = ec2.network_acls.all()
Creates an iterable of all NetworkAcl resources in the collection filtered by kwargs passed to method.A NetworkAcl collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
network_acl_iterator = ec2.network_acls.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NetworkAclIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more network ACL IDs.
Default: Describes all your network ACLs.
list(ec2.NetworkAcl)
A list of NetworkAcl resources
Creates an iterable up to a specified amount of NetworkAcl resources in the collection.
See also: AWS API Documentation
Request Syntax
network_acl_iterator = ec2.network_acls.limit(
count=123
)
Creates an iterable of all NetworkAcl resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
network_acl_iterator = ec2.network_acls.page_size(
count=123
)
A collection of NetworkInterface resources.A NetworkInterface Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all NetworkInterface resources in the collection.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = ec2.network_interfaces.all()
Creates an iterable of all NetworkInterface resources in the collection filtered by kwargs passed to method.A NetworkInterface collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = ec2.network_interfaces.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NetworkInterfaceIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more network interface IDs.
Default: Describes all your network interfaces.
list(ec2.NetworkInterface)
A list of NetworkInterface resources
Creates an iterable up to a specified amount of NetworkInterface resources in the collection.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = ec2.network_interfaces.limit(
count=123
)
Creates an iterable of all NetworkInterface resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = ec2.network_interfaces.page_size(
count=123
)
A collection of PlacementGroup resources.A PlacementGroup Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all PlacementGroup resources in the collection.
See also: AWS API Documentation
Request Syntax
placement_group_iterator = ec2.placement_groups.all()
Creates an iterable of all PlacementGroup resources in the collection filtered by kwargs passed to method.A PlacementGroup collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
placement_group_iterator = ec2.placement_groups.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
GroupNames=[
'string',
],
GroupIds=[
'string',
]
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
The IDs of the placement groups.
list(ec2.PlacementGroup)
A list of PlacementGroup resources
Creates an iterable up to a specified amount of PlacementGroup resources in the collection.
See also: AWS API Documentation
Request Syntax
placement_group_iterator = ec2.placement_groups.limit(
count=123
)
Creates an iterable of all PlacementGroup resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
placement_group_iterator = ec2.placement_groups.page_size(
count=123
)
A collection of RouteTable resources.A RouteTable Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all RouteTable resources in the collection.
See also: AWS API Documentation
Request Syntax
route_table_iterator = ec2.route_tables.all()
Creates an iterable of all RouteTable resources in the collection filtered by kwargs passed to method.A RouteTable collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
route_table_iterator = ec2.route_tables.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
RouteTableIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more route table IDs.
Default: Describes all your route tables.
list(ec2.RouteTable)
A list of RouteTable resources
Creates an iterable up to a specified amount of RouteTable resources in the collection.
See also: AWS API Documentation
Request Syntax
route_table_iterator = ec2.route_tables.limit(
count=123
)
Creates an iterable of all RouteTable resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
route_table_iterator = ec2.route_tables.page_size(
count=123
)
A collection of SecurityGroup resources.A SecurityGroup Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all SecurityGroup resources in the collection.
See also: AWS API Documentation
Request Syntax
security_group_iterator = ec2.security_groups.all()
Creates an iterable of all SecurityGroup resources in the collection filtered by kwargs passed to method.A SecurityGroup collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
security_group_iterator = ec2.security_groups.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
GroupIds=[
'string',
],
GroupNames=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
list(ec2.SecurityGroup)
A list of SecurityGroup resources
Creates an iterable up to a specified amount of SecurityGroup resources in the collection.
See also: AWS API Documentation
Request Syntax
security_group_iterator = ec2.security_groups.limit(
count=123
)
Creates an iterable of all SecurityGroup resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
security_group_iterator = ec2.security_groups.page_size(
count=123
)
A collection of Snapshot resources.A Snapshot Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Snapshot resources in the collection.
See also: AWS API Documentation
Request Syntax
snapshot_iterator = ec2.snapshots.all()
Creates an iterable of all Snapshot resources in the collection filtered by kwargs passed to method.A Snapshot collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
snapshot_iterator = ec2.snapshots.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
OwnerIds=[
'string',
],
RestorableByUserIds=[
'string',
],
SnapshotIds=[
'string',
],
DryRun=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self , and amazon .
The IDs of the AWS accounts that can create volumes from the snapshot.
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
list(ec2.Snapshot)
A list of Snapshot resources
Creates an iterable up to a specified amount of Snapshot resources in the collection.
See also: AWS API Documentation
Request Syntax
snapshot_iterator = ec2.snapshots.limit(
count=123
)
Creates an iterable of all Snapshot resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
snapshot_iterator = ec2.snapshots.page_size(
count=123
)
A collection of Subnet resources.A Subnet Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Subnet resources in the collection.
See also: AWS API Documentation
Request Syntax
subnet_iterator = ec2.subnets.all()
Creates an iterable of all Subnet resources in the collection filtered by kwargs passed to method.A Subnet collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
subnet_iterator = ec2.subnets.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
SubnetIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more subnet IDs.
Default: Describes all your subnets.
list(ec2.Subnet)
A list of Subnet resources
Creates an iterable up to a specified amount of Subnet resources in the collection.
See also: AWS API Documentation
Request Syntax
subnet_iterator = ec2.subnets.limit(
count=123
)
Creates an iterable of all Subnet resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
subnet_iterator = ec2.subnets.page_size(
count=123
)
A collection of Volume resources.A Volume Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Volume resources in the collection.
See also: AWS API Documentation
Request Syntax
volume_iterator = ec2.volumes.all()
Creates an iterable of all Volume resources in the collection filtered by kwargs passed to method.A Volume collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
volume_iterator = ec2.volumes.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VolumeIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
The volume IDs.
list(ec2.Volume)
A list of Volume resources
Creates an iterable up to a specified amount of Volume resources in the collection.
See also: AWS API Documentation
Request Syntax
volume_iterator = ec2.volumes.limit(
count=123
)
Creates an iterable of all Volume resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
volume_iterator = ec2.volumes.page_size(
count=123
)
A collection of VpcAddress resources.A VpcAddress Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all VpcAddress resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_address_iterator = ec2.vpc_addresses.all()
Creates an iterable of all VpcAddress resources in the collection filtered by kwargs passed to method.A VpcAddress collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
vpc_address_iterator = ec2.vpc_addresses.filter(
PublicIps=[
'string',
],
AllocationIds=[
'string',
],
DryRun=True|False
)
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
[EC2-VPC] Information about the allocation IDs.
list(ec2.VpcAddress)
A list of VpcAddress resources
Creates an iterable up to a specified amount of VpcAddress resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_address_iterator = ec2.vpc_addresses.limit(
count=123
)
Creates an iterable of all VpcAddress resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
vpc_address_iterator = ec2.vpc_addresses.page_size(
count=123
)
A collection of VpcPeeringConnection resources.A VpcPeeringConnection Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all VpcPeeringConnection resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = ec2.vpc_peering_connections.all()
Creates an iterable of all VpcPeeringConnection resources in the collection filtered by kwargs passed to method.A VpcPeeringConnection collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = ec2.vpc_peering_connections.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
VpcPeeringConnectionIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
list(ec2.VpcPeeringConnection)
A list of VpcPeeringConnection resources
Creates an iterable up to a specified amount of VpcPeeringConnection resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = ec2.vpc_peering_connections.limit(
count=123
)
Creates an iterable of all VpcPeeringConnection resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = ec2.vpc_peering_connections.page_size(
count=123
)
A collection of Vpc resources.A Vpc Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Vpc resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_iterator = ec2.vpcs.all()
Creates an iterable of all Vpc resources in the collection filtered by kwargs passed to method.A Vpc collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
vpc_iterator = ec2.vpcs.filter(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
VpcIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
One or more VPC IDs.
Default: Describes all your VPCs.
list(ec2.Vpc)
A list of Vpc resources
Creates an iterable up to a specified amount of Vpc resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_iterator = ec2.vpcs.limit(
count=123
)
Creates an iterable of all Vpc resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
vpc_iterator = ec2.vpcs.page_size(
count=123
)
A resource representing an Amazon Elastic Compute Cloud (EC2) ClassicAddress:
import boto3
ec2 = boto3.resource('ec2')
classic_address = ec2.ClassicAddress('public_ip')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The ClassicAddress's public_ip identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The ID representing the allocation of the address for use with EC2-VPC.
(string) --
The ID representing the association of the address with an instance in a VPC.
(string) --
The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
(string) --
The customer-owned IP address.
(string) --
The ID of the customer-owned address pool.
(string) --
Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc ).
(string) --
The ID of the instance that the address is associated with (if any).
(string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
(string) --
The ID of the network interface.
(string) --
The ID of the account that owns the network interface.
(string) --
The private IP address associated with the Elastic IP address.
(string) --
The ID of an address pool.
(list) --
Any tags assigned to the Elastic IP address.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
Warning
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing .
See also: AWS API Documentation
Request Syntax
response = classic_address.associate(
AllocationId='string',
InstanceId='string',
AllowReassociation=True|False,
DryRun=True|False,
NetworkInterfaceId='string',
PrivateIpAddress='string'
)
[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
dict
Response Syntax
{
'AssociationId': 'string'
}
Response Structure
(dict) --
AssociationId (string) --
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
See also: AWS API Documentation
Request Syntax
response = classic_address.disassociate(
AssociationId='string',
DryRun=True|False
)
None
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_addresses() to update the attributes of the ClassicAddress resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
classic_address.load()
Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress .
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse ).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress .
See also: AWS API Documentation
Request Syntax
response = classic_address.release(
AllocationId='string',
NetworkBorderGroup='string',
DryRun=True|False
)
The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes .
Note
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes .
None
Calls EC2.Client.describe_addresses() to update the attributes of the ClassicAddress resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
classic_address.reload()
A resource representing an Amazon Elastic Compute Cloud (EC2) DhcpOptions:
import boto3
ec2 = boto3.resource('ec2')
dhcp_options = ec2.DhcpOptions('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The DhcpOptions's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(list) --
One or more DHCP options in the set.
(dict) --
Describes a DHCP configuration option.
Key (string) --
The name of a DHCP option.
Values (list) --
One or more values for the DHCP option.
(dict) --
Describes a value for a resource attribute that is a String.
Value (string) --
The attribute value. The value is case-sensitive.
(string) --
The ID of the set of DHCP options.
(string) --
The ID of the AWS account that owns the DHCP options set.
(list) --
Any tags assigned to the DHCP options set.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = dhcp_options.associate_with_vpc(
VpcId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the VPC.
None
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = dhcp_options.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
See also: AWS API Documentation
Request Syntax
response = dhcp_options.delete(
DryRun=True|False
)
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_dhcp_options() to update the attributes of the DhcpOptions resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
dhcp_options.load()
Calls EC2.Client.describe_dhcp_options() to update the attributes of the DhcpOptions resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
dhcp_options.reload()
A resource representing an Amazon Elastic Compute Cloud (EC2) Image:
import boto3
ec2 = boto3.resource('ec2')
image = ec2.Image('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
These are the resource's available waiters:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The Image's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The architecture of the image.
(list) --
Any block device mapping entries.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
(string) --
The boot mode of the image. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide .
(string) --
The date and time the image was created.
(string) --
The date and time to deprecate the AMI, in UTC, in the following format: YYYY -MM -DD T*HH* :MM :SS Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
(string) --
The description of the AMI that was provided during image creation.
(boolean) --
Specifies whether enhanced networking with ENA is enabled.
(string) --
The hypervisor type of the image.
(string) --
The ID of the AMI.
(string) --
The location of the AMI.
(string) --
The AWS account alias (for example, amazon , self ) or the AWS account ID of the AMI owner.
(string) --
The type of image.
(string) --
The kernel associated with the image, if any. Only applicable for machine images.
(string) --
The name of the AMI that was provided during image creation.
(string) --
The AWS account ID of the image owner.
(string) --
This value is set to windows for Windows AMIs; otherwise, it is blank.
(string) --
The platform details associated with the billing code of the AMI. For more information, see Obtaining Billing Information in the Amazon Elastic Compute Cloud User Guide .
(list) --
Any product codes associated with the AMI.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
(boolean) --
Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
(string) --
The RAM disk associated with the image, if any. Only applicable for machine images.
(string) --
The device name of the root device volume (for example, /dev/sda1 ).
(string) --
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
(string) --
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
(string) --
The current state of the AMI. If the state is available , the image is successfully registered and can be used to launch an instance.
(dict) --
The reason for the state change.
Code (string) --
The reason code for the state change.
Message (string) --
The message for the state change.
(list) --
Any tags assigned to the image.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your AWS Cost and Usage Report and in the AWS Price List API . For the list of UsageOperation codes, see Platform Details and Usage Operation Billing Codes in the Amazon Elastic Compute Cloud User Guide .
(string) --
The type of virtualization of the AMI.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = image.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
See also: AWS API Documentation
Request Syntax
response = image.deregister(
DryRun=True|False
)
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = image.describe_attribute(
Attribute='description'|'kernel'|'ramdisk'|'launchPermission'|'productCodes'|'blockDeviceMapping'|'sriovNetSupport'|'bootMode',
DryRun=True|False
)
[REQUIRED]
The AMI attribute.
Note : The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.
dict
Response Syntax
{
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
'ImageId': 'string',
'LaunchPermissions': [
{
'Group': 'all',
'UserId': 'string'
},
],
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'Description': {
'Value': 'string'
},
'KernelId': {
'Value': 'string'
},
'RamdiskId': {
'Value': 'string'
},
'SriovNetSupport': {
'Value': 'string'
},
'BootMode': {
'Value': 'string'
}
}
Response Structure
(dict) --
Describes an image attribute.
BlockDeviceMappings (list) --
The block device mapping entries.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
VirtualName (string) --
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
Iops (integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
VolumeType (string) --
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
KmsKeyId (string) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
OutpostArn (string) --
The ARN of the Outpost on which the snapshot is stored.
Encrypted (boolean) --
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
NoDevice (string) --
To omit the device from the block device mapping, specify an empty string.
ImageId (string) --
The ID of the AMI.
LaunchPermissions (list) --
The launch permissions.
(dict) --
Describes a launch permission.
Group (string) --
The name of the group.
UserId (string) --
The AWS account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
ProductCodes (list) --
The product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
Description (dict) --
A description for the AMI.
Value (string) --
The attribute value. The value is case-sensitive.
KernelId (dict) --
The kernel ID.
Value (string) --
The attribute value. The value is case-sensitive.
RamdiskId (dict) --
The RAM disk ID.
Value (string) --
The attribute value. The value is case-sensitive.
SriovNetSupport (dict) --
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Value (string) --
The attribute value. The value is case-sensitive.
BootMode (dict) --
Describes a value for a resource attribute that is a String.
Value (string) --
The attribute value. The value is case-sensitive.
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_images() to update the attributes of the Image resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
image.load()
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description , LaunchPermission , or ProductCode .
AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
See also: AWS API Documentation
Request Syntax
response = image.modify_attribute(
Attribute='string',
Description={
'Value': 'string'
},
LaunchPermission={
'Add': [
{
'Group': 'all',
'UserId': 'string'
},
],
'Remove': [
{
'Group': 'all',
'UserId': 'string'
},
]
},
OperationType='add'|'remove',
ProductCodes=[
'string',
],
UserGroups=[
'string',
],
UserIds=[
'string',
],
Value='string',
DryRun=True|False
)
A new description for the AMI.
The attribute value. The value is case-sensitive.
A new launch permission for the AMI.
The AWS account ID to add to the list of launch permissions for the AMI.
Describes a launch permission.
The name of the group.
The AWS account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
The AWS account ID to remove from the list of launch permissions for the AMI.
Describes a launch permission.
The name of the group.
The AWS account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
The DevPay product codes. After you add a product code to an AMI, it can't be removed.
The user groups. This parameter can be used only when the Attribute parameter is launchPermission .
The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission .
None
Calls EC2.Client.describe_images() to update the attributes of the Image resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
image.reload()
Resets an attribute of an AMI to its default value.
Note
The productCodes attribute can't be reset.
See also: AWS API Documentation
Request Syntax
response = image.reset_attribute(
Attribute='launchPermission',
DryRun=True|False
)
[REQUIRED]
The attribute to reset (currently you can only reset the launch permission attribute).
None
Waiters
Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide.
Waits until this Image is exists. This method calls EC2.Waiter.image_exists.wait() which polls. EC2.Client.describe_images() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
image.wait_until_exists(
ExecutableUsers=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Owners=[
'string',
],
IncludeDeprecated=True|False,
DryRun=True|False
)
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, self , amazon , and aws-marketplace . If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.
If true , all deprecated AMIs are included in the response. If false , no deprecated AMIs are included in the response. If no value is specified, the default value is false .
Note
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false ) that you set for this parameter.
None
A resource representing an Amazon Elastic Compute Cloud (EC2) Instance:
import boto3
ec2 = boto3.resource('ec2')
instance = ec2.Instance('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
These are the resource's available collections:
These are the resource's available waiters:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The Instance's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(integer) --
The AMI launch index, which can be used to find this instance in the launch group.
(string) --
The architecture of the image.
(list) --
Any block device mapping entries for the instance.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
AttachTime (datetime) --
The time stamp when the attachment initiated.
DeleteOnTermination (boolean) --
Indicates whether the volume is deleted on instance termination.
Status (string) --
The attachment state.
VolumeId (string) --
The ID of the EBS volume.
(string) --
The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide .
(string) --
The ID of the Capacity Reservation.
(dict) --
Information about the Capacity Reservation targeting option.
CapacityReservationPreference (string) --
Describes the instance's Capacity Reservation preferences. Possible preferences include:
CapacityReservationTarget (dict) --
Information about the targeted Capacity Reservation or Capacity Reservation group.
CapacityReservationId (string) --
The ID of the targeted Capacity Reservation.
CapacityReservationResourceGroupArn (string) --
The ARN of the targeted Capacity Reservation group.
(string) --
The idempotency token you provided when you launched the instance, if applicable.
(dict) --
The CPU options for the instance.
CoreCount (integer) --
The number of CPU cores for the instance.
ThreadsPerCore (integer) --
The number of threads per CPU core.
(boolean) --
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
(list) --
The Elastic GPU associated with the instance.
(dict) --
Describes the association between an instance and an Elastic Graphics accelerator.
ElasticGpuId (string) --
The ID of the Elastic Graphics accelerator.
ElasticGpuAssociationId (string) --
The ID of the association.
ElasticGpuAssociationState (string) --
The state of the association between the instance and the Elastic Graphics accelerator.
ElasticGpuAssociationTime (string) --
The time the Elastic Graphics accelerator was associated with the instance.
(list) --
The elastic inference accelerator associated with the instance.
(dict) --
Describes the association between an instance and an elastic inference accelerator.
ElasticInferenceAcceleratorArn (string) --
The Amazon Resource Name (ARN) of the elastic inference accelerator.
ElasticInferenceAcceleratorAssociationId (string) --
The ID of the association.
ElasticInferenceAcceleratorAssociationState (string) --
The state of the elastic inference accelerator.
ElasticInferenceAcceleratorAssociationTime (datetime) --
The time at which the elastic inference accelerator is associated with an instance.
(boolean) --
Specifies whether enhanced networking with ENA is enabled.
(dict) --
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
(dict) --
Indicates whether the instance is enabled for hibernation.
Configured (boolean) --
If this parameter is set to true , your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
(string) --
The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.
(dict) --
The IAM instance profile associated with the instance, if applicable.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Id (string) --
The ID of the instance profile.
(string) --
The ID of the AMI used to launch the instance.
(string) --
The ID of the instance.
(string) --
Indicates whether this is a Spot Instance or a Scheduled Instance.
(string) --
The instance type.
(string) --
The kernel associated with this instance, if applicable.
(string) --
The name of the key pair, if this instance was launched with an associated key pair.
(datetime) --
The time the instance was launched.
(list) --
The license configurations.
(dict) --
Describes a license configuration.
LicenseConfigurationArn (string) --
The Amazon Resource Name (ARN) of the license configuration.
(dict) --
The metadata options for the instance.
State (string) --
The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
HttpTokens (string) --
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
HttpPutResponseHopLimit (integer) --
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
HttpEndpoint (string) --
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
(dict) --
The monitoring for the instance.
State (string) --
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
(list) --
[EC2-VPC] The network interfaces for the instance.
(dict) --
Describes a network interface.
Association (dict) --
The association information for an Elastic IPv4 associated with the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
IpOwnerId (string) --
The ID of the owner of the Elastic IP address.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The public IP address or Elastic IP address bound to the network interface.
Attachment (dict) --
The network interface attachment.
AttachTime (datetime) --
The time stamp 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 index of the device on the instance for the network interface attachment.
Status (string) --
The attachment state.
NetworkCardIndex (integer) --
The index of the network card.
Description (string) --
The description.
Groups (list) --
One or more security groups.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
Ipv6Addresses (list) --
One or more IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OwnerId (string) --
The ID of the account that created the network interface.
PrivateDnsName (string) --
The private DNS name.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
PrivateIpAddresses (list) --
One or more private IPv4 addresses associated with the network interface.
(dict) --
Describes a private IPv4 address.
Association (dict) --
The association information for an Elastic IP address for the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
IpOwnerId (string) --
The ID of the owner of the Elastic IP address.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The public IP address or Elastic IP address bound to the network interface.
Primary (boolean) --
Indicates whether this IPv4 address is the primary private IP address of the network interface.
PrivateDnsName (string) --
The private IPv4 DNS name.
PrivateIpAddress (string) --
The private IPv4 address of the network interface.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
Status (string) --
The status of the network interface.
SubnetId (string) --
The ID of the subnet.
VpcId (string) --
The ID of the VPC.
InterfaceType (string) --
Describes the type of network interface.
Valid values: interface | efa | trunk
(string) --
The Amazon Resource Name (ARN) of the Outpost.
(dict) --
The location where the instance launched, if applicable.
AvailabilityZone (string) --
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
Affinity (string) --
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
GroupName (string) --
The name of the placement group the instance is in.
PartitionNumber (integer) --
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
HostId (string) --
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Tenancy (string) --
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
SpreadDomain (string) --
Reserved for future use.
This parameter is not supported by CreateFleet .
HostResourceGroupArn (string) --
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
(string) --
The value is Windows for Windows instances; otherwise blank.
(string) --
(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
(string) --
The private IPv4 address assigned to the instance.
(list) --
The product codes attached to this instance, if applicable.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
(string) --
(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.
(string) --
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
(string) --
The RAM disk associated with this instance, if applicable.
(string) --
The device name of the root device volume (for example, /dev/sda1 ).
(string) --
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
(list) --
The security groups for the instance.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
(boolean) --
Indicates whether source/destination checking is enabled.
(string) --
If the request is a Spot Instance request, the ID of the request.
(string) --
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
(dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
(dict) --
The reason for the most recent state transition.
Code (string) --
The reason code for the state change.
Message (string) --
The message for the state change.
(string) --
The reason for the most recent state transition. This might be an empty string.
(string) --
[EC2-VPC] The ID of the subnet in which the instance is running.
(list) --
Any tags assigned to the instance.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The virtualization type of the instance.
(string) --
[EC2-VPC] The ID of the VPC in which the instance is running.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(ClassicAddress) The related classic_address if set, otherwise None.
(Image) The related image if set, otherwise None.
(KeyPairInfo) The related key_pair if set, otherwise None.
(NetworkInterface) The related network_interfaces if set, otherwise None.
(PlacementGroup) The related placement_group if set, otherwise None.
(Subnet) The related subnet if set, otherwise None.
(Vpc) The related vpc if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
See also: AWS API Documentation
Request Syntax
response = instance.attach_classic_link_vpc(
DryRun=True|False,
Groups=[
'string',
],
VpcId='string'
)
[REQUIRED]
The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
[REQUIRED]
The ID of a ClassicLink-enabled VPC.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use .
If a volume has an AWS Marketplace product code:
For more information, see Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.attach_volume(
Device='string',
VolumeId='string',
DryRun=True|False
)
[REQUIRED]
The device name (for example, /dev/sdh or xvdh ).
[REQUIRED]
The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
dict
Response Syntax
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
}
Response Structure
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.console_output(
DryRun=True|False,
Latest=True|False
)
When enabled, retrieves the latest console output for the instance.
Default: disabled (false )
dict
Response Syntax
{
'InstanceId': 'string',
'Output': 'string',
'Timestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
InstanceId (string) --
The ID of the instance.
Output (string) --
The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.
Timestamp (datetime) --
The time at which the output was last updated.
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
image = instance.create_image(
BlockDeviceMappings=[
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
Description='string',
DryRun=True|False,
Name='string',
NoReboot=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
[REQUIRED]
A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
If you specify other values for ResourceType , the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags .
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.Image
Image resource
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = instance.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags . For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.delete_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix).
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
None
Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport
See also: AWS API Documentation
Request Syntax
response = instance.describe_attribute(
Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions',
DryRun=True|False,
)
[REQUIRED]
The instance attribute.
Note: The enaSupport attribute is not supported at this time.
dict
Response Syntax
{
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'Ebs': {
'AttachTime': datetime(2015, 1, 1),
'DeleteOnTermination': True|False,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'VolumeId': 'string'
}
},
],
'DisableApiTermination': {
'Value': True|False
},
'EnaSupport': {
'Value': True|False
},
'EnclaveOptions': {
'Enabled': True|False
},
'EbsOptimized': {
'Value': True|False
},
'InstanceId': 'string',
'InstanceInitiatedShutdownBehavior': {
'Value': 'string'
},
'InstanceType': {
'Value': 'string'
},
'KernelId': {
'Value': 'string'
},
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'RamdiskId': {
'Value': 'string'
},
'RootDeviceName': {
'Value': 'string'
},
'SourceDestCheck': {
'Value': True|False
},
'SriovNetSupport': {
'Value': 'string'
},
'UserData': {
'Value': 'string'
}
}
Response Structure
(dict) --
Describes an instance attribute.
Groups (list) --
The security groups associated with the instance.
(dict) --
Describes a security group.
GroupName (string) --
The name of the security group.
GroupId (string) --
The ID of the security group.
BlockDeviceMappings (list) --
The block device mapping of the instance.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name (for example, /dev/sdh or xvdh ).
Ebs (dict) --
Parameters used to automatically set up EBS volumes when the instance is launched.
AttachTime (datetime) --
The time stamp when the attachment initiated.
DeleteOnTermination (boolean) --
Indicates whether the volume is deleted on instance termination.
Status (string) --
The attachment state.
VolumeId (string) --
The ID of the EBS volume.
DisableApiTermination (dict) --
If the value is true , you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.
Value (boolean) --
The attribute value. The valid values are true or false .
EnaSupport (dict) --
Indicates whether enhanced networking with ENA is enabled.
Value (boolean) --
The attribute value. The valid values are true or false .
EnclaveOptions (dict) --
To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true ; otherwise, set it to false .
Enabled (boolean) --
If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
EbsOptimized (dict) --
Indicates whether the instance is optimized for Amazon EBS I/O.
Value (boolean) --
The attribute value. The valid values are true or false .
InstanceId (string) --
The ID of the instance.
InstanceInitiatedShutdownBehavior (dict) --
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Value (string) --
The attribute value. The value is case-sensitive.
InstanceType (dict) --
The instance type.
Value (string) --
The attribute value. The value is case-sensitive.
KernelId (dict) --
The kernel ID.
Value (string) --
The attribute value. The value is case-sensitive.
ProductCodes (list) --
A list of product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
RamdiskId (dict) --
The RAM disk ID.
Value (string) --
The attribute value. The value is case-sensitive.
RootDeviceName (dict) --
The device name of the root device volume (for example, /dev/sda1 ).
Value (string) --
The attribute value. The value is case-sensitive.
SourceDestCheck (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 .
SriovNetSupport (dict) --
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Value (string) --
The attribute value. The value is case-sensitive.
UserData (dict) --
The user data.
Value (string) --
The attribute value. The value is case-sensitive.
Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
See also: AWS API Documentation
Request Syntax
response = instance.detach_classic_link_vpc(
DryRun=True|False,
VpcId='string'
)
[REQUIRED]
The ID of the VPC to which the instance is linked.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detaching an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.detach_volume(
Device='string',
Force=True|False,
VolumeId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the volume.
dict
Response Syntax
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
}
Response Structure
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_instances() to update the attributes of the Instance resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
instance.load()
Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modifying attributes of a stopped instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.modify_attribute(
SourceDestCheck={
'Value': True|False
},
Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions',
BlockDeviceMappings=[
{
'DeviceName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'VolumeId': 'string'
},
'NoDevice': 'string',
'VirtualName': 'string'
},
],
DisableApiTermination={
'Value': True|False
},
DryRun=True|False,
EbsOptimized={
'Value': True|False
},
EnaSupport={
'Value': True|False
},
Groups=[
'string',
],
InstanceInitiatedShutdownBehavior={
'Value': 'string'
},
InstanceType={
'Value': 'string'
},
Kernel={
'Value': 'string'
},
Ramdisk={
'Value': 'string'
},
SriovNetSupport={
'Value': 'string'
},
UserData={
'Value': b'bytes'
},
Value='string'
)
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.
The attribute value. The valid values are true or false .
Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination , the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the block device mapping when launching an instance in the Amazon EC2 User Guide .
Describes a block device mapping entry.
The device name (for example, /dev/sdh or xvdh ).
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the volume is deleted on instance termination.
The ID of the EBS volume.
suppress the specified device included in the block device mapping.
The virtual device name.
If the value is true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.
The attribute value. The valid values are true or false .
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
The attribute value. The valid values are true or false .
Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
The attribute value. The valid values are true or false .
[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
The attribute value. The value is case-sensitive.
Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide . If the instance type is not valid, the error returned is InvalidInstanceAttributeValue .
The attribute value. The value is case-sensitive.
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB .
The attribute value. The value is case-sensitive.
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB .
The attribute value. The value is case-sensitive.
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
The attribute value. The value is case-sensitive.
Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
None
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
To disable detailed monitoring, see .
See also: AWS API Documentation
Request Syntax
response = instance.monitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide .
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
See also: AWS API Documentation
Request Syntax
response = instance.password_data(
DryRun=True|False
)
{
'InstanceId': 'string',
'PasswordData': 'string',
'Timestamp': datetime(2015, 1, 1)
}
Response Structure
The ID of the Windows instance.
The password of the instance. Returns an empty string if the password is not available.
The time the data was last updated.
Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.reboot(
DryRun=True|False
)
Calls EC2.Client.describe_instances() to update the attributes of the Instance resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
instance.reload()
Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus , use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus .
See also: AWS API Documentation
Request Syntax
response = instance.report_status(
Description='string',
DryRun=True|False,
EndTime=datetime(2015, 1, 1),
ReasonCodes=[
'instance-stuck-in-state'|'unresponsive'|'not-accepting-credentials'|'password-not-available'|'performance-network'|'performance-instance-store'|'performance-ebs-volume'|'performance-other'|'other',
],
StartTime=datetime(2015, 1, 1),
Status='ok'|'impaired'
)
[REQUIRED]
The reason codes that describe the health state of your instance.
[REQUIRED]
The status of all instances listed.
None
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk , the instance must be in a stopped state. To reset the sourceDestCheck , the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true , which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.reset_attribute(
Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions',
DryRun=True|False,
)
[REQUIRED]
The attribute to reset.
Warning
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck . To change an instance attribute, use ModifyInstanceAttribute .
None
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk , the instance must be in a stopped state. To reset the sourceDestCheck , the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true , which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.reset_kernel(
DryRun=True|False,
)
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk , the instance must be in a stopped state. To reset the sourceDestCheck , the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true , which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.reset_ramdisk(
DryRun=True|False,
)
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk , the instance must be in a stopped state. To reset the sourceDestCheck , the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true , which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.reset_source_dest_check(
DryRun=True|False,
)
Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.start(
AdditionalInfo='string',
DryRun=True|False
)
dict
Response Syntax
{
'StartingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StartingInstances (list) --
Information about the started instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon EC2 User Guide .
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide .
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.stop(
Hibernate=True|False,
DryRun=True|False,
Force=True|False
)
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
Default: false
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
dict
Response Syntax
{
'StoppingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StoppingInstances (list) --
Information about the stopped instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
For example, say you have the following instances:
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.terminate(
DryRun=True|False
)
{
'TerminatingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
Information about the terminated instances.
Describes an instance state change.
The current state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
The ID of the instance.
The previous state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = instance.unmonitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
A collection of Volume resources.A Volume Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Volume resources in the collection.
See also: AWS API Documentation
Request Syntax
volume_iterator = instance.volumes.all()
Creates an iterable of all Volume resources in the collection filtered by kwargs passed to method.A Volume collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
volume_iterator = instance.volumes.filter(
VolumeIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The volume IDs.
list(ec2.Volume)
A list of Volume resources
Creates an iterable up to a specified amount of Volume resources in the collection.
See also: AWS API Documentation
Request Syntax
volume_iterator = instance.volumes.limit(
count=123
)
Creates an iterable of all Volume resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
volume_iterator = instance.volumes.page_size(
count=123
)
A collection of VpcAddress resources.A VpcAddress Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all VpcAddress resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_address_iterator = instance.vpc_addresses.all()
Creates an iterable of all VpcAddress resources in the collection filtered by kwargs passed to method.A VpcAddress collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
vpc_address_iterator = instance.vpc_addresses.filter(
PublicIps=[
'string',
],
AllocationIds=[
'string',
],
DryRun=True|False
)
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
[EC2-VPC] Information about the allocation IDs.
list(ec2.VpcAddress)
A list of VpcAddress resources
Creates an iterable up to a specified amount of VpcAddress resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_address_iterator = instance.vpc_addresses.limit(
count=123
)
Creates an iterable of all VpcAddress resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
vpc_address_iterator = instance.vpc_addresses.page_size(
count=123
)
Waiters
Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide.
Waits until this Instance is exists. This method calls EC2.Waiter.instance_exists.wait() which polls. EC2.Client.describe_instances() every 5 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
instance.wait_until_exists(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
None
Waits until this Instance is running. This method calls EC2.Waiter.instance_running.wait() which polls. EC2.Client.describe_instances() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
instance.wait_until_running(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
None
Waits until this Instance is stopped. This method calls EC2.Waiter.instance_stopped.wait() which polls. EC2.Client.describe_instances() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
instance.wait_until_stopped(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
None
Waits until this Instance is terminated. This method calls EC2.Waiter.instance_terminated.wait() which polls. EC2.Client.describe_instances() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
instance.wait_until_terminated(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
None
A resource representing an Amazon Elastic Compute Cloud (EC2) InternetGateway:
import boto3
ec2 = boto3.resource('ec2')
internet_gateway = ec2.InternetGateway('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The InternetGateway's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(list) --
Any VPCs attached to the internet gateway.
(dict) --
Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
State (string) --
The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
VpcId (string) --
The ID of the VPC.
(string) --
The ID of the internet gateway.
(string) --
The ID of the AWS account that owns the internet gateway.
(list) --
Any tags assigned to the internet gateway.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = internet_gateway.attach_to_vpc(
DryRun=True|False,
VpcId='string'
)
[REQUIRED]
The ID of the VPC.
None
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = internet_gateway.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
See also: AWS API Documentation
Request Syntax
response = internet_gateway.delete(
DryRun=True|False,
)
Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.
See also: AWS API Documentation
Request Syntax
response = internet_gateway.detach_from_vpc(
DryRun=True|False,
VpcId='string'
)
[REQUIRED]
The ID of the VPC.
None
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_internet_gateways() to update the attributes of the InternetGateway resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
internet_gateway.load()
Calls EC2.Client.describe_internet_gateways() to update the attributes of the InternetGateway resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
internet_gateway.reload()
A resource representing an Amazon Elastic Compute Cloud (EC2) KeyPair:
import boto3
ec2 = boto3.resource('ec2')
key_pair = ec2.KeyPair('name')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The KeyPair's name identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The SHA-1 digest of the DER encoded private key.
(string) --
An unencrypted PEM encoded RSA private key.
(string) --
The name of the key pair.
(string) --
The ID of the key pair.
(list) --
Any tags applied to the key pair.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Deletes the specified key pair, by removing the public key from Amazon EC2.
See also: AWS API Documentation
Request Syntax
response = key_pair.delete(
KeyPairId='string',
DryRun=True|False
)
None
Returns a list of all the available sub-resources for this Resource.
A resource representing an Amazon Elastic Compute Cloud (EC2) KeyPairInfo:
import boto3
ec2 = boto3.resource('ec2')
key_pair_info = ec2.KeyPairInfo('name')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The KeyPairInfo's name identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide Amazon Web Services the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
(string) --
The name of the key pair.
(string) --
The ID of the key pair.
(list) --
Any tags applied to the key pair.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Deletes the specified key pair, by removing the public key from Amazon EC2.
See also: AWS API Documentation
Request Syntax
response = key_pair_info.delete(
KeyPairId='string',
DryRun=True|False
)
None
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_key_pairs() to update the attributes of the KeyPairInfo resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
key_pair_info.load()
Calls EC2.Client.describe_key_pairs() to update the attributes of the KeyPairInfo resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
key_pair_info.reload()
A resource representing an Amazon Elastic Compute Cloud (EC2) NetworkAcl:
import boto3
ec2 = boto3.resource('ec2')
network_acl = ec2.NetworkAcl('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The NetworkAcl's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(list) --
Any associations between the network ACL and one or more subnets
(dict) --
Describes an association between a network ACL and a subnet.
NetworkAclAssociationId (string) --
The ID of the association between a network ACL and a subnet.
NetworkAclId (string) --
The ID of the network ACL.
SubnetId (string) --
The ID of the subnet.
(list) --
One or more entries (rules) in the network ACL.
(dict) --
Describes an entry in a network ACL.
CidrBlock (string) --
The IPv4 network range to allow or deny, in CIDR notation.
Egress (boolean) --
Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
IcmpTypeCode (dict) --
ICMP protocol: The ICMP type and code.
Code (integer) --
The ICMP code. A value of -1 means all codes for the specified ICMP type.
Type (integer) --
The ICMP type. A value of -1 means all types.
Ipv6CidrBlock (string) --
The IPv6 network range to allow or deny, in CIDR notation.
PortRange (dict) --
TCP or UDP protocols: The range of ports the rule applies to.
From (integer) --
The first port in the range.
To (integer) --
The last port in the range.
Protocol (string) --
The protocol number. A value of "-1" means all protocols.
RuleAction (string) --
Indicates whether to allow or deny the traffic that matches the rule.
RuleNumber (integer) --
The rule number for the entry. ACL entries are processed in ascending order by rule number.
(boolean) --
Indicates whether this is the default network ACL for the VPC.
(string) --
The ID of the network ACL.
(string) --
The ID of the AWS account that owns the network ACL.
(list) --
Any tags assigned to the network ACL.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The ID of the VPC for the network ACL.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(Vpc) The related vpc if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = network_acl.create_entry(
CidrBlock='string',
DryRun=True|False,
Egress=True|False,
IcmpTypeCode={
'Code': 123,
'Type': 123
},
Ipv6CidrBlock='string',
PortRange={
'From': 123,
'To': 123
},
Protocol='string',
RuleAction='allow'|'deny',
RuleNumber=123
)
[REQUIRED]
Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
The ICMP code. A value of -1 means all codes for the specified ICMP type.
The ICMP type. A value of -1 means all types.
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
The first port in the range.
The last port in the range.
[REQUIRED]
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
[REQUIRED]
Indicates whether to allow or deny the traffic that matches the rule.
[REQUIRED]
The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
None
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = network_acl.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
See also: AWS API Documentation
Request Syntax
response = network_acl.delete(
DryRun=True|False,
)
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
See also: AWS API Documentation
Request Syntax
response = network_acl.delete_entry(
DryRun=True|False,
Egress=True|False,
RuleNumber=123
)
[REQUIRED]
Indicates whether the rule is an egress rule.
[REQUIRED]
The rule number of the entry to delete.
None
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_network_acls() to update the attributes of the NetworkAcl resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
network_acl.load()
Calls EC2.Client.describe_network_acls() to update the attributes of the NetworkAcl resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
network_acl.reload()
Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
This is an idempotent operation.
See also: AWS API Documentation
Request Syntax
response = network_acl.replace_association(
AssociationId='string',
DryRun=True|False,
)
[REQUIRED]
The ID of the current association between the original network ACL and the subnet.
dict
Response Syntax
{
'NewAssociationId': 'string'
}
Response Structure
(dict) --
NewAssociationId (string) --
The ID of the new association.
Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = network_acl.replace_entry(
CidrBlock='string',
DryRun=True|False,
Egress=True|False,
IcmpTypeCode={
'Code': 123,
'Type': 123
},
Ipv6CidrBlock='string',
PortRange={
'From': 123,
'To': 123
},
Protocol='string',
RuleAction='allow'|'deny',
RuleNumber=123
)
[REQUIRED]
Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
The ICMP code. A value of -1 means all codes for the specified ICMP type.
The ICMP type. A value of -1 means all types.
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
The first port in the range.
The last port in the range.
[REQUIRED]
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
[REQUIRED]
Indicates whether to allow or deny the traffic that matches the rule.
[REQUIRED]
The rule number of the entry to replace.
None
A resource representing an Amazon Elastic Compute Cloud (EC2) NetworkInterface:
import boto3
ec2 = boto3.resource('ec2')
network_interface = ec2.NetworkInterface('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The NetworkInterface's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(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.
(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 account ID of the owner of the instance.
Status (string) --
The attachment state.
(string) --
The Availability Zone.
(string) --
A description.
(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.
(string) --
The type of network interface.
(list) --
The IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address associated with a network interface.
Ipv6Address (string) --
The IPv6 address.
(string) --
The MAC address.
(string) --
The ID of the network interface.
(string) --
The Amazon Resource Name (ARN) of the Outpost.
(string) --
The account ID of the owner of the network interface.
(string) --
The private DNS name.
(string) --
The IPv4 address of the network interface within the subnet.
(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.
(string) --
The alias or account ID of the principal or service that created the network interface.
(boolean) --
Indicates whether the network interface is being managed by Amazon Web Services.
(boolean) --
Indicates whether source/destination checking is enabled.
(string) --
The status of the network interface.
(string) --
The ID of the subnet.
(list) --
Any tags assigned to the network interface.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The ID of the VPC.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(NetworkInterfaceAssociation) The related association if set, otherwise None.
(Subnet) The related subnet if set, otherwise None.
(Vpc) The related vpc if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide . For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
See also: AWS API Documentation
Request Syntax
response = network_interface.assign_private_ip_addresses(
AllowReassignment=True|False,
PrivateIpAddresses=[
'string',
],
SecondaryPrivateIpAddressCount=123
)
One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
dict
Response Syntax
{
'NetworkInterfaceId': 'string',
'AssignedPrivateIpAddresses': [
{
'PrivateIpAddress': 'string'
},
]
}
Response Structure
(dict) --
NetworkInterfaceId (string) --
The ID of the network interface.
AssignedPrivateIpAddresses (list) --
The private IP addresses assigned to the network interface.
(dict) --
Describes the private IP addresses assigned to a network interface.
PrivateIpAddress (string) --
The private IP address assigned to the network interface.
Attaches a network interface to an instance.
See also: AWS API Documentation
Request Syntax
response = network_interface.attach(
DeviceIndex=123,
DryRun=True|False,
InstanceId='string',
NetworkCardIndex=123
)
[REQUIRED]
The index of the device for the network interface attachment.
[REQUIRED]
The ID of the instance.
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.
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = network_interface.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified network interface. You must detach the network interface before you can delete it.
See also: AWS API Documentation
Request Syntax
response = network_interface.delete(
DryRun=True|False,
)
Describes a network interface attribute. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = network_interface.describe_attribute(
Attribute='description'|'groupSet'|'sourceDestCheck'|'attachment',
DryRun=True|False,
)
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'
},
'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 account ID of the owner of the instance.
Status (string) --
The attachment state.
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 .
Detaches a network interface from an instance.
See also: AWS API Documentation
Request Syntax
response = network_interface.detach(
DryRun=True|False,
Force=True|False
)
Specifies whether to force a detachment.
Note
None
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_network_interfaces() to update the attributes of the NetworkInterface resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
network_interface.load()
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
response = network_interface.modify_attribute(
Attachment={
'AttachmentId': 'string',
'DeleteOnTermination': True|False
},
Description={
'Value': 'string'
},
DryRun=True|False,
Groups=[
'string',
],
SourceDestCheck={
'Value': True|False
}
)
Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
The ID of the network interface attachment.
Indicates whether the network interface is deleted when the instance is terminated.
A description for the network interface.
The attribute value. The value is case-sensitive.
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.
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.
The attribute value. The valid values are true or false .
None
Calls EC2.Client.describe_network_interfaces() to update the attributes of the NetworkInterface resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
network_interface.reload()
Resets a network interface attribute. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = network_interface.reset_attribute(
DryRun=True|False,
SourceDestCheck='string'
)
None
Unassigns one or more secondary private IP addresses from a network interface.
See also: AWS API Documentation
Request Syntax
response = network_interface.unassign_private_ip_addresses(
PrivateIpAddresses=[
'string',
]
)
[REQUIRED]
The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
A resource representing an Amazon Elastic Compute Cloud (EC2) NetworkInterfaceAssociation:
import boto3
ec2 = boto3.resource('ec2')
network_interface_association = ec2.NetworkInterfaceAssociation('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The NetworkInterfaceAssociation's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The carrier IP address associated with the network interface.
(string) --
The ID of the owner of the Elastic IP address.
(string) --
The public DNS name.
(string) --
The public IP address or Elastic IP address bound to the network interface.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(VpcAddress) The related address if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
See also: AWS API Documentation
Request Syntax
response = network_interface_association.delete(
PublicIp='string',
DryRun=True|False
)
None
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_network_interfaces() to update the attributes of the NetworkInterfaceAssociation resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
network_interface_association.load()
Calls EC2.Client.describe_network_interfaces() to update the attributes of the NetworkInterfaceAssociation resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
network_interface_association.reload()
A resource representing an Amazon Elastic Compute Cloud (EC2) PlacementGroup:
import boto3
ec2 = boto3.resource('ec2')
placement_group = ec2.PlacementGroup('name')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
These are the resource's available collections:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The PlacementGroup's name identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The ID of the placement group.
(string) --
The name of the placement group.
(integer) --
The number of partitions. Valid only if strategy is set to partition .
(string) --
The state of the placement group.
(string) --
The placement strategy.
(list) --
Any tags applied to the placement group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = placement_group.delete(
DryRun=True|False,
)
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_placement_groups() to update the attributes of the PlacementGroup resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
placement_group.load()
Calls EC2.Client.describe_placement_groups() to update the attributes of the PlacementGroup resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
placement_group.reload()
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
A collection of Instance resources.A Instance Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Instance resources in the collection.
See also: AWS API Documentation
Request Syntax
instance_iterator = placement_group.instances.all()
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = placement_group.instances.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
None
Creates an iterable of all Instance resources in the collection filtered by kwargs passed to method.A Instance collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
instance_iterator = placement_group.instances.filter(
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The instance IDs.
Default: Describes all your instances.
list(ec2.Instance)
A list of Instance resources
Creates an iterable up to a specified amount of Instance resources in the collection.
See also: AWS API Documentation
Request Syntax
instance_iterator = placement_group.instances.limit(
count=123
)
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
To disable detailed monitoring, see .
See also: AWS API Documentation
Request Syntax
response = placement_group.instances.monitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Creates an iterable of all Instance resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
instance_iterator = placement_group.instances.page_size(
count=123
)
Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = placement_group.instances.reboot(
DryRun=True|False
)
Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = placement_group.instances.start(
AdditionalInfo='string',
DryRun=True|False
)
dict
Response Syntax
{
'StartingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StartingInstances (list) --
Information about the started instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon EC2 User Guide .
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide .
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = placement_group.instances.stop(
Hibernate=True|False,
DryRun=True|False,
Force=True|False
)
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
Default: false
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
dict
Response Syntax
{
'StoppingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StoppingInstances (list) --
Information about the stopped instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
For example, say you have the following instances:
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = placement_group.instances.terminate(
DryRun=True|False
)
{
'TerminatingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
Information about the terminated instances.
Describes an instance state change.
The current state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
The ID of the instance.
The previous state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = placement_group.instances.unmonitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
A resource representing an Amazon Elastic Compute Cloud (EC2) Route:
import boto3
ec2 = boto3.resource('ec2')
route = ec2.Route('route_table_id','destination_cidr_block')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
These are the resource's available sub-resources:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The Route's route_table_id identifier. This must be set.
(string) The Route's destination_cidr_block identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The ID of the carrier gateway.
(string) --
The IPv6 CIDR block used for the destination match.
(string) --
The prefix of the AWS service.
(string) --
The ID of the egress-only internet gateway.
(string) --
The ID of a gateway attached to your VPC.
(string) --
The ID of a NAT instance in your VPC.
(string) --
The AWS account ID of the owner of the instance.
(string) --
The ID of the local gateway.
(string) --
The ID of a NAT gateway.
(string) --
The ID of the network interface.
(string) --
Describes how the route was created.
(string) --
The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
(string) --
The ID of a transit gateway.
(string) --
The ID of a VPC peering connection.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Deletes the specified route from the specified route table.
See also: AWS API Documentation
Request Syntax
response = route.delete(
DestinationIpv6CidrBlock='string',
DestinationPrefixListId='string',
DryRun=True|False,
)
None
Returns a list of all the available sub-resources for this Resource.
Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = route.replace(
DestinationIpv6CidrBlock='string',
DestinationPrefixListId='string',
DryRun=True|False,
VpcEndpointId='string',
EgressOnlyInternetGatewayId='string',
GatewayId='string',
InstanceId='string',
LocalTarget=True|False,
NatGatewayId='string',
TransitGatewayId='string',
LocalGatewayId='string',
CarrierGatewayId='string',
NetworkInterfaceId='string',
VpcPeeringConnectionId='string'
)
None
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Creates a RouteTable resource.:
route_table = route.RouteTable()
A resource representing an Amazon Elastic Compute Cloud (EC2) RouteTable:
import boto3
ec2 = boto3.resource('ec2')
route_table = ec2.RouteTable('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The RouteTable's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(list) --
The associations between the route table and one or more subnets or a gateway.
(dict) --
Describes an association between a route table and a subnet or gateway.
Main (boolean) --
Indicates whether this is the main route table.
RouteTableAssociationId (string) --
The ID of the association.
RouteTableId (string) --
The ID of the route table.
SubnetId (string) --
The ID of the subnet. A subnet ID is not returned for an implicit association.
GatewayId (string) --
The ID of the internet gateway or virtual private gateway.
AssociationState (dict) --
The state of the association.
State (string) --
The state of the association.
StatusMessage (string) --
The status message, if applicable.
(string) --
The ID of the AWS account that owns the route table.
(list) --
Any virtual private gateway (VGW) propagating routes.
(dict) --
Describes a virtual private gateway propagating route.
GatewayId (string) --
The ID of the virtual private gateway.
(string) --
The ID of the route table.
(list) --
The routes in the route table.
(dict) --
Describes a route in a route table.
DestinationCidrBlock (string) --
The IPv4 CIDR block used for the destination match.
DestinationIpv6CidrBlock (string) --
The IPv6 CIDR block used for the destination match.
DestinationPrefixListId (string) --
The prefix of the AWS service.
EgressOnlyInternetGatewayId (string) --
The ID of the egress-only internet gateway.
GatewayId (string) --
The ID of a gateway attached to your VPC.
InstanceId (string) --
The ID of a NAT instance in your VPC.
InstanceOwnerId (string) --
The AWS account ID of the owner of the instance.
NatGatewayId (string) --
The ID of a NAT gateway.
TransitGatewayId (string) --
The ID of a transit gateway.
LocalGatewayId (string) --
The ID of the local gateway.
CarrierGatewayId (string) --
The ID of the carrier gateway.
NetworkInterfaceId (string) --
The ID of the network interface.
Origin (string) --
Describes how the route was created.
State (string) --
The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
VpcPeeringConnectionId (string) --
The ID of a VPC peering connection.
(list) --
Any tags assigned to the route table.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The ID of the VPC.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(RouteTableAssociation) The related associations if set, otherwise None.
(Route) The related routes if set, otherwise None.
(Vpc) The related vpc if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
route_table_association = route_table.associate_with_subnet(
DryRun=True|False,
SubnetId='string',
GatewayId='string'
)
ec2.RouteTableAssociation
RouteTableAssociation resource
Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3 , and the route table includes the following two IPv4 routes:
Both routes apply to the traffic destined for 192.0.2.3 . However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
route = route_table.create_route(
DestinationCidrBlock='string',
DestinationIpv6CidrBlock='string',
DestinationPrefixListId='string',
DryRun=True|False,
VpcEndpointId='string',
EgressOnlyInternetGatewayId='string',
GatewayId='string',
InstanceId='string',
NatGatewayId='string',
TransitGatewayId='string',
LocalGatewayId='string',
CarrierGatewayId='string',
NetworkInterfaceId='string',
VpcPeeringConnectionId='string'
)
The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
ec2.Route
Route resource
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = route_table.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
See also: AWS API Documentation
Request Syntax
response = route_table.delete(
DryRun=True|False,
)
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_route_tables() to update the attributes of the RouteTable resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
route_table.load()
Calls EC2.Client.describe_route_tables() to update the attributes of the RouteTable resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
route_table.reload()
A resource representing an Amazon Elastic Compute Cloud (EC2) RouteTableAssociation:
import boto3
ec2 = boto3.resource('ec2')
route_table_association = ec2.RouteTableAssociation('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The RouteTableAssociation's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(dict) --
The state of the association.
State (string) --
The state of the association.
StatusMessage (string) --
The status message, if applicable.
(string) --
The ID of the internet gateway or virtual private gateway.
(boolean) --
Indicates whether this is the main route table.
(string) --
The ID of the association.
(string) --
The ID of the route table.
(string) --
The ID of the subnet. A subnet ID is not returned for an implicit association.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(RouteTable) The related route_table if set, otherwise None.
(Subnet) The related subnet if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = route_table_association.delete(
DryRun=True|False
)
Returns a list of all the available sub-resources for this Resource.
Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide .
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.
See also: AWS API Documentation
Request Syntax
route_table_association = route_table_association.replace_subnet(
DryRun=True|False,
RouteTableId='string'
)
[REQUIRED]
The ID of the new route table to associate with the subnet.
ec2.RouteTableAssociation
RouteTableAssociation resource
A resource representing an Amazon Elastic Compute Cloud (EC2) SecurityGroup:
import boto3
ec2 = boto3.resource('ec2')
security_group = ec2.SecurityGroup('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The SecurityGroup's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
A description of the security group.
(string) --
The ID of the security group.
(string) --
The name of the security group.
(list) --
The inbound rules associated with the security group.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
(list) --
[VPC only] The outbound rules associated with the security group.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
(string) --
The Amazon Web Services account ID of the owner of the security group.
(list) --
Any tags assigned to the security group.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
[VPC only] The ID of the VPC for the security group.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas .
See also: AWS API Documentation
Request Syntax
response = security_group.authorize_egress(
DryRun=True|False,
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
CidrIp='string',
FromPort=123,
IpProtocol='string',
ToPort=123,
SourceSecurityGroupName='string',
SourceSecurityGroupOwnerId='string'
)
The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The tags applied to the security group rule.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Return': True|False,
'SecurityGroupRules': [
{
'SecurityGroupRuleId': 'string',
'GroupId': 'string',
'GroupOwnerId': 'string',
'IsEgress': True|False,
'IpProtocol': 'string',
'FromPort': 123,
'ToPort': 123,
'CidrIpv4': 'string',
'CidrIpv6': 'string',
'PrefixListId': 'string',
'ReferencedGroupInfo': {
'GroupId': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
SecurityGroupRules (list) --
Information about the outbound (egress) security group rules that were added.
(dict) --
Describes a security group rule.
SecurityGroupRuleId (string) --
The ID of the security group rule.
GroupId (string) --
The ID of the security group.
GroupOwnerId (string) --
The ID of the account that owns the security group.
IsEgress (boolean) --
Indicates whether the security group rule is an outbound rule.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
Use -1 to specify all protocols.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
CidrIpv4 (string) --
The IPv4 CIDR range.
CidrIpv6 (string) --
The IPv6 CIDR range.
PrefixListId (string) --
The ID of the prefix list.
ReferencedGroupInfo (dict) --
Describes the security group that is referenced in the rule.
GroupId (string) --
The ID of the security group.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The account ID.
VpcId (string) --
The ID of the VPC.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Description (string) --
The security group rule description.
Tags (list) --
The tags applied to the security group rule.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group quotas, see Amazon VPC quotas .
See also: AWS API Documentation
Request Syntax
response = security_group.authorize_ingress(
CidrIp='string',
FromPort=123,
GroupName='string',
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
IpProtocol='string',
SourceSecurityGroupName='string',
SourceSecurityGroupOwnerId='string',
ToPort=123,
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
The sets of IP permissions.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The IP protocol name (tcp , udp , icmp ) or number (see Protocol Numbers ). To specify icmpv6 , use a set of IP permissions.
[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp , udp , or icmp , traffic on all ports is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
[VPC Only] The tags applied to the security group rule.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'Return': True|False,
'SecurityGroupRules': [
{
'SecurityGroupRuleId': 'string',
'GroupId': 'string',
'GroupOwnerId': 'string',
'IsEgress': True|False,
'IpProtocol': 'string',
'FromPort': 123,
'ToPort': 123,
'CidrIpv4': 'string',
'CidrIpv6': 'string',
'PrefixListId': 'string',
'ReferencedGroupInfo': {
'GroupId': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
SecurityGroupRules (list) --
Information about the inbound (ingress) security group rules that were added.
(dict) --
Describes a security group rule.
SecurityGroupRuleId (string) --
The ID of the security group rule.
GroupId (string) --
The ID of the security group.
GroupOwnerId (string) --
The ID of the account that owns the security group.
IsEgress (boolean) --
Indicates whether the security group rule is an outbound rule.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
Use -1 to specify all protocols.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
CidrIpv4 (string) --
The IPv4 CIDR range.
CidrIpv6 (string) --
The IPv6 CIDR range.
PrefixListId (string) --
The ID of the prefix list.
ReferencedGroupInfo (dict) --
Describes the security group that is referenced in the rule.
GroupId (string) --
The ID of the security group.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The account ID.
VpcId (string) --
The ID of the VPC.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection.
Description (string) --
The security group rule description.
Tags (list) --
The tags applied to the security group rule.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = security_group.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
See also: AWS API Documentation
Request Syntax
response = security_group.delete(
GroupName='string',
DryRun=True|False
)
None
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_security_groups() to update the attributes of the SecurityGroup resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
security_group.load()
Calls EC2.Client.describe_security_groups() to update the attributes of the SecurityGroup resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
security_group.reload()
[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[Default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
See also: AWS API Documentation
Request Syntax
response = security_group.revoke_egress(
DryRun=True|False,
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
SecurityGroupRuleIds=[
'string',
],
CidrIp='string',
FromPort=123,
IpProtocol='string',
ToPort=123,
SourceSecurityGroupName='string',
SourceSecurityGroupOwnerId='string'
)
The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The IDs of the security group rules.
dict
Response Syntax
{
'Return': True|False,
'UnknownIpPermissions': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
]
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
UnknownIpPermissions (list) --
The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
See also: AWS API Documentation
Request Syntax
response = security_group.revoke_ingress(
CidrIp='string',
FromPort=123,
GroupName='string',
IpPermissions=[
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
],
IpProtocol='string',
SourceSecurityGroupName='string',
SourceSecurityGroupOwnerId='string',
ToPort=123,
DryRun=True|False,
SecurityGroupRuleIds=[
'string',
]
)
The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
Describes a set of permissions for a security group rule.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 ranges.
Describes an IPv4 range.
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The IPv6 ranges.
[EC2-VPC only] Describes an IPv6 range.
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[VPC only] The prefix list IDs.
Describes a prefix list ID.
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the prefix.
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The security group and Amazon Web Services account ID pairs.
Describes a security group and Amazon Web Services account ID pair.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
The ID of the security group.
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
The status of a VPC peering connection, if applicable.
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
The ID of the VPC for the referenced security group, if applicable.
The ID of the VPC peering connection, if applicable.
The IDs of the security group rules.
dict
Response Syntax
{
'Return': True|False,
'UnknownIpPermissions': [
{
'FromPort': 123,
'IpProtocol': 'string',
'IpRanges': [
{
'CidrIp': 'string',
'Description': 'string'
},
],
'Ipv6Ranges': [
{
'CidrIpv6': 'string',
'Description': 'string'
},
],
'PrefixListIds': [
{
'Description': 'string',
'PrefixListId': 'string'
},
],
'ToPort': 123,
'UserIdGroupPairs': [
{
'Description': 'string',
'GroupId': 'string',
'GroupName': 'string',
'PeeringStatus': 'string',
'UserId': 'string',
'VpcId': 'string',
'VpcPeeringConnectionId': 'string'
},
]
},
]
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, returns an error.
UnknownIpPermissions (list) --
The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.
(dict) --
Describes a set of permissions for a security group rule.
FromPort (integer) --
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
IpProtocol (string) --
The IP protocol name (tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
IpRanges (list) --
The IPv4 ranges.
(dict) --
Describes an IPv4 range.
CidrIp (string) --
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description (string) --
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges (list) --
[VPC only] The IPv6 ranges.
(dict) --
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 (string) --
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description (string) --
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds (list) --
[VPC only] The prefix list IDs.
(dict) --
Describes a prefix list ID.
Description (string) --
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId (string) --
The ID of the prefix.
ToPort (integer) --
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs (list) --
The security group and Amazon Web Services account ID pairs.
(dict) --
Describes a security group and Amazon Web Services account ID pair.
Description (string) --
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus (string) --
The status of a VPC peering connection, if applicable.
UserId (string) --
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId (string) --
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId (string) --
The ID of the VPC peering connection, if applicable.
A resource representing an Amazon Elastic Compute Cloud (EC2) Snapshot:
import boto3
ec2 = boto3.resource('ec2')
snapshot = ec2.Snapshot('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
These are the resource's available waiters:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The Snapshot's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots .
(string) --
The description for the snapshot.
(boolean) --
Indicates whether the snapshot is encrypted.
(string) --
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
(string) --
The ARN of the AWS Outpost on which the snapshot is stored. For more information, see EBS Local Snapshot on Outposts in the Amazon Elastic Compute Cloud User Guide .
(string) --
The AWS owner alias, from an Amazon-maintained list (amazon ). This is not the user-configured AWS account alias set using the IAM console.
(string) --
The AWS account ID of the EBS snapshot owner.
(string) --
The progress of the snapshot, as a percentage.
(string) --
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
(datetime) --
The time stamp when the snapshot was initiated.
(string) --
The snapshot state.
(string) --
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots .
(list) --
Any tags assigned to the snapshot.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
(integer) --
The size of the volume, in GiB.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(Volume) The related volume if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId . Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide .
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = snapshot.copy(
Description='string',
DestinationOutpostArn='string',
Encrypted=True|False,
KmsKeyId='string',
SourceRegion='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an AWS Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying snapshots from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide .
The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com ). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true .
You can specify the CMK using any of the following:
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests .
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion , SourceSnapshotId , and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference . An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
[REQUIRED]
The ID of the Region that contains the snapshot to be copied.
The tags to apply to the new snapshot.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
dict
Response Syntax
{
'SnapshotId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
SnapshotId (string) --
The ID of the new snapshot.
Tags (list) --
Any tags applied to the new snapshot.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = snapshot.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Deleting an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = snapshot.delete(
DryRun=True|False
)
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = snapshot.describe_attribute(
Attribute='productCodes'|'createVolumePermission',
DryRun=True|False
)
[REQUIRED]
The snapshot attribute you would like to view.
dict
Response Syntax
{
'CreateVolumePermissions': [
{
'Group': 'all',
'UserId': 'string'
},
],
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'SnapshotId': 'string'
}
Response Structure
(dict) --
CreateVolumePermissions (list) --
The users and groups that have the permissions for creating volumes from the snapshot.
(dict) --
Describes the user or group to be added or removed from the list of create volume permissions for a volume.
Group (string) --
The group to be added or removed. The possible value is all .
UserId (string) --
The AWS account ID to be added or removed.
ProductCodes (list) --
The product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
SnapshotId (string) --
The ID of the EBS snapshot.
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_snapshots() to update the attributes of the Snapshot resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
snapshot.load()
Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = snapshot.modify_attribute(
Attribute='productCodes'|'createVolumePermission',
CreateVolumePermission={
'Add': [
{
'Group': 'all',
'UserId': 'string'
},
],
'Remove': [
{
'Group': 'all',
'UserId': 'string'
},
]
},
GroupNames=[
'string',
],
OperationType='add'|'remove',
UserIds=[
'string',
],
DryRun=True|False
)
A JSON representation of the snapshot attribute modification.
Adds the specified AWS account ID or group to the list.
Describes the user or group to be added or removed from the list of create volume permissions for a volume.
The group to be added or removed. The possible value is all .
The AWS account ID to be added or removed.
Removes the specified AWS account ID or group from the list.
Describes the user or group to be added or removed from the list of create volume permissions for a volume.
The group to be added or removed. The possible value is all .
The AWS account ID to be added or removed.
The group to modify for the snapshot.
The account ID to modify for the snapshot.
None
Calls EC2.Client.describe_snapshots() to update the attributes of the Snapshot resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
snapshot.reload()
Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = snapshot.reset_attribute(
Attribute='productCodes'|'createVolumePermission',
DryRun=True|False
)
[REQUIRED]
The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.
None
Waiters
Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide.
Waits until this Snapshot is completed. This method calls EC2.Waiter.snapshot_completed.wait() which polls. EC2.Client.describe_snapshots() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
snapshot.wait_until_completed(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
OwnerIds=[
'string',
],
RestorableByUserIds=[
'string',
],
DryRun=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self , and amazon .
The IDs of the AWS accounts that can create volumes from the snapshot.
None
A resource representing an Amazon Elastic Compute Cloud (EC2) Subnet:
import boto3
ec2 = boto3.resource('ec2')
subnet = ec2.Subnet('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
These are the resource's available collections:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The Subnet's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives an IPv6 address.
(string) --
The Availability Zone of the subnet.
(string) --
The AZ ID of the subnet.
(integer) --
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
(string) --
The IPv4 CIDR block assigned to the subnet.
(string) --
The customer-owned IPv4 address pool associated with the subnet.
(boolean) --
Indicates whether this is the default subnet for the Availability Zone.
(list) --
Information about the IPv6 CIDR blocks associated with the subnet.
(dict) --
Describes an IPv6 CIDR block associated with a subnet.
AssociationId (string) --
The association ID for the CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of a CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
(boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives a customer-owned IPv4 address.
(boolean) --
Indicates whether instances launched in this subnet receive a public IPv4 address.
(string) --
The Amazon Resource Name (ARN) of the Outpost.
(string) --
The ID of the AWS account that owns the subnet.
(string) --
The current state of the subnet.
(string) --
The Amazon Resource Name (ARN) of the subnet.
(string) --
The ID of the subnet.
(list) --
Any tags assigned to the subnet.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The ID of the VPC the subnet is in.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(Vpc) The related vpc if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
You can create a launch template , which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances , you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances . You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources .
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs .
For troubleshooting, see What to do if an instance immediately terminates , and Troubleshooting connecting to your instance .
See also: AWS API Documentation
Request Syntax
instance = subnet.create_instances(
BlockDeviceMappings=[
{
'DeviceName': 'string',
'VirtualName': 'string',
'Ebs': {
'DeleteOnTermination': True|False,
'Iops': 123,
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'KmsKeyId': 'string',
'Throughput': 123,
'OutpostArn': 'string',
'Encrypted': True|False
},
'NoDevice': 'string'
},
],
ImageId='string',
InstanceType='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'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'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'|'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'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'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'|'hi1.4xlarge'|'hs1.8xlarge'|'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.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'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'|'f1.2xlarge'|'f1.4xlarge'|'f1.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'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.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'|'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'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'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'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal',
Ipv6AddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string'
},
],
KernelId='string',
KeyName='string',
MaxCount=123,
MinCount=123,
Monitoring={
'Enabled': True|False
},
Placement={
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'PartitionNumber': 123,
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': 'string',
'HostResourceGroupArn': 'string'
},
RamdiskId='string',
SecurityGroupIds=[
'string',
],
SecurityGroups=[
'string',
],
UserData='string',
AdditionalInfo='string',
ClientToken='string',
DisableApiTermination=True|False,
DryRun=True|False,
EbsOptimized=True|False,
IamInstanceProfile={
'Arn': 'string',
'Name': 'string'
},
InstanceInitiatedShutdownBehavior='stop'|'terminate',
NetworkInterfaces=[
{
'AssociatePublicIpAddress': True|False,
'DeleteOnTermination': True|False,
'Description': 'string',
'DeviceIndex': 123,
'Groups': [
'string',
],
'Ipv6AddressCount': 123,
'Ipv6Addresses': [
{
'Ipv6Address': 'string'
},
],
'NetworkInterfaceId': 'string',
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
'SecondaryPrivateIpAddressCount': 123,
'SubnetId': 'string',
'AssociateCarrierIpAddress': True|False,
'InterfaceType': 'string',
'NetworkCardIndex': 123
},
],
PrivateIpAddress='string',
ElasticGpuSpecification=[
{
'Type': 'string'
},
],
ElasticInferenceAccelerators=[
{
'Type': 'string',
'Count': 123
},
],
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
LaunchTemplate={
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'Version': 'string'
},
InstanceMarketOptions={
'MarketType': 'spot',
'SpotOptions': {
'MaxPrice': 'string',
'SpotInstanceType': 'one-time'|'persistent',
'BlockDurationMinutes': 123,
'ValidUntil': datetime(2015, 1, 1),
'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
}
},
CreditSpecification={
'CpuCredits': 'string'
},
CpuOptions={
'CoreCount': 123,
'ThreadsPerCore': 123
},
CapacityReservationSpecification={
'CapacityReservationPreference': 'open'|'none',
'CapacityReservationTarget': {
'CapacityReservationId': 'string',
'CapacityReservationResourceGroupArn': 'string'
}
},
HibernationOptions={
'Configured': True|False
},
LicenseSpecifications=[
{
'LicenseConfigurationArn': 'string'
},
],
MetadataOptions={
'HttpTokens': 'optional'|'required',
'HttpPutResponseHopLimit': 123,
'HttpEndpoint': 'disabled'|'enabled'
},
EnclaveOptions={
'Enabled': True|False
}
)
The block device mapping entries.
Describes a block device mapping.
The device name (for example, /dev/sdh or xvdh ).
The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Parameters used to automatically set up EBS volumes when the instance is launched.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.
The ID of the snapshot.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
The ARN of the Outpost on which the snapshot is stored.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
This parameter is not returned by .
To omit the device from the block device mapping, specify an empty string.
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .
Default: m1.small
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
Describes an IPv6 address.
The IPv6 address.
The ID of the kernel.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .
Warning
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
[REQUIRED]
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount .
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
[REQUIRED]
The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
Specifies whether detailed monitoring is enabled for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
The placement for the instance.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet .
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The name of the placement group the instance is in.
The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .
This parameter is not supported by CreateFleet .
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet .
Reserved for future use.
This parameter is not supported by CreateFleet .
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .
This parameter is not supported by CreateFleet .
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .
The IDs of the security groups. You can create a security group using CreateSecurityGroup .
If you specify a network interface, you must specify any security groups as part of the network interface.
[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
The user data to make available to the instance. For more information, see Running commands on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency .
Constraints: Maximum 64 ASCII characters
This field is autopopulated if not provided.
If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.
Default: false
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The name or Amazon Resource Name (ARN) of an IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
The name of the instance profile.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
Describes a network interface.
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
The description of the network interface. Applies only if creating a network interface when launching an instance.
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
Describes an IPv6 address.
The IPv6 address.
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .
Valid values: interface | efa
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.
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide .
A specification for an Elastic Graphics accelerator.
The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see Elastic Graphics Basics , specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances .
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Describes an elastic inference accelerator.
The type of elastic inference accelerator. The possible values are eia1.medium , eia1.large , eia1.xlarge , eia2.medium , eia2.large , and eia2.xlarge .
The number of elastic inference accelerators to attach to the instance.
Default: 1
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
The ID of the launch template.
The name of the launch template.
The version number of the launch template.
Default: The default version for the launch template.
The market (purchasing) option for the instances.
For RunInstances , persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop .
The market type.
The options for Spot Instances.
The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price.
The Spot Instance request type. For RunInstances , persistent Spot Instance requests are only supported when the instance interruption behavior is either hibernate or stop .
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
You can't specify an Availability Zone group or a launch group if you specify a duration.
New accounts or accounts with no previous billing history with Amazon Web Services are not eligible for Spot Instances with a defined duration (also known as Spot blocks).
The end date of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). Supported only for persistent requests.
The behavior when a Spot Instance is interrupted. The default is terminate .
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited . To change this attribute after launch, use ModifyInstanceCreditSpecification . For more information, see Burstable performance instances in the Amazon EC2 User Guide .
Default: standard (T2 instances) or unlimited (T3/T3a instances)
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .
The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon EC2 User Guide .
The number of CPU cores for the instance.
The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1 . Otherwise, specify the default value of 2 .
Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
Information about the target Capacity Reservation or Capacity Reservation group.
The ID of the Capacity Reservation in which to run the instance.
The ARN of the Capacity Reservation resource group in which to run the instance.
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
If you set this parameter to true , your instance is enabled for hibernation.
Default: false
The license configurations.
Describes a license configuration.
The Amazon Resource Name (ARN) of the license configuration.
The metadata options for the instance. For more information, see Instance metadata and user data .
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .
If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .
Note
If you specify a value of disabled , you will not be able to access your instance metadata.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide .
You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true .
list(ec2.Instance)
A list of Instance resources
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
network_interface = subnet.create_network_interface(
Description='string',
DryRun=True|False,
Groups=[
'string',
],
Ipv6AddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string'
},
],
PrivateIpAddress='string',
PrivateIpAddresses=[
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
SecondaryPrivateIpAddressCount=123,
InterfaceType='efa'|'branch'|'trunk',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string'
)
The IDs of one or more security groups.
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
Describes an IPv6 address.
The IPv6 address.
One or more private IPv4 addresses.
Describes a secondary private IPv4 address for a network interface.
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
The private IPv4 addresses.
The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .
The tags to apply to the new network interface.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
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.
ec2.NetworkInterface
NetworkInterface resource
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = subnet.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
See also: AWS API Documentation
Request Syntax
response = subnet.delete(
DryRun=True|False
)
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_subnets() to update the attributes of the Subnet resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
subnet.load()
Calls EC2.Client.describe_subnets() to update the attributes of the Subnet resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
subnet.reload()
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
A collection of Instance resources.A Instance Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Instance resources in the collection.
See also: AWS API Documentation
Request Syntax
instance_iterator = subnet.instances.all()
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = subnet.instances.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
None
Creates an iterable of all Instance resources in the collection filtered by kwargs passed to method.A Instance collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
instance_iterator = subnet.instances.filter(
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The instance IDs.
Default: Describes all your instances.
list(ec2.Instance)
A list of Instance resources
Creates an iterable up to a specified amount of Instance resources in the collection.
See also: AWS API Documentation
Request Syntax
instance_iterator = subnet.instances.limit(
count=123
)
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
To disable detailed monitoring, see .
See also: AWS API Documentation
Request Syntax
response = subnet.instances.monitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Creates an iterable of all Instance resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
instance_iterator = subnet.instances.page_size(
count=123
)
Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = subnet.instances.reboot(
DryRun=True|False
)
Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = subnet.instances.start(
AdditionalInfo='string',
DryRun=True|False
)
dict
Response Syntax
{
'StartingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StartingInstances (list) --
Information about the started instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon EC2 User Guide .
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide .
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = subnet.instances.stop(
Hibernate=True|False,
DryRun=True|False,
Force=True|False
)
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
Default: false
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
dict
Response Syntax
{
'StoppingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StoppingInstances (list) --
Information about the stopped instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
For example, say you have the following instances:
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = subnet.instances.terminate(
DryRun=True|False
)
{
'TerminatingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
Information about the terminated instances.
Describes an instance state change.
The current state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
The ID of the instance.
The previous state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = subnet.instances.unmonitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
A collection of NetworkInterface resources.A NetworkInterface Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all NetworkInterface resources in the collection.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = subnet.network_interfaces.all()
Creates an iterable of all NetworkInterface resources in the collection filtered by kwargs passed to method.A NetworkInterface collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = subnet.network_interfaces.filter(
DryRun=True|False,
NetworkInterfaceIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more network interface IDs.
Default: Describes all your network interfaces.
list(ec2.NetworkInterface)
A list of NetworkInterface resources
Creates an iterable up to a specified amount of NetworkInterface resources in the collection.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = subnet.network_interfaces.limit(
count=123
)
Creates an iterable of all NetworkInterface resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = subnet.network_interfaces.page_size(
count=123
)
A resource representing an Amazon Elastic Compute Cloud (EC2) Tag:
import boto3
ec2 = boto3.resource('ec2')
tag = ec2.Tag('resource_id','key','value')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The Tag's resource_id identifier. This must be set.
(string) The Tag's key identifier. This must be set.
(string) The Tag's value identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The resource type.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags . For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = tag.delete(
DryRun=True|False,
)
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_tags() to update the attributes of the Tag resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
tag.load()
Calls EC2.Client.describe_tags() to update the attributes of the Tag resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
tag.reload()
A resource representing an Amazon Elastic Compute Cloud (EC2) Volume:
import boto3
ec2 = boto3.resource('ec2')
volume = ec2.Volume('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
These are the resource's available collections:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The Volume's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(list) --
Information about the volume attachments.
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
(string) --
The Availability Zone for the volume.
(datetime) --
The time stamp when volume creation was initiated.
(boolean) --
Indicates whether the volume is encrypted.
(boolean) --
Indicates whether the volume was created using fast snapshot restore.
(integer) --
The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
(string) --
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
(boolean) --
Indicates whether Amazon EBS Multi-Attach is enabled.
(string) --
The Amazon Resource Name (ARN) of the Outpost.
(integer) --
The size of the volume, in GiBs.
(string) --
The snapshot from which the volume was created, if applicable.
(string) --
The volume state.
(list) --
Any tags assigned to the volume.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(integer) --
The throughput that the volume supports, in MiB/s.
(string) --
The ID of the volume.
(string) --
The volume type.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use .
If a volume has an AWS Marketplace product code:
For more information, see Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = volume.attach_to_instance(
Device='string',
InstanceId='string',
DryRun=True|False
)
[REQUIRED]
The device name (for example, /dev/sdh or xvdh ).
[REQUIRED]
The ID of the instance.
dict
Response Syntax
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
}
Response Structure
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending .
To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide .
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
snapshot = volume.create_snapshot(
Description='string',
OutpostArn='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.
For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide .
The tags to apply to the snapshot during creation.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.Snapshot
Snapshot resource
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = volume.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Deleting an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = volume.delete(
DryRun=True|False
)
Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = volume.describe_attribute(
Attribute='autoEnableIO'|'productCodes',
DryRun=True|False
)
[REQUIRED]
The attribute of the volume. This parameter is required.
dict
Response Syntax
{
'AutoEnableIO': {
'Value': True|False
},
'ProductCodes': [
{
'ProductCodeId': 'string',
'ProductCodeType': 'devpay'|'marketplace'
},
],
'VolumeId': 'string'
}
Response Structure
(dict) --
AutoEnableIO (dict) --
The state of autoEnableIO attribute.
Value (boolean) --
The attribute value. The valid values are true or false .
ProductCodes (list) --
A list of product codes.
(dict) --
Describes a product code.
ProductCodeId (string) --
The product code.
ProductCodeType (string) --
The type of product code.
VolumeId (string) --
The ID of the volume.
Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status : Reflects the current status of the volume. The possible values are ok , impaired , warning , or insufficient-data . If all checks pass, the overall status of the volume is ok . If the check fails, the overall status is impaired . If the status is insufficient-data , then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the status of your volumes in the Amazon Elastic Compute Cloud User Guide .
Events : Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency . This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions : Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency , then the action shows enable-volume-io . This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
See also: AWS API Documentation
Request Syntax
response = volume.describe_status(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
The filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'NextToken': 'string',
'VolumeStatuses': [
{
'Actions': [
{
'Code': 'string',
'Description': 'string',
'EventId': 'string',
'EventType': 'string'
},
],
'AvailabilityZone': 'string',
'OutpostArn': 'string',
'Events': [
{
'Description': 'string',
'EventId': 'string',
'EventType': 'string',
'NotAfter': datetime(2015, 1, 1),
'NotBefore': datetime(2015, 1, 1),
'InstanceId': 'string'
},
],
'VolumeId': 'string',
'VolumeStatus': {
'Details': [
{
'Name': 'io-enabled'|'io-performance',
'Status': 'string'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'
},
'AttachmentStatuses': [
{
'IoPerformance': 'string',
'InstanceId': 'string'
},
]
},
]
}
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.
VolumeStatuses (list) --
Information about the status of the volumes.
(dict) --
Describes the volume status.
Actions (list) --
The details of the operation.
(dict) --
Describes a volume status operation code.
Code (string) --
The code identifying the operation, for example, enable-volume-io .
Description (string) --
A description of the operation.
EventId (string) --
The ID of the event associated with this operation.
EventType (string) --
The event type associated with this operation.
AvailabilityZone (string) --
The Availability Zone of the volume.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Events (list) --
A list of events associated with the volume.
(dict) --
Describes a volume status event.
Description (string) --
A description of the event.
EventId (string) --
The ID of this event.
EventType (string) --
The type of this event.
NotAfter (datetime) --
The latest end time of the event.
NotBefore (datetime) --
The earliest start time of the event.
InstanceId (string) --
The ID of the instance associated with the event.
VolumeId (string) --
The volume ID.
VolumeStatus (dict) --
The volume status.
Details (list) --
The details of the volume status.
(dict) --
Describes a volume status.
Name (string) --
The name of the volume status.
Status (string) --
The intended status of the volume status.
Status (string) --
The status of the volume.
AttachmentStatuses (list) --
Information about the instances to which the volume is attached.
(dict) --
Information about the instances to which the volume is attached.
IoPerformance (string) --
The maximum IOPS supported by the attached instance.
InstanceId (string) --
The ID of the attached instance.
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detaching an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = volume.detach_from_instance(
Device='string',
Force=True|False,
InstanceId='string',
DryRun=True|False
)
dict
Response Syntax
{
'AttachTime': datetime(2015, 1, 1),
'Device': 'string',
'InstanceId': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'VolumeId': 'string',
'DeleteOnTermination': True|False
}
Response Structure
(dict) --
Describes volume attachment details.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Device (string) --
The device name.
InstanceId (string) --
The ID of the instance.
State (string) --
The attachment state of the volume.
VolumeId (string) --
The ID of the volume.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
See also: AWS API Documentation
Request Syntax
response = volume.enable_io(
DryRun=True|False,
)
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_volumes() to update the attributes of the Volume resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
volume.load()
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
See also: AWS API Documentation
Request Syntax
response = volume.modify_attribute(
AutoEnableIO={
'Value': True|False
},
DryRun=True|False
)
Indicates whether the volume should be auto-enabled for I/O operations.
The attribute value. The valid values are true or false .
None
Calls EC2.Client.describe_volumes() to update the attributes of the Volume resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
volume.reload()
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
A collection of Snapshot resources.A Snapshot Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Snapshot resources in the collection.
See also: AWS API Documentation
Request Syntax
snapshot_iterator = volume.snapshots.all()
Creates an iterable of all Snapshot resources in the collection filtered by kwargs passed to method.A Snapshot collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
snapshot_iterator = volume.snapshots.filter(
MaxResults=123,
NextToken='string',
OwnerIds=[
'string',
],
RestorableByUserIds=[
'string',
],
SnapshotIds=[
'string',
],
DryRun=True|False
)
Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self , and amazon .
The IDs of the AWS accounts that can create volumes from the snapshot.
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
list(ec2.Snapshot)
A list of Snapshot resources
Creates an iterable up to a specified amount of Snapshot resources in the collection.
See also: AWS API Documentation
Request Syntax
snapshot_iterator = volume.snapshots.limit(
count=123
)
Creates an iterable of all Snapshot resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
snapshot_iterator = volume.snapshots.page_size(
count=123
)
A resource representing an Amazon Elastic Compute Cloud (EC2) Vpc:
import boto3
ec2 = boto3.resource('ec2')
vpc = ec2.Vpc('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
These are the resource's available collections:
These are the resource's available waiters:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The Vpc's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The primary IPv4 CIDR block for the VPC.
(list) --
Information about the IPv4 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv4 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
(string) --
The ID of the set of DHCP options you've associated with the VPC.
(string) --
The allowed tenancy of instances launched into the VPC.
(list) --
Information about the IPv6 CIDR blocks associated with the VPC.
(dict) --
Describes an IPv6 CIDR block associated with a VPC.
AssociationId (string) --
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
Information about the state of the CIDR block.
State (string) --
The state of the CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
NetworkBorderGroup (string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1 .
Ipv6Pool (string) --
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
(boolean) --
Indicates whether the VPC is the default VPC.
(string) --
The ID of the AWS account that owns the VPC.
(string) --
The current state of the VPC.
(list) --
Any tags assigned to the VPC.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The ID of the VPC.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(DhcpOptions) The related dhcp_options if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.associate_dhcp_options(
DhcpOptionsId='string',
DryRun=True|False
)
[REQUIRED]
The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
None
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
See also: AWS API Documentation
Request Syntax
response = vpc.attach_classic_link_instance(
DryRun=True|False,
Groups=[
'string',
],
InstanceId='string',
)
[REQUIRED]
The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
[REQUIRED]
The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.attach_internet_gateway(
DryRun=True|False,
InternetGatewayId='string',
)
[REQUIRED]
The ID of the internet gateway.
None
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
network_acl = vpc.create_network_acl(
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The tags to assign to the network ACL.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.NetworkAcl
NetworkAcl resource
Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
route_table = vpc.create_route_table(
DryRun=True|False,
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The tags to assign to the route table.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.RouteTable
RouteTable resource
Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress , AuthorizeSecurityGroupEgress , RevokeSecurityGroupIngress , and RevokeSecurityGroupEgress .
For more information about VPC security group limits, see Amazon VPC Limits .
See also: AWS API Documentation
Request Syntax
security_group = vpc.create_security_group(
Description='string',
GroupName='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
DryRun=True|False
)
[REQUIRED]
A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
[REQUIRED]
The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg- .
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
The tags to assign to the security group.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.SecurityGroup
SecurityGroup resource
Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
Warning
AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide .
See also: AWS API Documentation
Request Syntax
subnet = vpc.create_subnet(
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
AvailabilityZone='string',
AvailabilityZoneId='string',
CidrBlock='string',
Ipv6CidrBlock='string',
OutpostArn='string',
DryRun=True|False
)
The tags to assign to the subnet.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The Availability Zone or Local Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a . For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide .
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
[REQUIRED]
The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .
ec2.Subnet
Subnet resource
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
tag = vpc.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
list(ec2.Tag)
A list of Tag resources
Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
See also: AWS API Documentation
Request Syntax
response = vpc.delete(
DryRun=True|False
)
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
See also: AWS API Documentation
Request Syntax
response = vpc.describe_attribute(
Attribute='enableDnsSupport'|'enableDnsHostnames',
DryRun=True|False
)
[REQUIRED]
The VPC attribute.
dict
Response Syntax
{
'VpcId': 'string',
'EnableDnsHostnames': {
'Value': True|False
},
'EnableDnsSupport': {
'Value': True|False
}
}
Response Structure
(dict) --
VpcId (string) --
The ID of the VPC.
EnableDnsHostnames (dict) --
Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true , instances in the VPC get DNS hostnames; otherwise, they do not.
Value (boolean) --
The attribute value. The valid values are true or false .
EnableDnsSupport (dict) --
Indicates whether DNS resolution is enabled for the VPC. If this attribute is true , the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
Value (boolean) --
The attribute value. The valid values are true or false .
Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
See also: AWS API Documentation
Request Syntax
response = vpc.detach_classic_link_instance(
DryRun=True|False,
InstanceId='string',
)
[REQUIRED]
The ID of the instance to unlink from the VPC.
dict
Response Syntax
{
'Return': True|False
}
Response Structure
(dict) --
Return (boolean) --
Returns true if the request succeeds; otherwise, it returns an error.
Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.
See also: AWS API Documentation
Request Syntax
response = vpc.detach_internet_gateway(
DryRun=True|False,
InternetGatewayId='string',
)
[REQUIRED]
The ID of the internet gateway.
None
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
See also: AWS API Documentation
Request Syntax
response = vpc.disable_classic_link(
DryRun=True|False,
)
{
'Return': True|False
}
Response Structure
Returns true if the request succeeds; otherwise, it returns an error.
Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.enable_classic_link(
DryRun=True|False,
)
{
'Return': True|False
}
Response Structure
Returns true if the request succeeds; otherwise, it returns an error.
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_vpcs() to update the attributes of the Vpc resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
vpc.load()
Modifies the specified attribute of the specified VPC.
See also: AWS API Documentation
Request Syntax
response = vpc.modify_attribute(
EnableDnsHostnames={
'Value': True|False
},
EnableDnsSupport={
'Value': True|False
},
)
Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
The attribute value. The valid values are true or false .
Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
The attribute value. The valid values are true or false .
None
Calls EC2.Client.describe_vpcs() to update the attributes of the Vpc resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
vpc.reload()
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Note
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide .
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed .
See also: AWS API Documentation
Request Syntax
vpc_peering_connection = vpc.request_vpc_peering_connection(
DryRun=True|False,
PeerOwnerId='string',
PeerVpcId='string',
PeerRegion='string',
TagSpecifications=[
{
'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'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'|'internet-gateway'|'key-pair'|'launch-template'|'local-gateway-route-table-vpc-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
The tags to assign to the peering connection.
The tags to apply to a resource when the resource is being created.
The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | 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 | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .
To tag a resource after it has been created, see CreateTags .
The tags to apply to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
ec2.VpcPeeringConnection
VpcPeeringConnection resource
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
A collection of VpcPeeringConnection resources.A VpcPeeringConnection Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all VpcPeeringConnection resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = vpc.accepted_vpc_peering_connections.all()
Creates an iterable of all VpcPeeringConnection resources in the collection filtered by kwargs passed to method.A VpcPeeringConnection collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = vpc.accepted_vpc_peering_connections.filter(
DryRun=True|False,
VpcPeeringConnectionIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
list(ec2.VpcPeeringConnection)
A list of VpcPeeringConnection resources
Creates an iterable up to a specified amount of VpcPeeringConnection resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = vpc.accepted_vpc_peering_connections.limit(
count=123
)
Creates an iterable of all VpcPeeringConnection resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = vpc.accepted_vpc_peering_connections.page_size(
count=123
)
A collection of Instance resources.A Instance Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Instance resources in the collection.
See also: AWS API Documentation
Request Syntax
instance_iterator = vpc.instances.all()
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide . For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.instances.create_tags(
DryRun=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
None
Creates an iterable of all Instance resources in the collection filtered by kwargs passed to method.A Instance collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
instance_iterator = vpc.instances.filter(
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
The instance IDs.
Default: Describes all your instances.
list(ec2.Instance)
A list of Instance resources
Creates an iterable up to a specified amount of Instance resources in the collection.
See also: AWS API Documentation
Request Syntax
instance_iterator = vpc.instances.limit(
count=123
)
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
To disable detailed monitoring, see .
See also: AWS API Documentation
Request Syntax
response = vpc.instances.monitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Creates an iterable of all Instance resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
instance_iterator = vpc.instances.page_size(
count=123
)
Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.instances.reboot(
DryRun=True|False
)
Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping instances in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.instances.start(
AdditionalInfo='string',
DryRun=True|False
)
dict
Response Syntax
{
'StartingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StartingInstances (list) --
Information about the started instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon EC2 User Guide .
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide .
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.instances.stop(
Hibernate=True|False,
DryRun=True|False,
Force=True|False
)
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide .
Default: false
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
dict
Response Syntax
{
'StoppingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
(dict) --
StoppingInstances (list) --
Information about the stopped instances.
(dict) --
Describes an instance state change.
CurrentState (dict) --
The current state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceId (string) --
The ID of the instance.
PreviousState (dict) --
The previous state of the instance.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
For example, say you have the following instances:
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide .
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.instances.terminate(
DryRun=True|False
)
{
'TerminatingInstances': [
{
'CurrentState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceId': 'string',
'PreviousState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
}
},
]
}
Response Structure
Information about the terminated instances.
Describes an instance state change.
The current state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
The ID of the instance.
The previous state of the instance.
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
The current state of the instance.
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide .
See also: AWS API Documentation
Request Syntax
response = vpc.instances.unmonitor(
DryRun=True|False
)
{
'InstanceMonitorings': [
{
'InstanceId': 'string',
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
}
},
]
}
Response Structure
The monitoring information.
Describes the monitoring of an instance.
The ID of the instance.
The monitoring for the instance.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
A collection of InternetGateway resources.A InternetGateway Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all InternetGateway resources in the collection.
See also: AWS API Documentation
Request Syntax
internet_gateway_iterator = vpc.internet_gateways.all()
Creates an iterable of all InternetGateway resources in the collection filtered by kwargs passed to method.A InternetGateway collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
internet_gateway_iterator = vpc.internet_gateways.filter(
DryRun=True|False,
InternetGatewayIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more internet gateway IDs.
Default: Describes all your internet gateways.
list(ec2.InternetGateway)
A list of InternetGateway resources
Creates an iterable up to a specified amount of InternetGateway resources in the collection.
See also: AWS API Documentation
Request Syntax
internet_gateway_iterator = vpc.internet_gateways.limit(
count=123
)
Creates an iterable of all InternetGateway resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
internet_gateway_iterator = vpc.internet_gateways.page_size(
count=123
)
A collection of NetworkAcl resources.A NetworkAcl Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all NetworkAcl resources in the collection.
See also: AWS API Documentation
Request Syntax
network_acl_iterator = vpc.network_acls.all()
Creates an iterable of all NetworkAcl resources in the collection filtered by kwargs passed to method.A NetworkAcl collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
network_acl_iterator = vpc.network_acls.filter(
DryRun=True|False,
NetworkAclIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more network ACL IDs.
Default: Describes all your network ACLs.
list(ec2.NetworkAcl)
A list of NetworkAcl resources
Creates an iterable up to a specified amount of NetworkAcl resources in the collection.
See also: AWS API Documentation
Request Syntax
network_acl_iterator = vpc.network_acls.limit(
count=123
)
Creates an iterable of all NetworkAcl resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
network_acl_iterator = vpc.network_acls.page_size(
count=123
)
A collection of NetworkInterface resources.A NetworkInterface Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all NetworkInterface resources in the collection.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = vpc.network_interfaces.all()
Creates an iterable of all NetworkInterface resources in the collection filtered by kwargs passed to method.A NetworkInterface collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = vpc.network_interfaces.filter(
DryRun=True|False,
NetworkInterfaceIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more network interface IDs.
Default: Describes all your network interfaces.
list(ec2.NetworkInterface)
A list of NetworkInterface resources
Creates an iterable up to a specified amount of NetworkInterface resources in the collection.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = vpc.network_interfaces.limit(
count=123
)
Creates an iterable of all NetworkInterface resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
network_interface_iterator = vpc.network_interfaces.page_size(
count=123
)
A collection of VpcPeeringConnection resources.A VpcPeeringConnection Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all VpcPeeringConnection resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = vpc.requested_vpc_peering_connections.all()
Creates an iterable of all VpcPeeringConnection resources in the collection filtered by kwargs passed to method.A VpcPeeringConnection collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = vpc.requested_vpc_peering_connections.filter(
DryRun=True|False,
VpcPeeringConnectionIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
list(ec2.VpcPeeringConnection)
A list of VpcPeeringConnection resources
Creates an iterable up to a specified amount of VpcPeeringConnection resources in the collection.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = vpc.requested_vpc_peering_connections.limit(
count=123
)
Creates an iterable of all VpcPeeringConnection resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection_iterator = vpc.requested_vpc_peering_connections.page_size(
count=123
)
A collection of RouteTable resources.A RouteTable Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all RouteTable resources in the collection.
See also: AWS API Documentation
Request Syntax
route_table_iterator = vpc.route_tables.all()
Creates an iterable of all RouteTable resources in the collection filtered by kwargs passed to method.A RouteTable collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
route_table_iterator = vpc.route_tables.filter(
DryRun=True|False,
RouteTableIds=[
'string',
],
NextToken='string',
MaxResults=123
)
One or more route table IDs.
Default: Describes all your route tables.
list(ec2.RouteTable)
A list of RouteTable resources
Creates an iterable up to a specified amount of RouteTable resources in the collection.
See also: AWS API Documentation
Request Syntax
route_table_iterator = vpc.route_tables.limit(
count=123
)
Creates an iterable of all RouteTable resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
route_table_iterator = vpc.route_tables.page_size(
count=123
)
A collection of SecurityGroup resources.A SecurityGroup Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all SecurityGroup resources in the collection.
See also: AWS API Documentation
Request Syntax
security_group_iterator = vpc.security_groups.all()
Creates an iterable of all SecurityGroup resources in the collection filtered by kwargs passed to method.A SecurityGroup collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
security_group_iterator = vpc.security_groups.filter(
GroupIds=[
'string',
],
GroupNames=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
list(ec2.SecurityGroup)
A list of SecurityGroup resources
Creates an iterable up to a specified amount of SecurityGroup resources in the collection.
See also: AWS API Documentation
Request Syntax
security_group_iterator = vpc.security_groups.limit(
count=123
)
Creates an iterable of all SecurityGroup resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
security_group_iterator = vpc.security_groups.page_size(
count=123
)
A collection of Subnet resources.A Subnet Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
Creates an iterable of all Subnet resources in the collection.
See also: AWS API Documentation
Request Syntax
subnet_iterator = vpc.subnets.all()
Creates an iterable of all Subnet resources in the collection filtered by kwargs passed to method.A Subnet collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
subnet_iterator = vpc.subnets.filter(
SubnetIds=[
'string',
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more subnet IDs.
Default: Describes all your subnets.
list(ec2.Subnet)
A list of Subnet resources
Creates an iterable up to a specified amount of Subnet resources in the collection.
See also: AWS API Documentation
Request Syntax
subnet_iterator = vpc.subnets.limit(
count=123
)
Creates an iterable of all Subnet resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
subnet_iterator = vpc.subnets.page_size(
count=123
)
Waiters
Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide.
Waits until this Vpc is available. This method calls EC2.Waiter.vpc_available.wait() which polls. EC2.Client.describe_vpcs() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
vpc.wait_until_available(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
None
Waits until this Vpc is exists. This method calls EC2.Waiter.vpc_exists.wait() which polls. EC2.Client.describe_vpcs() every 1 seconds until a successful state is reached. An error is returned after 5 failed checks.
See also: AWS API Documentation
Request Syntax
vpc.wait_until_exists(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
None
A resource representing an Amazon Elastic Compute Cloud (EC2) VpcPeeringConnection:
import boto3
ec2 = boto3.resource('ec2')
vpc_peering_connection = ec2.VpcPeeringConnection('id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
These are the resource's available waiters:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The VpcPeeringConnection's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(dict) --
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
(datetime) --
The time that an unaccepted VPC peering connection will expire.
(dict) --
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
CidrBlock (string) --
The IPv4 CIDR block for the VPC.
Ipv6CidrBlockSet (list) --
The IPv6 CIDR block for the VPC.
(dict) --
Describes an IPv6 CIDR block.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
CidrBlockSet (list) --
Information about the IPv4 CIDR blocks for the VPC.
(dict) --
Describes an IPv4 CIDR block.
CidrBlock (string) --
The IPv4 CIDR block.
OwnerId (string) --
The AWS account ID of the VPC owner.
PeeringOptions (dict) --
Information about the VPC peering connection options for the accepter or requester VPC.
AllowDnsResolutionFromRemoteVpc (boolean) --
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) --
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
AllowEgressFromLocalVpcToRemoteClassicLink (boolean) --
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
VpcId (string) --
The ID of the VPC.
Region (string) --
The Region in which the VPC is located.
(dict) --
The status of the VPC peering connection.
Code (string) --
The status of the VPC peering connection.
Message (string) --
A message that provides more information about the status, if applicable.
(list) --
Any tags assigned to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
(string) --
The ID of the VPC peering connection.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(Vpc) The related accepter_vpc if set, otherwise None.
(Vpc) The related requester_vpc if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
See also: AWS API Documentation
Request Syntax
response = vpc_peering_connection.accept(
DryRun=True|False,
)
{
'VpcPeeringConnection': {
'AccepterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'ExpirationTime': datetime(2015, 1, 1),
'RequesterVpcInfo': {
'CidrBlock': 'string',
'Ipv6CidrBlockSet': [
{
'Ipv6CidrBlock': 'string'
},
],
'CidrBlockSet': [
{
'CidrBlock': 'string'
},
],
'OwnerId': 'string',
'PeeringOptions': {
'AllowDnsResolutionFromRemoteVpc': True|False,
'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
},
'VpcId': 'string',
'Region': 'string'
},
'Status': {
'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
'Message': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcPeeringConnectionId': 'string'
}
}
Response Structure
Information about the VPC peering connection.
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
The IPv4 CIDR block for the VPC.
The IPv6 CIDR block for the VPC.
Describes an IPv6 CIDR block.
The IPv6 CIDR block.
Information about the IPv4 CIDR blocks for the VPC.
Describes an IPv4 CIDR block.
The IPv4 CIDR block.
The AWS account ID of the VPC owner.
Information about the VPC peering connection options for the accepter or requester VPC.
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
The ID of the VPC.
The Region in which the VPC is located.
The time that an unaccepted VPC peering connection will expire.
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
The IPv4 CIDR block for the VPC.
The IPv6 CIDR block for the VPC.
Describes an IPv6 CIDR block.
The IPv6 CIDR block.
Information about the IPv4 CIDR blocks for the VPC.
Describes an IPv4 CIDR block.
The IPv4 CIDR block.
The AWS account ID of the VPC owner.
Information about the VPC peering connection options for the accepter or requester VPC.
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
The ID of the VPC.
The Region in which the VPC is located.
The status of the VPC peering connection.
The status of the VPC peering connection.
A message that provides more information about the status, if applicable.
Any tags assigned to the resource.
Describes a tag.
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
The ID of the VPC peering connection.
Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.
See also: AWS API Documentation
Request Syntax
response = vpc_peering_connection.delete(
DryRun=True|False,
)
{
'Return': True|False
}
Response Structure
Returns true if the request succeeds; otherwise, it returns an error.
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_vpc_peering_connections() to update the attributes of the VpcPeeringConnection resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection.load()
Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection .
See also: AWS API Documentation
Request Syntax
response = vpc_peering_connection.reject(
DryRun=True|False,
)
{
'Return': True|False
}
Response Structure
Returns true if the request succeeds; otherwise, it returns an error.
Calls EC2.Client.describe_vpc_peering_connections() to update the attributes of the VpcPeeringConnection resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection.reload()
Waiters
Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide.
Waits until this VpcPeeringConnection is exists. This method calls EC2.Waiter.vpc_peering_connection_exists.wait() which polls. EC2.Client.describe_vpc_peering_connections() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
vpc_peering_connection.wait_until_exists(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DryRun=True|False,
NextToken='string',
MaxResults=123
)
One or more filters.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
The name of the filter. Filter names are case-sensitive.
The filter values. Filter values are case-sensitive.
None
A resource representing an Amazon Elastic Compute Cloud (EC2) VpcAddress:
import boto3
ec2 = boto3.resource('ec2')
vpc_address = ec2.VpcAddress('allocation_id')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available references:
These are the resource's available actions:
Identifiers
Identifiers are properties of a resource that are set upon instantation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
(string) The VpcAddress's allocation_id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method. For more information about attributes refer to the Resources Introduction Guide.
(string) --
The ID representing the association of the address with an instance in a VPC.
(string) --
The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
(string) --
The customer-owned IP address.
(string) --
The ID of the customer-owned address pool.
(string) --
Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc ).
(string) --
The ID of the instance that the address is associated with (if any).
(string) --
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
(string) --
The ID of the network interface.
(string) --
The ID of the account that owns the network interface.
(string) --
The private IP address associated with the Elastic IP address.
(string) --
The Elastic IP address.
(string) --
The ID of an address pool.
(list) --
Any tags assigned to the Elastic IP address.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
(NetworkInterfaceAssociation) The related association if set, otherwise None.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
Warning
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing .
See also: AWS API Documentation
Request Syntax
response = vpc_address.associate(
InstanceId='string',
PublicIp='string',
AllowReassociation=True|False,
DryRun=True|False,
NetworkInterfaceId='string',
PrivateIpAddress='string'
)
[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
dict
Response Syntax
{
'AssociationId': 'string'
}
Response Structure
(dict) --
AssociationId (string) --
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
Returns a list of all the available sub-resources for this Resource.
Calls EC2.Client.describe_addresses() to update the attributes of the VpcAddress resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
vpc_address.load()
Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress .
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse ).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress .
See also: AWS API Documentation
Request Syntax
response = vpc_address.release(
PublicIp='string',
NetworkBorderGroup='string',
DryRun=True|False
)
The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes .
Note
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes .
None
Calls EC2.Client.describe_addresses() to update the attributes of the VpcAddress resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
vpc_address.reload()