2026/04/22 - Amazon Elastic Compute Cloud - 2 new23 updated api methods
Changes Managed resource visibility settings control whether resources that AWS services provision on your behalf within your AWS account appear in your Amazon console views and API list operations.
Modifies the managed resource visibility configuration for the account. Use this operation to control whether managed resources are hidden or visible by default. Visibility settings are account-wide and affect all IAM principals uniformly. Hidden resources remain fully operational and billable.
See also: AWS API Documentation
Request Syntax
client.modify_managed_resource_visibility(
DryRun=True|False,
DefaultVisibility='hidden'|'visible'
)
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.
string
The default visibility setting for managed resources. Valid values: hidden | visible.
dict
Response Syntax
{
'Visibility': {
'DefaultVisibility': 'hidden'|'visible'
}
}
Response Structure
(dict) --
Visibility (dict) --
The updated managed resource visibility settings for the account.
DefaultVisibility (string) --
The default visibility setting for managed resources. A value of hidden indicates that managed resources are not included in Describe operation responses by default. A value of visible indicates that managed resources are included by default.
Retrieves the managed resource visibility configuration for the account. The response indicates whether managed resources are hidden or visible by default.
See also: AWS API Documentation
Request Syntax
client.get_managed_resource_visibility(
DryRun=True|False
)
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.
dict
Response Syntax
{
'Visibility': {
'DefaultVisibility': 'hidden'|'visible'
}
}
Response Structure
(dict) --
Visibility (dict) --
The managed resource visibility settings for the account.
DefaultVisibility (string) --
The default visibility setting for managed resources. A value of hidden indicates that managed resources are not included in Describe operation responses by default. A value of visible indicates that managed resources are included by default.
{'Volumes': {'Operator': {'HiddenByDefault': 'boolean'}}}
Creates a crash-consistent, point-in-time copy of an existing Amazon EBS volume within the same Availability Zone. The volume copy can be attached to an Amazon EC2 instance once it reaches the available state. For more information, see Copy an Amazon EBS volume.
See also: AWS API Documentation
Request Syntax
client.copy_volumes(
SourceVolumeId='string',
Iops=123,
Size=123,
VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
DryRun=True|False,
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'|'image-usage-report'|'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-metering-policy'|'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'|'vpc-encryption-control'|'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'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiAttachEnabled=True|False,
Throughput=123,
ClientToken='string'
)
string
[REQUIRED]
The ID of the source EBS volume to copy.
integer
The number of I/O operations per second (IOPS) to provision for the volume copy. Required for io1 and io2 volumes. Optional for gp3 volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.
Valid ranges:
gp3: 3,000 ``(*default*) `` - 80,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
integer
The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.
Maximum supported sizes:
gp2: 16,384 GiB
gp3: 65,536 GiB
io1: 16,384 GiB
io2: 65,536 GiB
st1 and sc1: 16,384 GiB
standard: 1024 GiB
string
The volume type for the volume copy. If not specified, the volume type defaults to gp2.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The tags to apply to the volume copy 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 for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. Supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach.
integer
The throughput to provision for the volume copy, in MiB/s. Supported for gp3 volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.
Valid Range: 125 - 2000 MiB/s
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.
dict
Response Syntax
{
'Volumes': [
{
'AvailabilityZoneId': 'string',
'OutpostArn': 'string',
'SourceVolumeId': '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',
'HiddenByDefault': True|False
},
'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',
'EbsCardIndex': 123,
'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) --
Volumes (list) --
Information about the volume copy.
(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.
SourceVolumeId (string) --
The ID of the source volume from which the volume copy was created. Only for volume copies.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
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.
EbsCardIndex (integer) --
The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.
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.
{'LaunchTemplate': {'Operator': {'HiddenByDefault': 'boolean'}}}
{'LaunchTemplateVersion': {'LaunchTemplateData': {'Operator': {'HiddenByDefault': 'boolean'}},
'Operator': {'HiddenByDefault': 'boolean'}}}
{'NetworkInterface': {'Operator': {'HiddenByDefault': 'boolean'}}}
Creates a network interface in the specified subnet.
The number of IP addresses you can assign to a network interface varies by instance type.
For more information about network interfaces, see Elastic network interfaces in the Amazon EC2 User Guide.
See also: AWS API Documentation
Request Syntax
client.create_network_interface(
Ipv4Prefixes=[
{
'Ipv4Prefix': 'string'
},
],
Ipv4PrefixCount=123,
Ipv6Prefixes=[
{
'Ipv6Prefix': 'string'
},
],
Ipv6PrefixCount=123,
InterfaceType='efa'|'efa-only'|'branch'|'trunk',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'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-metering-policy'|'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'|'vpc-encryption-control'|'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'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string',
EnablePrimaryIpv6=True|False,
ConnectionTrackingSpecification={
'TcpEstablishedTimeout': 123,
'UdpStreamTimeout': 123,
'UdpTimeout': 123
},
Operator={
'Principal': 'string'
},
SubnetId='string',
Description='string',
PrivateIpAddress='string',
Groups=[
'string',
],
PrivateIpAddresses=[
{
'Primary': True|False,
'PrivateIpAddress': 'string'
},
],
SecondaryPrivateIpAddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string',
'IsPrimaryIpv6': True|False
},
],
Ipv6AddressCount=123,
DryRun=True|False
)
list
The IPv4 prefixes assigned to the network interface.
You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
(dict) --
Describes the IPv4 prefix option for a network interface.
Ipv4Prefix (string) --
The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
integer
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
list
The IPv6 prefixes assigned to the network interface.
You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
(dict) --
Describes the IPv6 prefix option for a network interface.
Ipv6Prefix (string) --
The IPv6 prefix.
integer
The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.
You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
string
The type of network interface. The default is interface.
If you specify efa-only, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.
The only supported values are interface, efa, efa-only, and trunk.
list
The tags to apply to the new network interface.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
boolean
If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
dict
A connection tracking specification for the network interface.
TcpEstablishedTimeout (integer) --
Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
UdpStreamTimeout (integer) --
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
UdpTimeout (integer) --
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
dict
Reserved for internal use.
Principal (string) --
The service provider that manages the resource.
string
[REQUIRED]
The ID of the subnet to associate with the network interface.
string
A description for the network interface.
string
The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
list
The IDs of the security groups.
(string) --
list
The private IPv4 addresses.
You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
(dict) --
Describes a secondary private IPv4 address for a network interface.
Primary (boolean) --
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress (string) --
The private IPv4 address.
integer
The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
list
The IPv6 addresses from the IPv6 CIDR block range of your subnet.
You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
IsPrimaryIpv6 (boolean) --
Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.
integer
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.
You can't specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.
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
{
'NetworkInterface': {
'Association': {
'AllocationId': 'string',
'AssociationId': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string',
'CustomerOwnedIp': 'string',
'CarrierIp': 'string'
},
'Attachment': {
'AttachTime': datetime(2015, 1, 1),
'AttachmentId': 'string',
'DeleteOnTermination': True|False,
'DeviceIndex': 123,
'NetworkCardIndex': 123,
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'Status': 'attaching'|'attached'|'detaching'|'detached',
'EnaSrdSpecification': {
'EnaSrdEnabled': True|False,
'EnaSrdUdpSpecification': {
'EnaSrdUdpEnabled': True|False
}
},
'EnaQueueCount': 123
},
'AvailabilityZone': 'string',
'ConnectionTrackingConfiguration': {
'TcpEstablishedTimeout': 123,
'UdpStreamTimeout': 123,
'UdpTimeout': 123
},
'Description': 'string',
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa'|'efa-only'|'trunk'|'load_balancer'|'network_load_balancer'|'vpc_endpoint'|'branch'|'transit_gateway'|'lambda'|'quicksight'|'global_accelerator_managed'|'api_gateway_managed'|'gateway_load_balancer'|'gateway_load_balancer_endpoint'|'iot_rules_managed'|'aws_codestar_connections_managed',
'Ipv6Addresses': [
{
'Ipv6Address': 'string',
'PublicIpv6DnsName': 'string',
'IsPrimaryIpv6': True|False
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'PrivateDnsName': 'string',
'PublicDnsName': 'string',
'PublicIpDnsNameOptions': {
'DnsHostnameType': 'string',
'PublicIpv4DnsName': 'string',
'PublicIpv6DnsName': 'string',
'PublicDualStackDnsName': 'string'
},
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Association': {
'AllocationId': 'string',
'AssociationId': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string',
'CustomerOwnedIp': 'string',
'CarrierIp': 'string'
},
'Primary': True|False,
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string'
},
],
'Ipv4Prefixes': [
{
'Ipv4Prefix': 'string'
},
],
'Ipv6Prefixes': [
{
'Ipv6Prefix': 'string'
},
],
'RequesterId': 'string',
'RequesterManaged': True|False,
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'TagSet': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string',
'DenyAllIgwTraffic': True|False,
'Ipv6Native': True|False,
'Ipv6Address': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
},
'AssociatedSubnets': [
'string',
],
'AvailabilityZoneId': 'string'
},
'ClientToken': 'string'
}
Response Structure
(dict) --
NetworkInterface (dict) --
Information about the network interface.
Association (dict) --
The association information for an Elastic IP address (IPv4) associated with the network interface.
AllocationId (string) --
The allocation ID.
AssociationId (string) --
The association ID.
IpOwnerId (string) --
The ID of the Elastic IP address owner.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The address of the Elastic IP address bound to the network interface.
CustomerOwnedIp (string) --
The customer-owned IP address associated with the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
Attachment (dict) --
The network interface attachment.
AttachTime (datetime) --
The timestamp indicating when the attachment initiated.
AttachmentId (string) --
The ID of the network interface attachment.
DeleteOnTermination (boolean) --
Indicates whether the network interface is deleted when the instance is terminated.
DeviceIndex (integer) --
The device index of the network interface attachment on the instance.
NetworkCardIndex (integer) --
The index of the network card.
InstanceId (string) --
The ID of the instance.
InstanceOwnerId (string) --
The Amazon Web Services account ID of the owner of the instance.
Status (string) --
The attachment state.
EnaSrdSpecification (dict) --
Configures ENA Express for the network interface that this action attaches to the instance.
EnaSrdEnabled (boolean) --
Indicates whether ENA Express is enabled for the network interface.
EnaSrdUdpSpecification (dict) --
Configures ENA Express for UDP network traffic.
EnaSrdUdpEnabled (boolean) --
Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
EnaQueueCount (integer) --
The number of ENA queues created with the instance.
AvailabilityZone (string) --
The Availability Zone.
ConnectionTrackingConfiguration (dict) --
A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
TcpEstablishedTimeout (integer) --
Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
UdpStreamTimeout (integer) --
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
UdpTimeout (integer) --
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
Description (string) --
A description.
Groups (list) --
Any security groups for the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
InterfaceType (string) --
The type of network interface.
Ipv6Addresses (list) --
The IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address associated with a network interface.
Ipv6Address (string) --
The IPv6 address.
PublicIpv6DnsName (string) --
An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
IsPrimaryIpv6 (boolean) --
Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the network interface.
PrivateDnsName (string) --
The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
PublicDnsName (string) --
A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
PublicIpDnsNameOptions (dict) --
Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
DnsHostnameType (string) --
The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
PublicIpv4DnsName (string) --
An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
PublicIpv6DnsName (string) --
An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.
PublicDualStackDnsName (string) --
A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
PrivateIpAddresses (list) --
The private IPv4 addresses associated with the network interface.
(dict) --
Describes the private IPv4 address of a network interface.
Association (dict) --
The association information for an Elastic IP address (IPv4) associated with the network interface.
AllocationId (string) --
The allocation ID.
AssociationId (string) --
The association ID.
IpOwnerId (string) --
The ID of the Elastic IP address owner.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The address of the Elastic IP address bound to the network interface.
CustomerOwnedIp (string) --
The customer-owned IP address associated with the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
Primary (boolean) --
Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
PrivateDnsName (string) --
The private DNS name.
PrivateIpAddress (string) --
The private IPv4 address.
Ipv4Prefixes (list) --
The IPv4 prefixes that are assigned to the network interface.
(dict) --
Describes an IPv4 prefix.
Ipv4Prefix (string) --
The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
Ipv6Prefixes (list) --
The IPv6 prefixes that are assigned to the network interface.
(dict) --
Describes the IPv6 prefix.
Ipv6Prefix (string) --
The IPv6 prefix.
RequesterId (string) --
The alias or Amazon Web Services account ID of the principal or service that created the network interface.
RequesterManaged (boolean) --
Indicates whether the network interface is being managed by Amazon Web Services.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
Status (string) --
The status of the network interface.
SubnetId (string) --
The ID of the subnet.
TagSet (list) --
Any tags assigned to the network interface.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VpcId (string) --
The ID of the VPC.
DenyAllIgwTraffic (boolean) --
Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.
Ipv6Native (boolean) --
Indicates whether this is an IPv6 only network interface.
Ipv6Address (string) --
The IPv6 globally unique address associated with the network interface.
Operator (dict) --
The service provider that manages the network interface.
Managed (boolean) --
If true, the resource is managed by a service provider.
Principal (string) --
If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
AssociatedSubnets (list) --
The subnets associated with this network interface.
(string) --
AvailabilityZoneId (string) --
The ID of the Availability Zone.
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.
{'PlacementGroup': {'Operator': {'HiddenByDefault': 'boolean'}}}
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
client.create_placement_group(
PartitionCount=123,
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'|'image-usage-report'|'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-metering-policy'|'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'|'vpc-encryption-control'|'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'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
SpreadLevel='host'|'rack',
LinkedGroupId='string',
Operator={
'Principal': 'string'
},
DryRun=True|False,
GroupName='string',
Strategy='cluster'|'spread'|'partition'
)
integer
The number of partitions. Valid only when Strategy is set to partition.
list
The tags to apply to the new placement group.
(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.
string
Determines how placement groups spread instances.
Host – You can use host only with Outpost placement groups.
Rack – No usage restrictions.
string
Reserved for future use.
dict
Reserved for internal use.
Principal (string) --
The service provider that manages the resource.
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.
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
string
The placement strategy.
dict
Response Syntax
{
'PlacementGroup': {
'GroupName': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Strategy': 'cluster'|'spread'|'partition',
'PartitionCount': 123,
'GroupId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'GroupArn': 'string',
'SpreadLevel': 'host'|'rack',
'LinkedGroupId': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
}
}
}
Response Structure
(dict) --
PlacementGroup (dict) --
Information about the 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 256 Unicode characters.
GroupArn (string) --
The Amazon Resource Name (ARN) of the placement group.
SpreadLevel (string) --
The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
LinkedGroupId (string) --
Reserved for future use.
Operator (dict) --
The service provider that manages the Placement Group.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
{'Operator': {'HiddenByDefault': 'boolean'}}
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'|'image-usage-report'|'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-metering-policy'|'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'|'vpc-encryption-control'|'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'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
'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) to provision for the volume. Required for io1 and io2 volumes. Optional for gp3 volumes. Omit for all other volume types.
Valid ranges:
gp3: 3,000 ``(*default*) `` - 80,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
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, and you can specify a volume size that is equal to or larger than the snapshot size.
Valid sizes:
gp2: 1 - 16,384 GiB
gp3: 1 - 65,536 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 the volume, in MiB/s. Supported for gp3 volumes only. Omit for all other volume types.
Valid Range: 125 - 2000 MiB/s
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',
'SourceVolumeId': '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',
'HiddenByDefault': True|False
},
'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',
'EbsCardIndex': 123,
'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.
SourceVolumeId (string) --
The ID of the source volume from which the volume copy was created. Only for volume copies.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
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.
EbsCardIndex (integer) --
The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.
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.
{'LaunchTemplate': {'Operator': {'HiddenByDefault': 'boolean'}}}
Deletes a launch template. Deleting a launch template deletes all of its versions.
See also: AWS API Documentation
Request Syntax
client.delete_launch_template(
DryRun=True|False,
LaunchTemplateId='string',
LaunchTemplateName='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.
string
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
string
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
dict
Response Syntax
{
'LaunchTemplate': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersionNumber': 123,
'LatestVersionNumber': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
}
}
}
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 256 Unicode characters.
Operator (dict) --
The entity that manages the launch template.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
{'BlockDeviceMappings': {'Ebs': {'Operator': {'HiddenByDefault': 'boolean'}}}}
Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Available attributes include SQL license exemption configuration for instances registered with the SQL LE service.
See also: AWS API Documentation
Request Syntax
client.describe_instance_attribute(
DryRun=True|False,
InstanceId='string',
Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions'|'disableApiStop'
)
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.
string
[REQUIRED]
The ID of the instance.
string
[REQUIRED]
The instance attribute.
Note that the enaSupport attribute is not supported.
dict
Response Syntax
{
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'Ebs': {
'AttachTime': datetime(2015, 1, 1),
'DeleteOnTermination': True|False,
'Status': 'attaching'|'attached'|'detaching'|'detached',
'VolumeId': 'string',
'AssociatedResource': 'string',
'VolumeOwnerId': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
},
'EbsCardIndex': 123
}
},
],
'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'
},
'DisableApiStop': {
'Value': True|False
},
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
]
}
Response Structure
(dict) --
Describes an instance attribute.
BlockDeviceMappings (list) --
The block device mapping of the instance.
(dict) --
Describes a block device mapping.
DeviceName (string) --
The device name.
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.
AssociatedResource (string) --
The ARN of the Amazon Web Services-managed resource to which the volume is attached.
VolumeOwnerId (string) --
The ID of the Amazon Web Services account that owns the volume.
This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources.
Operator (dict) --
The service provider that manages the EBS 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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
EbsCardIndex (integer) --
The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.
DisableApiTermination (dict) --
Indicates whether termination protection is enabled. If the value is true, you can't terminate the instance using the Amazon EC2 console, command line tools, or API.
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) --
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.
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) --
The 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) --
Indicates whether source/destination checks are enabled.
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.
DisableApiStop (dict) --
Indicates whether stop protection is enabled for the instance.
Value (boolean) --
The attribute value. The valid values are true or false.
Groups (list) --
The security groups associated with the instance.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
{'InstanceImageMetadata': {'Operator': {'HiddenByDefault': 'boolean'}}}
{'IncludeManagedResources': 'boolean'}
Response {'InstanceStatuses': {'Operator': {'HiddenByDefault': 'boolean'}}}
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',
IncludeManagedResources=True|False,
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
Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
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',
'HiddenByDefault': True|False
},
'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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
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.
{'IncludeManagedResources': 'boolean'}
Response {'Reservations': {'Instances': {'BlockDeviceMappings': {'Ebs': {'Operator': {'HiddenByDefault': 'boolean'}}},
'NetworkInterfaces': {'Operator': {'HiddenByDefault': 'boolean'}},
'Operator': {'HiddenByDefault': 'boolean'}}}}
{'IncludeManagedResources': 'boolean'}
Response {'LaunchTemplateVersions': {'LaunchTemplateData': {'Operator': {'HiddenByDefault': 'boolean'}},
'Operator': {'HiddenByDefault': 'boolean'}}}
{'IncludeManagedResources': 'boolean'}
Response {'LaunchTemplates': {'Operator': {'HiddenByDefault': 'boolean'}}}
Describes one or more launch templates.
See also: AWS API Documentation
Request Syntax
client.describe_launch_templates(
DryRun=True|False,
LaunchTemplateIds=[
'string',
],
LaunchTemplateNames=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123,
IncludeManagedResources=True|False
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
One or more launch template IDs.
(string) --
list
One or more launch template names.
(string) --
list
One or more filters.
create-time - The time the launch template was created.
launch-template-name - The name of the launch template.
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) --
string
The token to request the next page of results.
integer
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.
boolean
Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
dict
Response Syntax
{
'LaunchTemplates': [
{
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersionNumber': 123,
'LatestVersionNumber': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
}
},
],
'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 256 Unicode characters.
Operator (dict) --
The entity that manages the launch template.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
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.
{'IncludeManagedResources': 'boolean'}
Response {'NetworkInterfaces': {'Operator': {'HiddenByDefault': 'boolean'}}}
Describes the specified network interfaces or all your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, subnet-id, or vpc-id.
See also: AWS API Documentation
Request Syntax
client.describe_network_interfaces(
NextToken='string',
MaxResults=123,
IncludeManagedResources=True|False,
DryRun=True|False,
NetworkInterfaceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'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. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.
boolean
Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The network interface IDs.
Default: Describes all your network interfaces.
(string) --
list
One or more filters.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.attachment-id - The ID of the interface attachment.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment ( attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
availability-zone-id - The ID of the Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface ( api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efa-only | efs | evs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
operator.managed - A Boolean that indicates whether this is a managed network interface.
operator.principal - The principal that manages the network interface. Only valid for managed network interfaces, where managed is true.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-dns-name - The private DNS name of the network interface (IPv4).
private-ip-address - The private IPv4 address or addresses of the network interface.
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
dict
Response Syntax
{
'NetworkInterfaces': [
{
'Association': {
'AllocationId': 'string',
'AssociationId': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string',
'CustomerOwnedIp': 'string',
'CarrierIp': 'string'
},
'Attachment': {
'AttachTime': datetime(2015, 1, 1),
'AttachmentId': 'string',
'DeleteOnTermination': True|False,
'DeviceIndex': 123,
'NetworkCardIndex': 123,
'InstanceId': 'string',
'InstanceOwnerId': 'string',
'Status': 'attaching'|'attached'|'detaching'|'detached',
'EnaSrdSpecification': {
'EnaSrdEnabled': True|False,
'EnaSrdUdpSpecification': {
'EnaSrdUdpEnabled': True|False
}
},
'EnaQueueCount': 123
},
'AvailabilityZone': 'string',
'ConnectionTrackingConfiguration': {
'TcpEstablishedTimeout': 123,
'UdpStreamTimeout': 123,
'UdpTimeout': 123
},
'Description': 'string',
'Groups': [
{
'GroupId': 'string',
'GroupName': 'string'
},
],
'InterfaceType': 'interface'|'natGateway'|'efa'|'efa-only'|'trunk'|'load_balancer'|'network_load_balancer'|'vpc_endpoint'|'branch'|'transit_gateway'|'lambda'|'quicksight'|'global_accelerator_managed'|'api_gateway_managed'|'gateway_load_balancer'|'gateway_load_balancer_endpoint'|'iot_rules_managed'|'aws_codestar_connections_managed',
'Ipv6Addresses': [
{
'Ipv6Address': 'string',
'PublicIpv6DnsName': 'string',
'IsPrimaryIpv6': True|False
},
],
'MacAddress': 'string',
'NetworkInterfaceId': 'string',
'OutpostArn': 'string',
'OwnerId': 'string',
'PrivateDnsName': 'string',
'PublicDnsName': 'string',
'PublicIpDnsNameOptions': {
'DnsHostnameType': 'string',
'PublicIpv4DnsName': 'string',
'PublicIpv6DnsName': 'string',
'PublicDualStackDnsName': 'string'
},
'PrivateIpAddress': 'string',
'PrivateIpAddresses': [
{
'Association': {
'AllocationId': 'string',
'AssociationId': 'string',
'IpOwnerId': 'string',
'PublicDnsName': 'string',
'PublicIp': 'string',
'CustomerOwnedIp': 'string',
'CarrierIp': 'string'
},
'Primary': True|False,
'PrivateDnsName': 'string',
'PrivateIpAddress': 'string'
},
],
'Ipv4Prefixes': [
{
'Ipv4Prefix': 'string'
},
],
'Ipv6Prefixes': [
{
'Ipv6Prefix': 'string'
},
],
'RequesterId': 'string',
'RequesterManaged': True|False,
'SourceDestCheck': True|False,
'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
'SubnetId': 'string',
'TagSet': [
{
'Key': 'string',
'Value': 'string'
},
],
'VpcId': 'string',
'DenyAllIgwTraffic': True|False,
'Ipv6Native': True|False,
'Ipv6Address': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
},
'AssociatedSubnets': [
'string',
],
'AvailabilityZoneId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NetworkInterfaces (list) --
Information about the network interfaces.
(dict) --
Describes a network interface.
Association (dict) --
The association information for an Elastic IP address (IPv4) associated with the network interface.
AllocationId (string) --
The allocation ID.
AssociationId (string) --
The association ID.
IpOwnerId (string) --
The ID of the Elastic IP address owner.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The address of the Elastic IP address bound to the network interface.
CustomerOwnedIp (string) --
The customer-owned IP address associated with the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
Attachment (dict) --
The network interface attachment.
AttachTime (datetime) --
The timestamp indicating when the attachment initiated.
AttachmentId (string) --
The ID of the network interface attachment.
DeleteOnTermination (boolean) --
Indicates whether the network interface is deleted when the instance is terminated.
DeviceIndex (integer) --
The device index of the network interface attachment on the instance.
NetworkCardIndex (integer) --
The index of the network card.
InstanceId (string) --
The ID of the instance.
InstanceOwnerId (string) --
The Amazon Web Services account ID of the owner of the instance.
Status (string) --
The attachment state.
EnaSrdSpecification (dict) --
Configures ENA Express for the network interface that this action attaches to the instance.
EnaSrdEnabled (boolean) --
Indicates whether ENA Express is enabled for the network interface.
EnaSrdUdpSpecification (dict) --
Configures ENA Express for UDP network traffic.
EnaSrdUdpEnabled (boolean) --
Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
EnaQueueCount (integer) --
The number of ENA queues created with the instance.
AvailabilityZone (string) --
The Availability Zone.
ConnectionTrackingConfiguration (dict) --
A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
TcpEstablishedTimeout (integer) --
Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
UdpStreamTimeout (integer) --
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
UdpTimeout (integer) --
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
Description (string) --
A description.
Groups (list) --
Any security groups for the network interface.
(dict) --
Describes a security group.
GroupId (string) --
The ID of the security group.
GroupName (string) --
The name of the security group.
InterfaceType (string) --
The type of network interface.
Ipv6Addresses (list) --
The IPv6 addresses associated with the network interface.
(dict) --
Describes an IPv6 address associated with a network interface.
Ipv6Address (string) --
The IPv6 address.
PublicIpv6DnsName (string) --
An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
IsPrimaryIpv6 (boolean) --
Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
MacAddress (string) --
The MAC address.
NetworkInterfaceId (string) --
The ID of the network interface.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the network interface.
PrivateDnsName (string) --
The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
PublicDnsName (string) --
A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
PublicIpDnsNameOptions (dict) --
Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
DnsHostnameType (string) --
The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
PublicIpv4DnsName (string) --
An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
PublicIpv6DnsName (string) --
An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.
PublicDualStackDnsName (string) --
A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
PrivateIpAddresses (list) --
The private IPv4 addresses associated with the network interface.
(dict) --
Describes the private IPv4 address of a network interface.
Association (dict) --
The association information for an Elastic IP address (IPv4) associated with the network interface.
AllocationId (string) --
The allocation ID.
AssociationId (string) --
The association ID.
IpOwnerId (string) --
The ID of the Elastic IP address owner.
PublicDnsName (string) --
The public DNS name.
PublicIp (string) --
The address of the Elastic IP address bound to the network interface.
CustomerOwnedIp (string) --
The customer-owned IP address associated with the network interface.
CarrierIp (string) --
The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
Primary (boolean) --
Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
PrivateDnsName (string) --
The private DNS name.
PrivateIpAddress (string) --
The private IPv4 address.
Ipv4Prefixes (list) --
The IPv4 prefixes that are assigned to the network interface.
(dict) --
Describes an IPv4 prefix.
Ipv4Prefix (string) --
The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
Ipv6Prefixes (list) --
The IPv6 prefixes that are assigned to the network interface.
(dict) --
Describes the IPv6 prefix.
Ipv6Prefix (string) --
The IPv6 prefix.
RequesterId (string) --
The alias or Amazon Web Services account ID of the principal or service that created the network interface.
RequesterManaged (boolean) --
Indicates whether the network interface is being managed by Amazon Web Services.
SourceDestCheck (boolean) --
Indicates whether source/destination checking is enabled.
Status (string) --
The status of the network interface.
SubnetId (string) --
The ID of the subnet.
TagSet (list) --
Any tags assigned to the network interface.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
VpcId (string) --
The ID of the VPC.
DenyAllIgwTraffic (boolean) --
Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.
Ipv6Native (boolean) --
Indicates whether this is an IPv6 only network interface.
Ipv6Address (string) --
The IPv6 globally unique address associated with the network interface.
Operator (dict) --
The service provider that manages the network interface.
Managed (boolean) --
If true, the resource is managed by a service provider.
Principal (string) --
If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
AssociatedSubnets (list) --
The subnets associated with this network interface.
(string) --
AvailabilityZoneId (string) --
The ID of the Availability Zone.
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.
{'PlacementGroups': {'Operator': {'HiddenByDefault': 'boolean'}}}
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
client.describe_placement_groups(
GroupIds=[
'string',
],
DryRun=True|False,
GroupNames=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
list
The IDs of the placement groups.
(string) --
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 names of the placement groups.
Constraints:
You can specify a name only if the placement group is owned by your account.
If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.
(string) --
list
The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group ( host | rack).
state - The state of the placement group ( pending | available | deleting | deleted).
strategy - The strategy of the placement group ( cluster | spread | partition).
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 that have 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) --
dict
Response Syntax
{
'PlacementGroups': [
{
'GroupName': 'string',
'State': 'pending'|'available'|'deleting'|'deleted',
'Strategy': 'cluster'|'spread'|'partition',
'PartitionCount': 123,
'GroupId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'GroupArn': 'string',
'SpreadLevel': 'host'|'rack',
'LinkedGroupId': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
}
},
]
}
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 256 Unicode characters.
GroupArn (string) --
The Amazon Resource Name (ARN) of the placement group.
SpreadLevel (string) --
The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
LinkedGroupId (string) --
Reserved for future use.
Operator (dict) --
The service provider that manages the Placement Group.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
{'IncludeManagedResources': 'boolean'}
Response {'VolumeStatuses': {'Operator': {'HiddenByDefault': 'boolean',
'Managed': 'boolean',
'Principal': 'string'}}}
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 Monitor the status of your volumes in the Amazon EBS 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 and then check the volume for data consistency. For more information, see Work with an impaired EBS volume.
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
client.describe_volume_status(
MaxResults=123,
NextToken='string',
VolumeIds=[
'string',
],
IncludeManagedResources=True|False,
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'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.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
list
The IDs of the volumes.
Default: Describes all your volumes.
(string) --
boolean
Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
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.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status ( io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).
(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) --
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'|'initialization-state',
'Status': 'string'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'warning'
},
'AttachmentStatuses': [
{
'IoPerformance': 'string',
'InstanceId': 'string'
},
],
'InitializationStatusDetails': {
'InitializationType': 'default'|'provisioned-rate'|'volume-copy',
'Progress': 123,
'EstimatedTimeToCompleteInSeconds': 123
},
'AvailabilityZoneId': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
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.
io-enabled - Indicates the volume I/O status. For more information, see Amazon EBS volume status checks.
io-performance - Indicates the volume performance status. For more information, see Amazon EBS volume status checks.
initialization-state - Indicates the status of the volume initialization process. For more information, see Initialize Amazon EBS volumes.
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.
InitializationStatusDetails (dict) --
Information about the volume initialization. It can take up to 5 minutes for the volume initialization information to be updated.
Only available for volumes created from snapshots. Not available for empty volumes created without a snapshot.
For more information, see Initialize Amazon EBS volumes.
InitializationType (string) --
The method used for volume initialization. Possible values include:
default - Volume initialized using the default volume initialization rate or fast snapshot restore.
provisioned-rate - Volume initialized using an Amazon EBS Provisioned Rate for Volume Initialization.
volume-copy - Volume copy initialized at the rate for volume copies.
Progress (integer) --
The current volume initialization progress as a percentage (0-100). Returns 100 when volume initialization has completed.
EstimatedTimeToCompleteInSeconds (integer) --
The estimated remaining time, in seconds, for volume initialization to complete. Returns 0 when volume initialization has completed.
Only available for volumes created with Amazon EBS Provisioned Rate for Volume Initialization.
AvailabilityZoneId (string) --
The ID of the Availability Zone.
Operator (dict) --
The service provider that manages the resource.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
{'IncludeManagedResources': 'boolean'}
Response {'Volumes': {'Operator': {'HiddenByDefault': 'boolean'}}}
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',
],
IncludeManagedResources=True|False,
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
Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
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',
'SourceVolumeId': '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',
'HiddenByDefault': True|False
},
'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',
'EbsCardIndex': 123,
'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.
SourceVolumeId (string) --
The ID of the source volume from which the volume copy was created. Only for volume copies.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
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.
EbsCardIndex (integer) --
The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.
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.
{'VolumesModifications': {'Operator': {'HiddenByDefault': 'boolean',
'Managed': 'boolean',
'Principal': 'string'}}}
Describes the most recent volume modification request for the specified EBS volumes.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_volumes_modifications(
DryRun=True|False,
VolumeIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
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 volumes.
(string) --
list
The filters.
modification-state - The current modification state (modifying | optimizing | completed | failed).
original-iops - The original IOPS rate of the volume.
original-size - The original size of the volume, in GiB.
original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
start-time - The modification start time.
target-iops - The target IOPS rate of the volume.
target-size - The target size of the volume, in GiB.
target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
volume-id - The ID of the volume.
(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 results (up to a limit of 500) to be returned in a paginated request. For more information, see Pagination.
dict
Response Syntax
{
'NextToken': 'string',
'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),
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
VolumesModifications (list) --
Information about the volume modifications.
(dict) --
Describes the modification status of an EBS volume.
VolumeId (string) --
The ID of the volume.
ModificationState (string) --
The current modification state.
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.
Operator (dict) --
Describes whether the resource is managed by a service provider and, if so, describes the service provider that manages it.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
{'LaunchTemplateData': {'Operator': {'HiddenByDefault': 'boolean'}}}
{'Volumes': {'Operator': {'HiddenByDefault': 'boolean'}}}
Lists one or more volumes that are currently in the Recycle Bin.
See also: AWS API Documentation
Request Syntax
client.list_volumes_in_recycle_bin(
VolumeIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
list
The IDs of the volumes to list. Omit this parameter to list all of the volumes that are in the Recycle Bin.
(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.
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.
Valid range: 5 - 500
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'Volumes': [
{
'VolumeId': 'string',
'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
'Size': 123,
'Iops': 123,
'Throughput': 123,
'OutpostArn': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'SourceVolumeId': 'string',
'SnapshotId': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
},
'CreateTime': datetime(2015, 1, 1),
'RecycleBinEnterTime': datetime(2015, 1, 1),
'RecycleBinExitTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Volumes (list) --
Information about the volumes.
(dict) --
Information about a volume that is currently in the Recycle Bin.
VolumeId (string) --
The ID of the volume.
VolumeType (string) --
The volume type.
State (string) --
The state of the volume.
Size (integer) --
The size of the volume, in GiB.
Iops (integer) --
The number of I/O operations per second (IOPS) for the volume.
Throughput (integer) --
The throughput that the volume supports, in MiB/s.
OutpostArn (string) --
The ARN of the Outpost on which the volume is stored. For more information, see Amazon EBS volumes on Outposts in the Amazon EBS User Guide.
AvailabilityZone (string) --
The Availability Zone for the volume.
AvailabilityZoneId (string) --
The ID of the Availability Zone for the volume.
SourceVolumeId (string) --
The ID of the source volume.
SnapshotId (string) --
The snapshot from which the volume was created, if applicable.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
CreateTime (datetime) --
The time stamp when volume creation was initiated.
RecycleBinEnterTime (datetime) --
The date and time when the volume entered the Recycle Bin.
RecycleBinExitTime (datetime) --
The date and time when the volume is to be permanently deleted from the Recycle Bin.
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.
{'LaunchTemplate': {'Operator': {'HiddenByDefault': 'boolean'}}}
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
client.modify_launch_template(
DryRun=True|False,
ClientToken='string',
LaunchTemplateId='string',
LaunchTemplateName='string',
DefaultVersion='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.
string
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency.
For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
This field is autopopulated if not provided.
string
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
string
The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
string
The version number of the launch template to set as the default version.
dict
Response Syntax
{
'LaunchTemplate': {
'LaunchTemplateId': 'string',
'LaunchTemplateName': 'string',
'CreateTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'DefaultVersionNumber': 123,
'LatestVersionNumber': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
}
}
}
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 256 Unicode characters.
Operator (dict) --
The entity that manages the launch template.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
{'VolumeModification': {'Operator': {'HiddenByDefault': 'boolean',
'Managed': 'boolean',
'Principal': 'string'}}}
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 EBS volumes, see Amazon EBS Elastic Volumes in the Amazon EBS User Guide.
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 more information, see Extend the file system.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After you initiate a volume modification, you must wait for that modification to reach the completed state before you can initiate another modification for the same volume. You can modify a volume up to four times within a rolling 24-hour period, as long as the volume is in the in-use or available state, and all previous modifications for that volume are completed. If you exceed this limit, you get an error message that indicates when you can perform your next modification.
See also: AWS API Documentation
Request Syntax
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
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
string
[REQUIRED]
The ID of the volume.
integer
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:
gp2: 1 - 16,384 GiB
gp3: 1 - 65,536 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
Default: The existing size is retained.
string
The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
Default: The existing type is retained.
integer
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:
gp3: 3,000 - 80,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.
integer
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 2,000.
Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 2,000.
boolean
Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances 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.
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),
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
}
}
}
Response Structure
(dict) --
VolumeModification (dict) --
Information about the volume modification.
VolumeId (string) --
The ID of the volume.
ModificationState (string) --
The current modification state.
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.
Operator (dict) --
Describes whether the resource is managed by a service provider and, if so, describes the service provider that manages it.
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.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
{'Instances': {'BlockDeviceMappings': {'Ebs': {'Operator': {'HiddenByDefault': 'boolean'}}},
'NetworkInterfaces': {'Operator': {'HiddenByDefault': 'boolean'}},
'Operator': {'HiddenByDefault': 'boolean'}}}