2025/08/11 - Amazon Elastic Compute Cloud - 21 updated api methods
Changes This release adds AvailabilityZoneId support for CreateVolume, DescribeVolume, LaunchTemplates, RunInstances, DescribeInstances, CreateDefaultSubnet, SpotInstances, and CreateDefaultSubnet APIs.
{'AvailabilityZoneId': 'string'}
Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Create a default subnet in the Amazon VPC User Guide.
See also: AWS API Documentation
Request Syntax
client.create_default_subnet(
AvailabilityZone='string',
DryRun=True|False,
Ipv6Native=True|False,
AvailabilityZoneId='string'
)
string
The Availability Zone in which to create the default subnet.
Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
boolean
Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.
string
The ID of the Availability Zone.
Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.
dict
Response Syntax
{
'Subnet': {
'AvailabilityZoneId': 'string',
'EnableLniAtDeviceIndex': 123,
'MapCustomerOwnedIpOnLaunch': True|False,
'CustomerOwnedIpv4Pool': 'string',
'OwnerId': 'string',
'AssignIpv6AddressOnCreation': True|False,
'Ipv6CidrBlockAssociationSet': [
{
'AssociationId': 'string',
'Ipv6CidrBlock': 'string',
'Ipv6CidrBlockState': {
'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
'StatusMessage': 'string'
},
'Ipv6AddressAttribute': 'public'|'private',
'IpSource': 'amazon'|'byoip'|'none'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SubnetArn': 'string',
'OutpostArn': 'string',
'EnableDns64': True|False,
'Ipv6Native': True|False,
'PrivateDnsNameOptionsOnLaunch': {
'HostnameType': 'ip-name'|'resource-name',
'EnableResourceNameDnsARecord': True|False,
'EnableResourceNameDnsAAAARecord': True|False
},
'BlockPublicAccessStates': {
'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress'
},
'Type': 'string',
'SubnetId': 'string',
'State': 'pending'|'available'|'unavailable'|'failed'|'failed-insufficient-capacity',
'VpcId': 'string',
'CidrBlock': 'string',
'AvailableIpAddressCount': 123,
'AvailabilityZone': 'string',
'DefaultForAz': True|False,
'MapPublicIpOnLaunch': True|False
}
}
Response Structure
(dict) --
Subnet (dict) --
Information about the subnet.
AvailabilityZoneId (string) --
The AZ ID of the subnet.
EnableLniAtDeviceIndex (integer) --
Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
MapCustomerOwnedIpOnLaunch (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
CustomerOwnedIpv4Pool (string) --
The customer-owned IPv4 address pool associated with the subnet.
OwnerId (string) --
The ID of the Amazon Web Services account that owns the subnet.
AssignIpv6AddressOnCreation (boolean) --
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
Ipv6CidrBlockAssociationSet (list) --
Information about the IPv6 CIDR blocks associated with the subnet.
(dict) --
Describes an association between a subnet and an IPv6 CIDR block.
AssociationId (string) --
The ID of the association.
Ipv6CidrBlock (string) --
The IPv6 CIDR block.
Ipv6CidrBlockState (dict) --
The state of the CIDR block.
State (string) --
The state of a CIDR block.
StatusMessage (string) --
A message about the status of the CIDR block, if applicable.
Ipv6AddressAttribute (string) --
Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.
IpSource (string) --
The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
Tags (list) --
Any tags assigned to the subnet.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
SubnetArn (string) --
The Amazon Resource Name (ARN) of the subnet.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
EnableDns64 (boolean) --
Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
Ipv6Native (boolean) --
Indicates whether this is an IPv6 only subnet.
PrivateDnsNameOptionsOnLaunch (dict) --
The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
HostnameType (string) --
The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
EnableResourceNameDnsARecord (boolean) --
Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
EnableResourceNameDnsAAAARecord (boolean) --
Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
BlockPublicAccessStates (dict) --
The state of VPC Block Public Access (BPA).
InternetGatewayBlockMode (string) --
The mode of VPC BPA.
off: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region.
block-bidirectional: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets).
block-ingress: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established.
Type (string) --
Indicates if this is a subnet used with Amazon Elastic VMware Service (EVS). Possible values are Elastic VMware Service or no value. For more information about Amazon EVS, see Amazon Elastic VMware Service API Reference.
SubnetId (string) --
The ID of the subnet.
State (string) --
The current state of the subnet.
failed: The underlying infrastructure to support the subnet failed to provision as expected.
failed-insufficient-capacity: The underlying infrastructure to support the subnet failed to provision due to a shortage of EC2 instance capacity.
VpcId (string) --
The ID of the VPC the subnet is in.
CidrBlock (string) --
The IPv4 CIDR block assigned to the subnet.
AvailableIpAddressCount (integer) --
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
AvailabilityZone (string) --
The Availability Zone of the subnet.
DefaultForAz (boolean) --
Indicates whether this is the default subnet for the Availability Zone.
MapPublicIpOnLaunch (boolean) --
Indicates whether instances launched in this subnet receive a public IPv4 address.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
{'LaunchTemplateConfigs': {'Overrides': {'Placement': {'AvailabilityZoneId': 'string'}}}}
{'LaunchTemplateData': {'Placement': {'AvailabilityZoneId': 'string'}}}
{'LaunchTemplateData': {'Placement': {'AvailabilityZoneId': 'string'}}}
Response {'LaunchTemplateVersion': {'LaunchTemplateData': {'Placement': {'AvailabilityZoneId': 'string'}}}}
{'AvailabilityZoneId': 'string'}
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 Amazon Web Services 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 EBS User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
For more information, see Create an Amazon EBS volume in the Amazon EBS User Guide.
See also: AWS API Documentation
Request Syntax
client.create_volume(
AvailabilityZone='string',
AvailabilityZoneId='string',
Encrypted=True|False,
Iops=123,
KmsKeyId='string',
OutpostArn='string',
Size=123,
SnapshotId='string',
VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiAttachEnabled=True|False,
Throughput=123,
ClientToken='string',
VolumeInitializationRate=123,
Operator={
'Principal': 'string'
},
DryRun=True|False
)
string
The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.
string
The ID of the Availability Zone in which to create the volume. For example, use1-az1.
Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.
boolean
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 EBS User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
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:
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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.
string
The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
string
The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.
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:
gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
string
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
string
The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
Default: gp2
list
The tags to apply to the volume during creation.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
boolean
Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.
integer
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.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
integer
Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
Valid range: 100 - 300 MiB/s
dict
Reserved for internal use.
Principal (string) --
The service provider that manages the resource.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'AvailabilityZoneId': 'string',
'OutpostArn': 'string',
'Iops': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'FastRestored': True|False,
'MultiAttachEnabled': True|False,
'Throughput': 123,
'SseType': 'sse-ebs'|'sse-kms'|'none',
'Operator': {
'Managed': True|False,
'Principal': 'string'
},
'VolumeInitializationRate': 123,
'VolumeId': 'string',
'Size': 123,
'SnapshotId': 'string',
'AvailabilityZone': 'string',
'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
'CreateTime': datetime(2015, 1, 1),
'Attachments': [
{
'DeleteOnTermination': True|False,
'AssociatedResource': 'string',
'InstanceOwningService': 'string',
'VolumeId': 'string',
'InstanceId': 'string',
'Device': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'AttachTime': datetime(2015, 1, 1)
},
],
'Encrypted': True|False,
'KmsKeyId': 'string'
}
Response Structure
(dict) --
Describes a volume.
AvailabilityZoneId (string) --
The ID of the Availability Zone for the volume.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
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 256 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.
SseType (string) --
Reserved for future use.
Operator (dict) --
The service provider that manages the volume.
Managed (boolean) --
If true, the resource is managed by a service provider.
Principal (string) --
If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
VolumeInitializationRate (integer) --
The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is null.
VolumeId (string) --
The ID of the volume.
Size (integer) --
The size of the volume, in GiBs.
SnapshotId (string) --
The snapshot from which the volume was created, if applicable.
AvailabilityZone (string) --
The Availability Zone for the volume.
State (string) --
The volume state.
CreateTime (datetime) --
The time stamp when volume creation was initiated.
Attachments (list) --
Information about the volume attachments.
(dict) --
Describes volume attachment details.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
AssociatedResource (string) --
The ARN of the Amazon Web Services-managed resource to which the volume is attached.
InstanceOwningService (string) --
The service principal of the Amazon Web Services service that owns the underlying resource to which the volume is attached.
This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources.
VolumeId (string) --
The ID of the volume.
InstanceId (string) --
The ID of the instance.
If the volume is attached to an Amazon Web Services-managed resource, this parameter returns null.
Device (string) --
The device name.
If the volume is attached to an Amazon Web Services-managed resource, this parameter returns null.
State (string) --
The attachment state of the volume.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Encrypted (boolean) --
Indicates whether the volume is encrypted.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
{'ServiceConfiguration': {'AvailabilityZoneIds': ['string']}}
Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.
Before you create an endpoint service, you must create one of the following for your service:
A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.
If you set the private DNS name, you must prove that you own the private DNS domain name.
For more information, see the Amazon Web Services PrivateLink Guide.
See also: AWS API Documentation
Request Syntax
client.create_vpc_endpoint_service_configuration(
DryRun=True|False,
AcceptanceRequired=True|False,
PrivateDnsName='string',
NetworkLoadBalancerArns=[
'string',
],
GatewayLoadBalancerArns=[
'string',
],
SupportedIpAddressTypes=[
'string',
],
SupportedRegions=[
'string',
],
ClientToken='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
boolean
Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
string
(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
list
The Amazon Resource Names (ARNs) of the Network Load Balancers.
(string) --
list
The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
(string) --
list
The supported IP address types. The possible values are ipv4 and ipv6.
(string) --
list
The Regions from which service consumers can access the service.
(string) --
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
list
The tags to associate with the service.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
dict
Response Syntax
{
'ServiceConfiguration': {
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
},
],
'ServiceId': 'string',
'ServiceName': 'string',
'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
'AvailabilityZoneIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'NetworkLoadBalancerArns': [
'string',
],
'GatewayLoadBalancerArns': [
'string',
],
'SupportedIpAddressTypes': [
'ipv4'|'ipv6',
],
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'PrivateDnsNameConfiguration': {
'State': 'pendingVerification'|'verified'|'failed',
'Type': 'string',
'Value': 'string',
'Name': 'string'
},
'PayerResponsibility': 'ServiceOwner',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportedRegions': [
{
'Region': 'string',
'ServiceState': 'string'
},
],
'RemoteAccessEnabled': True|False
},
'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.
AvailabilityZoneIds (list) --
The IDs of the Availability Zones in which the service is available.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
(string) --
AvailabilityZones (list) --
The Availability Zones in which the service is available.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
(string) --
AcceptanceRequired (boolean) --
Indicates whether requests from other Amazon Web Services 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.
(string) --
GatewayLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
(string) --
SupportedIpAddressTypes (list) --
The supported IP address types.
(string) --
BaseEndpointDnsNames (list) --
The DNS names for the service.
(string) --
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.
PayerResponsibility (string) --
The payer responsibility.
Tags (list) --
The 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 256 Unicode characters.
SupportedRegions (list) --
The supported Regions.
(dict) --
Describes a supported Region.
Region (string) --
The Region code.
ServiceState (string) --
The service state. The possible values are Pending, Available, Deleting, Deleted, Failed, and Closed.
RemoteAccessEnabled (boolean) --
Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.
ClientToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
{'ConversionTasks': {'ImportInstance': {'Volumes': {'AvailabilityZoneId': 'string'}},
'ImportVolume': {'AvailabilityZoneId': 'string'}}}
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
client.describe_conversion_tasks(
DryRun=True|False,
ConversionTaskIds=[
'string',
]
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The conversion task IDs.
(string) --
dict
Response Syntax
{
'ConversionTasks': [
{
'ConversionTaskId': 'string',
'ExpirationTime': 'string',
'ImportInstance': {
'Description': 'string',
'InstanceId': 'string',
'Platform': 'Windows',
'Volumes': [
{
'AvailabilityZone': 'string',
'AvailabilityZoneId': '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',
'AvailabilityZoneId': '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.
AvailabilityZoneId (string) --
The ID of 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.
AvailabilityZoneId (string) --
The ID of 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 256 Unicode characters.
{'InstanceStatuses': {'AvailabilityZoneId': 'string'}}
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:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
See also: AWS API Documentation
Request Syntax
client.describe_instance_status(
InstanceIds=[
'string',
],
MaxResults=123,
NextToken='string',
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeAllInstances=True|False
)
list
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
(string) --
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The filters.
availability-zone - The Availability Zone of the instance.
availability-zone-id - The ID of the Availability Zone of the instance.
event.code - The code for the scheduled event ( instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance ( pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability ( passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
operator.managed - A Boolean that indicates whether this is a managed instance.
operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.
system-status.reachability - Filters on system status where the name is reachability ( passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
attached-ebs-status.status - The status of the attached EBS volume for the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
boolean
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',
'AvailabilityZoneId': 'string',
'OutpostArn': 'string',
'Operator': {
'Managed': True|False,
'Principal': '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'
},
'AttachedEbsStatus': {
'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.
AvailabilityZoneId (string) --
The ID of the Availability Zone of the instance.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Operator (dict) --
The service provider that manages the instance.
Managed (boolean) --
If true, the resource is managed by a service provider.
Principal (string) --
If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
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:
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
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.
AttachedEbsStatus (dict) --
Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations.
Details (list) --
Details about the attached EBS status check for an instance.
(dict) --
Describes the attached EBS status check for an instance.
ImpairedSince (datetime) --
The date and time when the attached EBS status check failed.
Name (string) --
The name of the attached EBS status check.
Status (string) --
The result of the attached EBS status check.
Status (string) --
The current status.
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
{'Reservations': {'Instances': {'Placement': {'AvailabilityZoneId': 'string'}}}}
{'LaunchTemplateVersions': {'LaunchTemplateData': {'Placement': {'AvailabilityZoneId': 'string'}}}}
{'SpotInstanceRequests': {'LaunchedAvailabilityZoneId': 'string'}}
{'AvailabilityZoneId': 'string'}
Response {'SpotPriceHistory': {'AvailabilityZoneId': 'string'}}
{'Volumes': {'AvailabilityZoneId': 'string'}}
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. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_volumes(
VolumeIds=[
'string',
],
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
list
The volume IDs. If not specified, then all volumes are included in the response.
(string) --
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state ( attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
availability-zone-id - The ID of the Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted ( true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore ( true | false).
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach ( true | false)
operator.managed - A Boolean that indicates whether this is a managed volume.
operator.principal - The principal that manages the volume. Only valid for managed volumes, where managed is true.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume ( creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type ( gp2 | gp3 | io1 | io2 | st1 | sc1``| ``standard)
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
dict
Response Syntax
{
'NextToken': 'string',
'Volumes': [
{
'AvailabilityZoneId': 'string',
'OutpostArn': 'string',
'Iops': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'FastRestored': True|False,
'MultiAttachEnabled': True|False,
'Throughput': 123,
'SseType': 'sse-ebs'|'sse-kms'|'none',
'Operator': {
'Managed': True|False,
'Principal': 'string'
},
'VolumeInitializationRate': 123,
'VolumeId': 'string',
'Size': 123,
'SnapshotId': 'string',
'AvailabilityZone': 'string',
'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
'CreateTime': datetime(2015, 1, 1),
'Attachments': [
{
'DeleteOnTermination': True|False,
'AssociatedResource': 'string',
'InstanceOwningService': 'string',
'VolumeId': 'string',
'InstanceId': 'string',
'Device': 'string',
'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
'AttachTime': datetime(2015, 1, 1)
},
],
'Encrypted': True|False,
'KmsKeyId': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Volumes (list) --
Information about the volumes.
(dict) --
Describes a volume.
AvailabilityZoneId (string) --
The ID of the Availability Zone for the volume.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
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 256 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.
SseType (string) --
Reserved for future use.
Operator (dict) --
The service provider that manages the volume.
Managed (boolean) --
If true, the resource is managed by a service provider.
Principal (string) --
If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
VolumeInitializationRate (integer) --
The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is null.
VolumeId (string) --
The ID of the volume.
Size (integer) --
The size of the volume, in GiBs.
SnapshotId (string) --
The snapshot from which the volume was created, if applicable.
AvailabilityZone (string) --
The Availability Zone for the volume.
State (string) --
The volume state.
CreateTime (datetime) --
The time stamp when volume creation was initiated.
Attachments (list) --
Information about the volume attachments.
(dict) --
Describes volume attachment details.
DeleteOnTermination (boolean) --
Indicates whether the EBS volume is deleted on instance termination.
AssociatedResource (string) --
The ARN of the Amazon Web Services-managed resource to which the volume is attached.
InstanceOwningService (string) --
The service principal of the Amazon Web Services service that owns the underlying resource to which the volume is attached.
This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources.
VolumeId (string) --
The ID of the volume.
InstanceId (string) --
The ID of the instance.
If the volume is attached to an Amazon Web Services-managed resource, this parameter returns null.
Device (string) --
The device name.
If the volume is attached to an Amazon Web Services-managed resource, this parameter returns null.
State (string) --
The attachment state of the volume.
AttachTime (datetime) --
The time stamp when the attachment initiated.
Encrypted (boolean) --
Indicates whether the volume is encrypted.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
{'ServiceConfigurations': {'AvailabilityZoneIds': ['string']}}
Describes the VPC endpoint service configurations in your account (your services).
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoint_service_configurations(
DryRun=True|False,
ServiceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The IDs of the endpoint services.
(string) --
list
The filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service ( Pending | Available | Deleting | Deleted | Failed).
supported-ip-address-types - The IP address type ( ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return 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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
string
The token to retrieve the next page of results.
dict
Response Syntax
{
'ServiceConfigurations': [
{
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
},
],
'ServiceId': 'string',
'ServiceName': 'string',
'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
'AvailabilityZoneIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'NetworkLoadBalancerArns': [
'string',
],
'GatewayLoadBalancerArns': [
'string',
],
'SupportedIpAddressTypes': [
'ipv4'|'ipv6',
],
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'PrivateDnsNameConfiguration': {
'State': 'pendingVerification'|'verified'|'failed',
'Type': 'string',
'Value': 'string',
'Name': 'string'
},
'PayerResponsibility': 'ServiceOwner',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportedRegions': [
{
'Region': 'string',
'ServiceState': 'string'
},
],
'RemoteAccessEnabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServiceConfigurations (list) --
Information about the 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.
AvailabilityZoneIds (list) --
The IDs of the Availability Zones in which the service is available.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
(string) --
AvailabilityZones (list) --
The Availability Zones in which the service is available.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
(string) --
AcceptanceRequired (boolean) --
Indicates whether requests from other Amazon Web Services 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.
(string) --
GatewayLoadBalancerArns (list) --
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
(string) --
SupportedIpAddressTypes (list) --
The supported IP address types.
(string) --
BaseEndpointDnsNames (list) --
The DNS names for the service.
(string) --
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.
PayerResponsibility (string) --
The payer responsibility.
Tags (list) --
The 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 256 Unicode characters.
SupportedRegions (list) --
The supported Regions.
(dict) --
Describes a supported Region.
Region (string) --
The Region code.
ServiceState (string) --
The service state. The possible values are Pending, Available, Deleting, Deleted, Failed, and Closed.
RemoteAccessEnabled (boolean) --
Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.
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.
{'ServiceDetails': {'AvailabilityZoneIds': ['string']}}
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
client.describe_vpc_endpoint_services(
DryRun=True|False,
ServiceNames=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
ServiceRegions=[
'string',
]
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The service names.
(string) --
list
The filters.
owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name of the service.
service-region - The Region of the service.
service-type - The type of service ( Interface | Gateway | GatewayLoadBalancer).
supported-ip-address-types - The IP address type ( ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of 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.
string
The token for the next set of items to return. (You received this token from a prior call.)
list
The service Regions.
(string) --
dict
Response Syntax
{
'ServiceNames': [
'string',
],
'ServiceDetails': [
{
'ServiceName': 'string',
'ServiceId': 'string',
'ServiceType': [
{
'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer'
},
],
'ServiceRegion': 'string',
'AvailabilityZoneIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'Owner': 'string',
'BaseEndpointDnsNames': [
'string',
],
'PrivateDnsName': 'string',
'PrivateDnsNames': [
{
'PrivateDnsName': 'string'
},
],
'VpcEndpointPolicySupported': True|False,
'AcceptanceRequired': True|False,
'ManagesVpcEndpoints': True|False,
'PayerResponsibility': 'ServiceOwner',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PrivateDnsNameVerificationState': 'pendingVerification'|'verified'|'failed',
'SupportedIpAddressTypes': [
'ipv4'|'ipv6',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServiceNames (list) --
The supported services.
(string) --
ServiceDetails (list) --
Information about the service.
(dict) --
Describes a VPC endpoint service.
ServiceName (string) --
The name 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.
ServiceRegion (string) --
The Region where the service is hosted.
AvailabilityZoneIds (list) --
The IDs of the Availability Zones in which the service is available.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
(string) --
AvailabilityZones (list) --
The Availability Zones in which the service is available.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
(string) --
Owner (string) --
The Amazon Web Services account ID of the service owner.
BaseEndpointDnsNames (list) --
The DNS names for the service.
(string) --
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.
PayerResponsibility (string) --
The payer responsibility.
Tags (list) --
The 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 256 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.
SupportedIpAddressTypes (list) --
The supported IP address types.
(string) --
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.
{'LaunchTemplateData': {'Placement': {'AvailabilityZoneId': 'string'}}}
{'LaunchSpecification': {'Placement': {'AvailabilityZoneId': 'string'}}}
Response {'ConversionTask': {'ImportInstance': {'Volumes': {'AvailabilityZoneId': 'string'}},
'ImportVolume': {'AvailabilityZoneId': 'string'}}}
{'AvailabilityZoneId': 'string'}
Response {'ConversionTask': {'ImportInstance': {'Volumes': {'AvailabilityZoneId': 'string'}},
'ImportVolume': {'AvailabilityZoneId': 'string'}}}
Creates an import volume task using metadata from the specified disk image.
For information about the import manifest referenced by this API action, see VM Import Manifest.
This API action is not supported by the Command Line Interface (CLI).
See also: AWS API Documentation
Request Syntax
client.import_volume(
AvailabilityZoneId='string',
DryRun=True|False,
AvailabilityZone='string',
Image={
'Format': 'VMDK'|'RAW'|'VHD',
'Bytes': 123,
'ImportManifestUrl': 'string'
},
Description='string',
Volume={
'Size': 123
}
)
string
The ID of the Availability Zone for the resulting EBS volume.
Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
The Availability Zone for the resulting EBS volume.
Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.
dict
[REQUIRED]
The disk image.
Format (string) -- [REQUIRED]
The disk image format.
Bytes (integer) -- [REQUIRED]
The size of the disk image, in GiB.
ImportManifestUrl (string) -- [REQUIRED]
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.
string
A description of the volume.
dict
[REQUIRED]
The volume size.
Size (integer) -- [REQUIRED]
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',
'AvailabilityZoneId': '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',
'AvailabilityZoneId': '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.
AvailabilityZoneId (string) --
The ID of 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.
AvailabilityZoneId (string) --
The ID of 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 256 Unicode characters.
{'LaunchTemplateConfigs': {'Overrides': {'Placement': {'AvailabilityZoneId': 'string'}}}}
{'SpotInstanceRequests': {'LaunchedAvailabilityZoneId': 'string'}}
{'Placement': {'AvailabilityZoneId': 'string'}}
Response {'Instances': {'Placement': {'AvailabilityZoneId': 'string'}}}