SdkInternalList<T> reservedInstanceIds
The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
SdkInternalList<T> targetConfigurations
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
String exchangeId
The ID of the successful exchange.
String serviceId
The ID of the endpoint service.
SdkInternalList<T> vpcEndpointIds
The IDs of one or more interface VPC endpoints.
SdkInternalList<T> unsuccessful
Information about the interface endpoints that were not accepted, if applicable.
String vpcPeeringConnectionId
The ID of the VPC peering connection. You must specify this parameter in the request.
VpcPeeringConnection vpcPeeringConnection
Information about the VPC peering connection.
String attributeName
The name of the account attribute.
SdkInternalList<T> attributeValues
One or more values for the account attribute.
String attributeValue
The value of the attribute.
String instanceId
The ID of the instance.
String instanceType
The instance type.
String spotInstanceRequestId
The ID of the Spot Instance request.
String instanceHealth
The health status of the instance. If the status of either the instance status check or the system status check
is impaired
, the health status of the instance is unhealthy
. Otherwise, the health
status is healthy
.
String instanceId
The ID of the instance that the address is associated with (if any).
String publicIp
The Elastic IP address.
String allocationId
The ID representing the allocation of the address for use with EC2-VPC.
String associationId
The ID representing the association of the address with an instance in a VPC.
String domain
Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard
) or
instances in a VPC (vpc
).
String networkInterfaceId
The ID of the network interface.
String networkInterfaceOwnerId
The ID of the AWS account that owns the network interface.
String privateIpAddress
The private IP address associated with the Elastic IP address.
SdkInternalList<T> tags
Any tags assigned to the Elastic IP address.
String publicIpv4Pool
The ID of an address pool.
String cidr
The IPv4 address range, in CIDR notation.
ByoipCidr byoipCidr
Information about the address range.
String domain
Set to vpc
to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
String address
[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
String publicIpv4Pool
The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address
pool. To specify a specific address from the address pool, use the Address
parameter instead.
String publicIp
The Elastic IP address.
String allocationId
[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
String publicIpv4Pool
The ID of an address pool.
String domain
Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard
) or
instances in a VPC (vpc
).
String autoPlacement
This is enabled by default. This property allows instances to be automatically placed onto available Dedicated Hosts, when you are launching instances without specifying a host ID.
Default: Enabled
String availabilityZone
The Availability Zone for the Dedicated Hosts.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
String instanceType
Specify the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host.
Integer quantity
The number of Dedicated Hosts to allocate to your account with these parameters.
SdkInternalList<T> tagSpecifications
The tags to apply to the Dedicated Host during creation.
SdkInternalList<T> hostIds
The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
Integer ipv6AddressCount
The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
SdkInternalList<T> ipv6Addresses
One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> assignedIpv6Addresses
The IPv6 addresses assigned to the network interface.
String networkInterfaceId
The ID of the network interface.
Boolean allowReassignment
Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> privateIpAddresses
One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
Integer secondaryPrivateIpAddressCount
The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
String allocationId
[EC2-VPC] The allocation ID. This is required for EC2-VPC.
String instanceId
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
String publicIp
The Elastic IP address. This is required for EC2-Classic.
Boolean allowReassociation
[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
String networkInterfaceId
[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
String privateIpAddress
[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
String associationId
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String instanceId
The ID of the instance.
IamInstanceProfileAssociation iamInstanceProfileAssociation
Information about the IAM instance profile association.
String associationId
The route table association ID. This ID is required for disassociating the route table.
SubnetIpv6CidrBlockAssociation ipv6CidrBlockAssociation
Information about the IPv6 CIDR block association.
String subnetId
The ID of the subnet.
Boolean amazonProvidedIpv6CidrBlock
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
String cidrBlock
An IPv4 CIDR block to associate with the VPC.
String vpcId
The ID of the VPC.
VpcIpv6CidrBlockAssociation ipv6CidrBlockAssociation
Information about the IPv6 CIDR block association.
VpcCidrBlockAssociation cidrBlockAssociation
Information about the IPv4 CIDR block association.
String vpcId
The ID of the VPC.
SdkInternalList<T> groups
The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
String instanceId
The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
String vpcId
The ID of a ClassicLink-enabled VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String attachmentId
The ID of the network interface attachment.
VolumeAttachment attachment
Describes volume attachment details.
VpcAttachment vpcAttachment
Information about the attachment.
String groupId
The ID of the security group.
SdkInternalList<T> ipPermissions
One or more sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
String cidrIp
Not supported. Use a set of IP permissions to specify the CIDR.
Integer fromPort
Not supported. Use a set of IP permissions to specify the port.
String ipProtocol
Not supported. Use a set of IP permissions to specify the protocol name or number.
Integer toPort
Not supported. Use a set of IP permissions to specify the port.
String sourceSecurityGroupName
Not supported. Use a set of IP permissions to specify a destination security group.
String sourceSecurityGroupOwnerId
Not supported. Use a set of IP permissions to specify a destination security group.
String cidrIp
The CIDR IPv4 address range. You can't specify this parameter when specifying a source security group.
Integer fromPort
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. For the ICMP/ICMPv6 type
number, use -1
to specify all types. If you specify all ICMP/ICMPv6 types, you must specify all
codes.
String groupId
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
String groupName
[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
SdkInternalList<T> ipPermissions
One or more sets of IP permissions. Can be used to specify multiple rules in a single command.
String ipProtocol
The IP protocol name (tcp
, udp
, icmp
) or number (see Protocol Numbers). (VPC only)
Use -1
to specify all protocols. If you specify -1
, or a protocol number other than
tcp
, udp
, icmp
, or 58
(ICMPv6), traffic on all ports is
allowed, regardless of any ports you specify. For tcp
, udp
, and icmp
, you
must specify a port range. For protocol 58
(ICMPv6), you can optionally specify a port range; if you
don't, traffic for all types and codes is allowed.
String sourceSecurityGroupName
[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.
String sourceSecurityGroupOwnerId
[EC2-Classic] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number. For the ICMP/ICMPv6 code
number, use -1
to specify all codes. If you specify all ICMP/ICMPv6 types, you must specify all
codes.
String state
The state of the Availability Zone.
SdkInternalList<T> messages
Any messages about the Availability Zone.
String regionName
The name of the region.
String zoneName
The name of the Availability Zone.
String zoneId
The ID of the Availability Zone.
String message
The message about the Availability Zone.
SdkInternalList<T> availableInstanceCapacity
The total number of instances supported by the Dedicated Host.
Integer availableVCpus
The number of vCPUs available on the Dedicated Host.
String deviceName
The device name (for example, /dev/sdh
or xvdh
).
String virtualName
The virtual device name (ephemeral
N). Instance store volumes are numbered starting from 0. An
instance type with 2 available instance store volumes can specify mappings for ephemeral0
and
ephemeral1
. The number of available instance store volumes depends on the instance type. After you
connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
EbsBlockDevice ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String noDevice
Suppresses the specified device included in the block device mapping of the AMI.
String instanceId
The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
Storage storage
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
BundleTask bundleTask
Information about the bundle task.
String bundleId
The ID of the bundle task.
BundleTaskError bundleTaskError
If the task fails, a description of the error.
String instanceId
The ID of the instance associated with this bundle task.
String progress
The level of task completion, as a percent (for example, 20%).
Date startTime
The time this task started.
String state
The state of the task.
Storage storage
The Amazon S3 storage locations.
Date updateTime
The time of the most recent update for the task.
String cidr
The public IPv4 address range, in CIDR notation.
String description
The description of the address range.
String statusMessage
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
String state
The state of the address pool.
String bundleId
The ID of the bundle task.
BundleTask bundleTask
Information about the bundle task.
String capacityReservationId
The ID of the Capacity Reservation to be cancelled.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String exportTaskId
The ID of the export task. This is the ID returned by CreateInstanceExportTask
.
String reservedInstancesListingId
The ID of the Reserved Instance listing.
SdkInternalList<T> reservedInstancesListings
The Reserved Instance listing.
CancelSpotFleetRequestsError error
The error.
String spotFleetRequestId
The ID of the Spot Fleet request.
SdkInternalList<T> spotFleetRequestIds
The IDs of the Spot Fleet requests.
Boolean terminateInstances
Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
SdkInternalList<T> successfulFleetRequests
Information about the Spot Fleet requests that are successfully canceled.
SdkInternalList<T> unsuccessfulFleetRequests
Information about the Spot Fleet requests that are not successfully canceled.
String currentSpotFleetRequestState
The current state of the Spot Fleet request.
String previousSpotFleetRequestState
The previous state of the Spot Fleet request.
String spotFleetRequestId
The ID of the Spot Fleet request.
SdkInternalList<T> spotInstanceRequestIds
One or more Spot Instance request IDs.
SdkInternalList<T> cancelledSpotInstanceRequests
One or more Spot Instance requests.
String capacityReservationId
The ID of the Capacity Reservation.
String instanceType
The type of instance for which the Capacity Reservation reserves capacity.
String instancePlatform
The type of operating system for which the Capacity Reservation reserves capacity.
String availabilityZone
The Availability Zone in which the capacity is reserved.
String tenancy
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default
- The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated
- The Capacity Reservation is created on single-tenant hardware that is dedicated to a
single AWS account.
Integer totalInstanceCount
The number of instances for which the Capacity Reservation reserves capacity.
Integer availableInstanceCount
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
Boolean ebsOptimized
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
Boolean ephemeralStorage
Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
String state
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active
- The Capacity Reservation is active and the capacity is available for your use.
cancelled
- The Capacity Reservation expired automatically at the date and time specified in your
request. The reserved capacity is no longer available for your use.
expired
- The Capacity Reservation was manually cancelled. The reserved capacity is no longer
available for your use.
pending
- The Capacity Reservation request was successful but the capacity provisioning is still
pending.
failed
- The Capacity Reservation request has failed. A request might fail due to invalid request
parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
Date endDate
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
expired
when it reaches its end date and time.
String endDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited
- The Capacity Reservation remains active until you explicitly cancel it.
limited
- The Capacity Reservation expires automatically at a specified date and time.
String instanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open
- The Capacity Reservation accepts all instances that have matching attributes (instance type,
platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation
automatically without specifying any additional parameters.
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance
type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only
permitted instances can use the reserved capacity.
Date createDate
The date and time at which the Capacity Reservation was created.
SdkInternalList<T> tags
Any tags assigned to the Capacity Reservation.
String capacityReservationPreference
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open
Capacity Reservation that has matching
attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs as an On-Demand Instance.
CapacityReservationTarget capacityReservationTarget
Information about the target Capacity Reservation.
String capacityReservationPreference
Describes the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open
Capacity Reservation that has matching
attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs in On-Demand capacity.
CapacityReservationTargetResponse capacityReservationTarget
Information about the targeted Capacity Reservation.
String capacityReservationId
The ID of the Capacity Reservation.
String capacityReservationId
The ID of the Capacity Reservation.
String cidrBlock
The IPv4 CIDR block.
SdkInternalList<T> groups
A list of security groups.
String instanceId
The ID of the instance.
SdkInternalList<T> tags
Any tags assigned to the instance.
String vpcId
The ID of the VPC.
String name
The name of the load balancer.
SdkInternalList<T> classicLoadBalancers
One or more Classic Load Balancers.
String ownerId
The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.
Boolean returnValue
The return value of the request. Returns true
if the specified product code is owned by the
requester and associated with the specified instance.
String connectionNotificationId
The ID of the notification.
String serviceId
The ID of the endpoint service.
String vpcEndpointId
The ID of the VPC endpoint.
String connectionNotificationType
The type of notification.
String connectionNotificationArn
The ARN of the SNS topic for the notification.
SdkInternalList<T> connectionEvents
The events for the notification. Valid values are Accept
, Connect
, Delete
,
and Reject
.
String connectionNotificationState
The state of the notification.
String conversionTaskId
The ID of the conversion task.
String expirationTime
The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
ImportInstanceTaskDetails importInstance
If the task is for importing an instance, this contains information about the import instance task.
ImportVolumeTaskDetails importVolume
If the task is for importing a volume, this contains information about the import volume task.
String state
The state of the conversion task.
String statusMessage
The status message related to the conversion task.
SdkInternalList<T> tags
Any tags assigned to the task.
String sourceFpgaImageId
The ID of the source AFI.
String description
The description for the new AFI.
String name
The name for the new AFI. The default is the name of the source AFI.
String sourceRegion
The region that contains the source AFI.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String fpgaImageId
The ID of the new AFI.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
String description
A description for the new AMI in the destination region.
Boolean encrypted
Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an
unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS
is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId
.
For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
String kmsKeyId
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not
specified, the default CMK for EBS is used. If a KmsKeyId
is specified, the Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias, in the form alias/ExampleAlias
ARN using key ID. The ID ARN contains the arn:aws:kms
namespace, followed by the region of the CMK,
the AWS account ID of the CMK owner, the key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the region of the
CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even
though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the region that the snapshot is being copied to.
String name
The name of the new AMI in the destination region.
String sourceImageId
The ID of the AMI to copy.
String sourceRegion
The name of the region that contains the AMI to copy.
String imageId
The ID of the new AMI.
String description
A description for the EBS snapshot.
String destinationRegion
The destination region to use in the PresignedUrl
parameter of a snapshot copy operation. This
parameter is only valid for specifying the destination region in a PresignedUrl
parameter, where it
is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com
). With the AWS CLI, this is specified using the --region
parameter or the default region in your AWS configuration file.
Boolean encrypted
Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted
snapshot, but you cannot use it to create an unencrypted copy of an encrypted snapshot. Your default CMK for EBS
is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId
.
For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
String kmsKeyId
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not
specified, the default CMK for EBS is used. If a KmsKeyId
is specified, the Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms
namespace, followed by the region of the CMK,
the AWS account ID of the CMK owner, the key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the region of the
CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even
though you provided an invalid identifier. The action will eventually fail.
String presignedUrl
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.
The PresignedUrl
should use the snapshot source endpoint, the CopySnapshot
action, and
include the SourceRegion
, SourceSnapshotId
, and DestinationRegion
parameters. The PresignedUrl
must be signed using AWS Signature Version 4. Because EBS snapshots are
stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by
Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference.
An invalid or improperly signed PresignedUrl
will cause the copy operation to fail asynchronously,
and the snapshot will move to an error
state.
String sourceRegion
The ID of the region that contains the snapshot to be copied.
String sourceSnapshotId
The ID of the EBS snapshot to copy.
String snapshotId
The ID of the new snapshot.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
Constraint: Maximum 64 ASCII characters.
String instanceType
The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
String instancePlatform
The type of operating system for which to reserve capacity.
String availabilityZone
The Availability Zone in which to create the Capacity Reservation.
String tenancy
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default
- The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated
- The Capacity Reservation is created on single-tenant hardware that is dedicated to a
single AWS account.
Integer instanceCount
The number of instances for which to reserve capacity.
Boolean ebsOptimized
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
Boolean ephemeralStorage
Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
Date endDate
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
expired
when it reaches its end date and time.
You must provide an EndDate
value if EndDateType
is limited
. Omit
EndDate
if EndDateType
is unlimited
.
If the EndDateType
is limited
, the Capacity Reservation is cancelled within an hour
from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed
to end between 13:30:55 and 14:30:55 on 5/31/2019.
String endDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide
an EndDate
if the EndDateType
is unlimited
.
limited
- The Capacity Reservation expires automatically at a specified date and time. You must
provide an EndDate
value if the EndDateType
value is limited
.
String instanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open
- The Capacity Reservation automatically matches all instances that have matching attributes
(instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity
Reservation automatically without specifying any additional parameters.
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance
type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only
permitted instances can use the reserved capacity.
Default: open
SdkInternalList<T> tagSpecifications
The tags to apply to the Capacity Reservation during launch.
CapacityReservation capacityReservation
Information about the Capacity Reservation.
Integer bgpAsn
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
String publicIp
The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
String type
The type of VPN connection that this customer gateway supports (ipsec.1
).
CustomerGateway customerGateway
Information about the customer gateway.
String availabilityZone
The Availability Zone in which to create the default subnet.
Subnet subnet
Information about the subnet.
Vpc vpc
Information about the VPC.
SdkInternalList<T> dhcpConfigurations
A DHCP configuration option.
DhcpOptions dhcpOptions
A set of DHCP options.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String vpcId
The ID of the VPC for which to create the egress-only internet gateway.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
EgressOnlyInternetGateway egressOnlyInternetGateway
Information about the egress-only internet gateway.
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides
The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.
String lifecycle
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
String errorCode
The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.
String errorMessage
The error message that describes why the instance could not be launched. For more information about error messages, see ee Error Codes.
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides
The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.
String lifecycle
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
SdkInternalList<T> instanceIds
The IDs of the instances.
String instanceType
The instance type.
String platform
The value is Windows
for Windows instances; otherwise blank.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
SpotOptionsRequest spotOptions
Describes the configuration of Spot Instances in an EC2 Fleet.
OnDemandOptionsRequest onDemandOptions
The allocation strategy of On-Demand Instances in an EC2 Fleet.
String excessCapacityTerminationPolicy
Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
SdkInternalList<T> launchTemplateConfigs
The configuration for the EC2 Fleet.
TargetCapacitySpecificationRequest targetCapacitySpecification
The TotalTargetCapacity
, OnDemandTargetCapacity
, SpotTargetCapacity
, and
DefaultCapacityType
structure.
Boolean terminateInstancesWithExpiration
Indicates whether running instances should be terminated when the EC2 Fleet expires.
String type
The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and
maintains it by replenishing interrupted Spot Instances (maintain
). A value of instant
places a synchronous one-time request, and returns errors for any instances that could not be launched. A value
of request
places an asynchronous one-time request without maintaining capacity or submitting
requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
Date validFrom
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
Date validUntil
The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
Boolean replaceUnhealthyInstances
Indicates whether EC2 Fleet should replace unhealthy instances.
SdkInternalList<T> tagSpecifications
The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType
must be
fleet
, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch
template. For information about tagging after launch, see Tagging Your
Resources.
String fleetId
The ID of the EC2 Fleet.
SdkInternalList<T> errors
Information about the instances that could not be launched by the fleet. Valid only when Type is set to
instant
.
SdkInternalList<T> instances
Information about the instances that were launched by the fleet. Valid only when Type is set to
instant
.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String deliverLogsPermissionArn
The ARN for the IAM role that's used to post flow logs to a log group.
String logGroupName
The name of the log group.
SdkInternalList<T> resourceIds
One or more subnet, network interface, or VPC IDs.
Constraints: Maximum of 1000 resources
String resourceType
The type of resource on which to create the flow log.
String trafficType
The type of traffic to log.
String logDestinationType
Specifies the type of destination to which the flow log data is to be published. Flow log data can be published
to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify
cloud-watch-logs
. To publish flow log data to Amazon S3, specify s3
.
Default: cloud-watch-logs
String logDestination
Specifies the destination to which the flow log data is to be published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs
, specify the Amazon Resource Name (ARN)
of the CloudWatch Logs log group.
If LogDestinationType is s3
, specify the ARN of the Amazon S3 bucket. You can also specify a
subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format:
bucket_ARN/subfolder_name/
. For example, to specify a subfolder named my-logs
in a
bucket named my-bucket
, use the following ARN: arn:aws:s3:::my-bucket/my-logs/
. You
cannot use AWSLogs
as a subfolder name. This is a reserved term.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
SdkInternalList<T> flowLogIds
The IDs of the flow logs.
SdkInternalList<T> unsuccessful
Information about the flow logs that could not be created successfully.
StorageLocation inputStorageLocation
The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
StorageLocation logsStorageLocation
The location in Amazon S3 for the output logs.
String description
A description for the AFI.
String name
A name for the AFI.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
SdkInternalList<T> blockDeviceMappings
Information about one or more block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
String description
A description for the new image.
String instanceId
The ID of the instance.
String name
A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
Boolean noReboot
By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
String imageId
The ID of the new AMI.
String description
A description for the conversion task or the resource being exported. The maximum length is 255 bytes.
ExportToS3TaskSpecification exportToS3Task
The format and location for an instance export task.
String instanceId
The ID of the instance.
String targetEnvironment
The target virtualization environment.
ExportTask exportTask
Information about the instance export task.
InternetGateway internetGateway
Information about the internet gateway.
String keyName
A unique name for the key pair.
Constraints: Up to 255 ASCII characters
KeyPair keyPair
Describes a key pair.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String launchTemplateName
A name for the launch template.
String versionDescription
A description for the first version of the launch template.
RequestLaunchTemplateData launchTemplateData
The information for the launch template.
LaunchTemplate launchTemplate
Information about the launch template.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
String sourceVersion
The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData.
String versionDescription
A description for the version of the launch template.
RequestLaunchTemplateData launchTemplateData
The information for the launch template.
LaunchTemplateVersion launchTemplateVersion
Information about the launch template version.
String allocationId
The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
Constraint: Maximum 64 ASCII characters.
String subnetId
The subnet in which to create the NAT gateway.
String clientToken
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
NatGateway natGateway
Information about the NAT gateway.
String cidrBlock
The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24
).
Boolean egress
Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
String ipv6CidrBlock
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64
).
String networkAclId
The ID of the network ACL.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
String protocol
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Integer ruleNumber
The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
String vpcId
The ID of the VPC.
NetworkAcl networkAcl
Information about the network ACL.
NetworkInterfacePermission interfacePermission
Information about the permission for the network interface.
String description
A description for the network interface.
SdkInternalList<T> groups
The IDs of one or more security groups.
Integer ipv6AddressCount
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6
addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet
has the AssignIpv6AddressOnCreation
attribute set to true
, you can specify
0
to override this setting.
SdkInternalList<T> ipv6Addresses
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
String privateIpAddress
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).
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of
secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't
specify this option and specify more than one private IP address using privateIpAddresses
.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
String subnetId
The ID of the subnet to associate with the network interface.
NetworkInterface networkInterface
Information about the network interface.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
Integer instanceCount
The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
SdkInternalList<T> priceSchedules
A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
String reservedInstancesId
The ID of the active Standard Reserved Instance.
SdkInternalList<T> reservedInstancesListings
Information about the Standard Reserved Instance listing.
String destinationCidrBlock
The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.
String destinationIpv6CidrBlock
The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
String egressOnlyInternetGatewayId
[IPv6 traffic only] The ID of an egress-only internet gateway.
String gatewayId
The ID of an internet gateway or virtual private gateway attached to your VPC.
String instanceId
The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
String natGatewayId
[IPv4 traffic only] The ID of a NAT gateway.
String networkInterfaceId
The ID of a network interface.
String routeTableId
The ID of the route table for the route.
String vpcPeeringConnectionId
The ID of a VPC peering connection.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcId
The ID of the VPC.
RouteTable routeTable
Information about the route table.
String description
A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String groupName
The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg-
.
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String vpcId
[EC2-VPC] The ID of the VPC. Required for EC2-VPC.
String groupId
The ID of the security group.
String description
A description for the snapshot.
String volumeId
The ID of the EBS volume.
SdkInternalList<T> tagSpecifications
The tags to apply to the snapshot during creation.
Snapshot snapshot
Describes a snapshot.
SpotDatafeedSubscription spotDatafeedSubscription
The Spot Instance data feed subscription.
String availabilityZone
The Availability Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.
String cidrBlock
The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24
.
String ipv6CidrBlock
The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
String vpcId
The ID of the VPC.
Subnet subnet
Information about the subnet.
SdkInternalList<T> resources
The IDs of one or more resources, separated by spaces.
SdkInternalList<T> tags
One or more tags. The value
parameter is required, but if you don't want the tag to have a value,
specify the parameter with no value, and we set the value to an empty string.
SdkInternalList<T> add
Adds a specific AWS account ID or group to a volume's list of create volume permissions.
SdkInternalList<T> remove
Removes a specific AWS account ID or group from a volume's list of create volume permissions.
String availabilityZone
The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
Boolean encrypted
Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
Integer iops
The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 32000 IOPS for volumes in most regions. For exceptions, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
String kmsKeyId
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not
specified, the default CMK for EBS is used. If a KmsKeyId
is specified, the Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms
namespace, followed by the region of the CMK,
the AWS account ID of the CMK owner, the key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the region of the
CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even
though you provided an invalid identifier. The action will eventually fail.
Integer size
The size of the volume, in GiBs.
Constraints: 1-16384 for gp2
, 4-16384 for io1
, 500-16384 for st1
,
500-16384 for sc1
, and 1-1024 for standard
. If you specify a snapshot, the volume size
must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
String snapshotId
The snapshot from which to create the volume.
String volumeType
The volume type. This can be gp2
for General Purpose SSD, io1
for Provisioned IOPS SSD,
st1
for Throughput Optimized HDD, sc1
for Cold HDD, or standard
for
Magnetic volumes.
Defaults: If no volume type is specified, the default is standard
in us-east-1, eu-west-1,
eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
ap-south-1, us-gov-west-1, and cn-north-1. In all other regions, EBS defaults to gp2
.
SdkInternalList<T> tagSpecifications
The tags to apply to the volume during creation.
Volume volume
Describes a volume.
String serviceId
The ID of the endpoint service.
String vpcEndpointId
The ID of the endpoint.
String connectionNotificationArn
The ARN of the SNS topic for the notifications.
SdkInternalList<T> connectionEvents
One or more endpoint events for which to receive notifications. Valid values are Accept
,
Connect
, Delete
, and Reject
.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
ConnectionNotification connectionNotification
Information about the notification.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
String vpcEndpointType
The type of endpoint.
Default: Gateway
String vpcId
The ID of the VPC in which the endpoint will be used.
String serviceName
The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.
String policyDocument
(Gateway endpoint) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
SdkInternalList<T> routeTableIds
(Gateway endpoint) One or more route table IDs.
SdkInternalList<T> subnetIds
(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
SdkInternalList<T> securityGroupIds
(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
Boolean privateDnsEnabled
(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private
hosted zone contains a record set for the default public DNS name for the service for the region (for example,
kinesis.us-east-1.amazonaws.com
) which resolves to the private IP addresses of the endpoint network
interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead
of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true
:
enableDnsHostnames
and enableDnsSupport
. Use ModifyVpcAttribute to set the VPC
attributes.
Default: false
VpcEndpoint vpcEndpoint
Information about the endpoint.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
Boolean acceptanceRequired
Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.
SdkInternalList<T> networkLoadBalancerArns
The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
ServiceConfiguration serviceConfiguration
Information about the service configuration.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
String peerOwnerId
The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
String peerVpcId
The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
String vpcId
The ID of the requester VPC. You must specify this parameter in the request.
String peerRegion
The region code for the accepter VPC, if the accepter VPC is located in a region other than the region in which you make the request.
Default: The region in which you make the request.
VpcPeeringConnection vpcPeeringConnection
Information about the VPC peering connection.
String cidrBlock
The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16
.
Boolean amazonProvidedIpv6CidrBlock
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
String instanceTenancy
The tenancy options for instances launched into the VPC. For default
, instances are launched with
shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For
dedicated
, instances are launched as dedicated tenancy instances by default. You can only launch
instances with a tenancy of dedicated
or host
into a dedicated tenancy VPC.
Important: The host
value cannot be used with this parameter. Use the default
or
dedicated
values only.
Default: default
Vpc vpc
Information about the VPC.
String customerGatewayId
The ID of the customer gateway.
String type
The type of VPN connection (ipsec.1
).
String vpnGatewayId
The ID of the virtual private gateway.
VpnConnectionOptionsSpecification options
The options for the VPN connection.
VpnConnection vpnConnection
Information about the VPN connection.
String availabilityZone
The Availability Zone for the virtual private gateway.
String type
The type of VPN connection this virtual private gateway supports.
Long amazonSideAsn
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
VpnGateway vpnGateway
Information about the virtual private gateway.
String cpuCredits
The credit option for CPU usage of a T2 or T3 instance. Valid values are standard
and
unlimited
.
String cpuCredits
The credit option for CPU usage of a T2 or T3 instance. Valid values are standard
and
unlimited
.
String bgpAsn
The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
String customerGatewayId
The ID of the customer gateway.
String ipAddress
The Internet-routable IP address of the customer gateway's outside interface.
String state
The current state of the customer gateway (pending | available | deleting | deleted
).
String type
The type of VPN connection the customer gateway supports (ipsec.1
).
SdkInternalList<T> tags
Any tags assigned to the customer gateway.
String customerGatewayId
The ID of the customer gateway.
String dhcpOptionsId
The ID of the DHCP options set.
String egressOnlyInternetGatewayId
The ID of the egress-only internet gateway.
Boolean returnCode
Returns true
if the request succeeds; otherwise, it returns an error.
DeleteFleetError error
The error.
String fleetId
The ID of the EC2 Fleet.
SdkInternalList<T> fleetIds
The IDs of the EC2 Fleets.
Boolean terminateInstances
Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully.
SdkInternalList<T> successfulFleetDeletions
Information about the EC2 Fleets that are successfully deleted.
SdkInternalList<T> unsuccessfulFleetDeletions
Information about the EC2 Fleets that are not successfully deleted.
SdkInternalList<T> flowLogIds
One or more flow log IDs.
SdkInternalList<T> unsuccessful
Information about the flow logs that could not be deleted successfully.
String fpgaImageId
The ID of the AFI.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String internetGatewayId
The ID of the internet gateway.
String keyName
The name of the key pair.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
LaunchTemplate launchTemplate
Information about the launch template.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
SdkInternalList<T> versions
The version numbers of one or more launch template versions to delete.
String launchTemplateId
The ID of the launch template.
String launchTemplateName
The name of the launch template.
Long versionNumber
The version number of the launch template.
ResponseError responseError
Information about the error.
SdkInternalList<T> successfullyDeletedLaunchTemplateVersions
Information about the launch template versions that were successfully deleted.
SdkInternalList<T> unsuccessfullyDeletedLaunchTemplateVersions
Information about the launch template versions that could not be deleted.
String natGatewayId
The ID of the NAT gateway.
String natGatewayId
The ID of the NAT gateway.
String networkAclId
The ID of the network ACL.
Boolean returnValue
Returns true
if the request succeeds, otherwise returns an error.
String networkInterfaceId
The ID of the network interface.
String groupName
The name of the placement group.
String destinationCidrBlock
The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
String destinationIpv6CidrBlock
The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
String routeTableId
The ID of the route table.
String routeTableId
The ID of the route table.
String snapshotId
The ID of the EBS snapshot.
String subnetId
The ID of the subnet.
SdkInternalList<T> resources
The IDs of one or more resources, separated by spaces.
SdkInternalList<T> tags
One or more tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete
AWS-generated tags (tags that have the aws:
prefix).
String volumeId
The ID of the volume.
SdkInternalList<T> connectionNotificationIds
One or more notification IDs.
SdkInternalList<T> unsuccessful
Information about the notifications that could not be deleted successfully.
SdkInternalList<T> serviceIds
The IDs of one or more services.
SdkInternalList<T> unsuccessful
Information about the service configurations that were not deleted, if applicable.
SdkInternalList<T> vpcEndpointIds
One or more VPC endpoint IDs.
SdkInternalList<T> unsuccessful
Information about the VPC endpoints that were not successfully deleted.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcId
The ID of the VPC.
String vpnConnectionId
The ID of the VPN connection.
String vpnGatewayId
The ID of the virtual private gateway.
String cidr
The public IPv4 address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
ByoipCidr byoipCidr
Information about the address range.
String imageId
The ID of the AMI.
SdkInternalList<T> attributeNames
One or more account attribute names.
SdkInternalList<T> accountAttributes
Information about one or more account attributes.
SdkInternalList<T> filters
One or more filters. Filter names and values are case-sensitive.
allocation-id
- [EC2-VPC] The allocation ID for the address.
association-id
- [EC2-VPC] The association ID for the address.
domain
- Indicates whether the address is for use in EC2-Classic (standard
) or in a VPC
(vpc
).
instance-id
- The ID of the instance the address is associated with, if any.
network-interface-id
- [EC2-VPC] The ID of the network interface that the address is associated
with, if any.
network-interface-owner-id
- The AWS account ID of the owner.
private-ip-address
- [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip
- The Elastic IP address.
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.
SdkInternalList<T> publicIps
[EC2-Classic] One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
SdkInternalList<T> allocationIds
[EC2-VPC] One or more allocation IDs.
Default: Describes all your Elastic IP addresses.
SdkInternalList<T> addresses
Information about one or more Elastic IP addresses.
Boolean useLongIdsAggregated
Indicates whether all resource types in the region are configured to use longer IDs. This value is only
true
if all users are configured to use longer IDs for all resources types in the region.
SdkInternalList<T> statuses
Information about each resource's ID format.
SdkInternalList<T> filters
One or more filters.
message
- Information about the Availability Zone.
region-name
- The name of the region for the Availability Zone (for example, us-east-1
).
state
- The state of the Availability Zone (available
| information
|
impaired
| unavailable
).
zone-id
- The ID of the Availability Zone (for example, use1-az1
).
zone-name
- The name of the Availability Zone (for example, us-east-1a
).
SdkInternalList<T> zoneNames
The names of one or more Availability Zones.
SdkInternalList<T> zoneIds
The IDs of one or more Availability Zones.
SdkInternalList<T> availabilityZones
Information about one or more Availability Zones.
SdkInternalList<T> bundleIds
One or more bundle task IDs.
Default: Describes all your bundle tasks.
SdkInternalList<T> filters
One or more filters.
bundle-id
- The ID of the bundle task.
error-code
- If the task failed, the error code returned.
error-message
- If the task failed, the error message returned.
instance-id
- The ID of the instance.
progress
- The level of task completion, as a percentage (for example, 20%).
s3-bucket
- The Amazon S3 bucket to store the AMI.
s3-prefix
- The beginning of the AMI name.
start-time
- The time the task started (for example, 2013-09-15T17:15:20.000Z).
state
- The state of the task (pending
| waiting-for-shutdown
|
bundling
| storing
| cancelling
| complete
|
failed
).
update-time
- The time of the most recent update for the task.
SdkInternalList<T> bundleTasks
Information about one or more bundle tasks.
SdkInternalList<T> byoipCidrs
Information about your address ranges.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> capacityReservationIds
The ID of the Capacity Reservation.
String nextToken
The token to retrieve the next page of results.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.
SdkInternalList<T> filters
One or more filters.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> capacityReservations
Information about the Capacity Reservations.
SdkInternalList<T> filters
One or more filters.
group-id
- The ID of a VPC security group that's associated with the instance.
instance-id
- The ID of the instance.
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 to which the instance is linked.
vpc-id
- The ID of the VPC that the instance is linked to.
SdkInternalList<T> instanceIds
One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. This value can be
between 5 and 1000. If MaxResults
is given a value larger than 1000, only 1000 results are returned.
You cannot specify this parameter and the instance IDs parameter in the same request.
Constraint: If the value is greater than 1000, we return only 1000 items.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> instances
Information about one or more linked EC2-Classic instances.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> conversionTaskIds
One or more conversion task IDs.
SdkInternalList<T> conversionTasks
Information about the conversion tasks.
SdkInternalList<T> customerGatewayIds
One or more customer gateway IDs.
Default: Describes all your customer gateways.
SdkInternalList<T> filters
One or more filters.
bgp-asn
- The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id
- The ID of the customer gateway.
ip-address
- The IP address of the customer gateway's Internet-routable external interface.
state
- The state of the customer gateway (pending
| available
|
deleting
| deleted
).
type
- The type of customer gateway. Currently, the only supported type is ipsec.1
.
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.
SdkInternalList<T> customerGateways
Information about one or more customer gateways.
SdkInternalList<T> dhcpOptionsIds
The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
SdkInternalList<T> filters
One or more filters.
dhcp-options-id
- The ID of a set of DHCP options.
key
- The key for one of the options (for example, domain-name
).
value
- The value for one of the options.
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.
SdkInternalList<T> dhcpOptions
Information about one or more DHCP options sets.
SdkInternalList<T> egressOnlyInternetGatewayIds
One or more egress-only internet gateway IDs.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by
sending another request with the returned NextToken
value. This value can be between 5 and 1000. If
MaxResults
is given a value larger than 1000, only 1000 results are returned.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> egressOnlyInternetGateways
Information about the egress-only internet gateways.
String nextToken
The token to use to retrieve the next page of results.
SdkInternalList<T> elasticGpuIds
One or more Elastic GPU IDs.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone in which the Elastic GPU resides.
elastic-gpu-health
- The status of the Elastic GPU (OK
| IMPAIRED
).
elastic-gpu-state
- The state of the Elastic GPU (ATTACHED
).
elastic-gpu-type
- The type of Elastic GPU; for example, eg1.medium
.
instance-id
- The ID of the instance to which the Elastic GPU is associated.
Integer maxResults
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 5 and 1000.
String nextToken
The token to request the next page of results.
SdkInternalList<T> elasticGpuSet
Information about the Elastic GPUs.
Integer maxResults
The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> exportTaskIds
One or more export task IDs.
SdkInternalList<T> exportTasks
Information about the export tasks.
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides
The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.
String lifecycle
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
String errorCode
The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.
String errorMessage
The error message that describes why the instance could not be launched. For more information about error messages, see ee Error Codes.
String eventType
The type of events to describe. By default, all events are described.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
String fleetId
The ID of the EC2 Fleet.
Date startTime
The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SdkInternalList<T> historyRecords
Information about the events in the history of the EC2 Fleet.
Date lastEvaluatedTime
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken
indicates that there are more results, this value is not present.
String nextToken
The token for the next set of results.
String fleetId
The ID of the EC Fleet.
Date startTime
The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
String fleetId
The ID of the EC2 Fleet.
SdkInternalList<T> filters
One or more filters.
instance-type
- The instance type.
SdkInternalList<T> activeInstances
The running instances. This list is refreshed periodically and might be out of date.
String nextToken
The token for the next set of results.
String fleetId
The ID of the EC2 Fleet.
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides
The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.
String lifecycle
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
SdkInternalList<T> instanceIds
The IDs of the instances.
String instanceType
The instance type.
String platform
The value is Windows
for Windows instances; otherwise blank.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
SdkInternalList<T> fleetIds
The ID of the EC2 Fleets.
SdkInternalList<T> filters
One or more filters.
activity-status
- The progress of the EC2 Fleet ( error
|
pending-fulfillment
| pending-termination
| fulfilled
).
excess-capacity-termination-policy
- Indicates whether to terminate running instances if the target
capacity is decreased below the current EC2 Fleet size (true
| false
).
fleet-state
- The state of the EC2 Fleet (submitted
| active
|
deleted
| failed
| deleted-running
| deleted-terminating
|
modifying
).
replace-unhealthy-instances
- Indicates whether EC2 Fleet should replace unhealthy instances (
true
| false
).
type
- The type of request (instant
| request
| maintain
).
String nextToken
The token for the next set of results.
SdkInternalList<T> fleets
Information about the EC2 Fleets.
SdkInternalList<T> filter
One or more filters.
deliver-log-status
- The status of the logs delivery (SUCCESS
| FAILED
).
log-destination-type
- The type of destination to which the flow log publishes data. Possible
destination types include cloud-watch-logs
and S3
.
flow-log-id
- The ID of the flow log.
log-group-name
- The name of the log group.
resource-id
- The ID of the VPC, subnet, or network interface.
traffic-type
- The type of traffic (ACCEPT
| REJECT
| ALL
).
SdkInternalList<T> flowLogIds
One or more flow log IDs.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by
sending another request with the returned NextToken
value. This value can be between 5 and 1000. If
MaxResults
is given a value larger than 1000, only 1000 results are returned. You cannot specify
this parameter and the flow log IDs parameter in the same request.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> flowLogs
Information about the flow logs.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
FpgaImageAttribute fpgaImageAttribute
Information about the attribute.
SdkInternalList<T> fpgaImageIds
One or more AFI IDs.
SdkInternalList<T> owners
Filters the AFI by owner. Specify an AWS account ID, self
(owner is the sender of the request), or
an AWS owner alias (valid values are amazon
| aws-marketplace
).
SdkInternalList<T> filters
One or more filters.
create-time
- The creation time of the AFI.
fpga-image-id
- The FPGA image identifier (AFI ID).
fpga-image-global-id
- The global FPGA image identifier (AGFI ID).
name
- The name of the AFI.
owner-id
- The AWS account ID of the AFI owner.
product-code
- The product code.
shell-version
- The version of the AWS Shell that was used to create the bitstream.
state
- The state of the AFI (pending
| failed
| available
|
unavailable
).
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.
update-time
- The time of the most recent update.
String nextToken
The token to retrieve the next page of results.
Integer maxResults
The maximum number of results to return in a single call.
SdkInternalList<T> fpgaImages
Information about one or more FPGA images.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filter
One or more filters.
instance-family
- The instance family of the offering (for example, m4
).
payment-option
- The payment option (NoUpfront
| PartialUpfront
|
AllUpfront
).
Integer maxDuration
This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by
sending another request with the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
Integer minDuration
This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
String nextToken
The token to use to retrieve the next page of results.
String offeringId
The ID of the reservation offering.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> offeringSet
Information about the offerings.
SdkInternalList<T> filter
One or more filters.
instance-family
- The instance family (for example, m4
).
payment-option
- The payment option (NoUpfront
| PartialUpfront
|
AllUpfront
).
state
- The state of the reservation (payment-pending
| payment-failed
|
active
| retired
).
SdkInternalList<T> hostReservationIdSet
One or more host reservation IDs.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by
sending another request with the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
String nextToken
The token to use to retrieve the next page of results.
SdkInternalList<T> hostReservationSet
Details about the reservation's configuration.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filter
One or more filters.
auto-placement
- Whether auto-placement is enabled or disabled (on
| off
).
availability-zone
- The Availability Zone of the host.
client-token
- The idempotency token that you provided when you allocated the host.
host-reservation-id
- The ID of the reservation assigned to this host.
instance-type
- The instance type size that the Dedicated Host is configured to support.
state
- The allocation state of the Dedicated Host (available
|
under-assessment
| permanent-failure
| released
|
released-permanent-failure
).
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.
SdkInternalList<T> hostIds
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by
sending another request with the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error. You cannot specify this parameter
and the host IDs parameter in the same request.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> hosts
Information about the Dedicated Hosts.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> associationIds
One or more IAM instance profile associations.
SdkInternalList<T> filters
One or more filters.
instance-id
- The ID of the instance.
state
- The state of the association (associating
| associated
|
disassociating
| disassociated
).
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value.
String nextToken
The token to request the next page of results.
SdkInternalList<T> iamInstanceProfileAssociations
Information about one or more IAM instance profile associations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String principalArn
The ARN of the principal, which can be an IAM role, IAM user, or the root user.
String resource
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
instance
| internet-gateway
| network-acl
|
network-acl-association
| network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
|
route-table-association
| security-group
| snapshot
| subnet
| subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
SdkInternalList<T> statuses
Information about the ID format for the resources.
String resource
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
instance
| internet-gateway
| network-acl
|
network-acl-association
| network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
|
route-table-association
| security-group
| snapshot
| subnet
| subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
SdkInternalList<T> statuses
Information about the ID format for the resource.
String attribute
The AMI attribute.
Note: Depending on your account privileges, the blockDeviceMapping
attribute may return a
Client.AuthFailure
error. If this happens, use DescribeImages to get information about the
block device mapping for the AMI.
String imageId
The ID of the AMI.
ImageAttribute imageAttribute
Describes an image attribute.
SdkInternalList<T> executableUsers
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self
(the
sender of the request), or all
(public AMIs).
SdkInternalList<T> filters
One or more filters.
architecture
- The image architecture (i386
| x86_64
).
block-device-mapping.delete-on-termination
- A Boolean value that indicates whether the Amazon EBS
volume is deleted on instance termination.
block-device-mapping.device-name
- The device name specified in the block device mapping (for
example, /dev/sdh
or xvdh
).
block-device-mapping.snapshot-id
- The ID of the snapshot used for the EBS volume.
block-device-mapping.volume-size
- The volume size of the EBS volume, in GiB.
block-device-mapping.volume-type
- The volume type of the EBS volume (gp2
|
io1
| st1
| sc1
| standard
).
description
- The description of the image (provided during image creation).
ena-support
- A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor
- The hypervisor type (ovm
| xen
).
image-id
- The ID of the image.
image-type
- The image type (machine
| kernel
| ramdisk
).
is-public
- A Boolean that indicates whether the image is public.
kernel-id
- The kernel ID.
manifest-location
- The location of the image manifest.
name
- The name of the AMI (provided during image creation).
owner-alias
- String value from an Amazon-maintained list (amazon
|
aws-marketplace
| microsoft
) of snapshot owners. Not to be confused with the
user-configured AWS account alias, which is set from the IAM console.
owner-id
- The AWS account ID of the image owner.
platform
- The platform. To only list Windows-based AMIs, use windows
.
product-code
- The product code.
product-code.type
- The type of the product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
root-device-name
- The device name of the root device volume (for example, /dev/sda1
).
root-device-type
- The type of the root device volume (ebs
|
instance-store
).
state
- The state of the image (available
| pending
| failed
).
state-reason-code
- The reason code for the state change.
state-reason-message
- The message for the state change.
sriov-net-support
- A value of simple
indicates that enhanced networking with the Intel
82599 VF interface is enabled.
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.
virtualization-type
- The virtualization type (paravirtual
| hvm
).
SdkInternalList<T> imageIds
One or more image IDs.
Default: Describes all images available to you.
SdkInternalList<T> owners
Filters the images by the owner. Specify an AWS account ID, self
(owner is the sender of the
request), or an AWS owner alias (valid values are amazon
| aws-marketplace
|
microsoft
). Omitting this option returns all images for which you have launch permissions,
regardless of ownership.
SdkInternalList<T> images
Information about one or more images.
SdkInternalList<T> filters
Filter tasks using the task-state
filter and one of the following values: active, completed,
deleting, deleted.
SdkInternalList<T> importTaskIds
A list of import image task IDs.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value.
String nextToken
A token that indicates the next page of results.
SdkInternalList<T> importImageTasks
A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.
String nextToken
The token to use to get the next page of results. This value is null
when there are no more results
to return.
SdkInternalList<T> filters
One or more filters.
SdkInternalList<T> importTaskIds
A list of import snapshot task IDs.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value.
String nextToken
A token that indicates the next page of results.
SdkInternalList<T> importSnapshotTasks
A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
String nextToken
The token to use to get the next page of results. This value is null
when there are no more results
to return.
InstanceAttribute instanceAttribute
Describes an instance attribute.
SdkInternalList<T> filters
One or more filters.
instance-id
- The ID of the instance.
SdkInternalList<T> instanceIds
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
Integer maxResults
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 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> instanceCreditSpecifications
Information about the credit option for CPU usage of an instance.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
affinity
- The affinity setting for an instance running on a Dedicated Host (default
|
host
).
architecture
- The instance architecture (i386
| x86_64
).
availability-zone
- The Availability Zone of the instance.
block-device-mapping.attach-time
- The attach time for an EBS volume mapped to the instance, for
example, 2010-09-15T17:15:20.000Z
.
block-device-mapping.delete-on-termination
- A Boolean that indicates whether the EBS volume is
deleted on instance termination.
block-device-mapping.device-name
- The device name specified in the block device mapping (for
example, /dev/sdh
or xvdh
).
block-device-mapping.status
- The status for the EBS volume (attaching
|
attached
| detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the EBS volume.
client-token
- The idempotency token you provided when you launched the instance.
dns-name
- The public DNS name of the instance.
group-id
- The ID of the security group for the instance. EC2-Classic only.
group-name
- The name of the security group for the instance. EC2-Classic only.
host-id
- The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor
- The hypervisor type of the instance (ovm
| xen
).
iam-instance-profile.arn
- The instance profile associated with the instance. Specified as an ARN.
image-id
- The ID of the image used to launch the instance.
instance-id
- The ID of the instance.
instance-lifecycle
- Indicates whether this is a Spot Instance or a Scheduled Instance (
spot
| scheduled
).
instance-state-code
- The state of the instance, 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-type
- The type of instance (for example, t2.micro
).
instance.group-id
- The ID of the security group for the instance.
instance.group-name
- The name of the security group for the instance.
ip-address
- The public IPv4 address of the instance.
kernel-id
- The kernel ID.
key-name
- The name of the key pair used when the instance was launched.
launch-index
- When launching multiple instances, this is the index for the instance in the launch
group (for example, 0, 1, 2, and so on).
launch-time
- The time when the instance was launched.
monitoring-state
- Indicates whether detailed monitoring is enabled (disabled
|
enabled
).
network-interface.addresses.private-ip-address
- The private IPv4 address associated with the
network interface.
network-interface.addresses.primary
- Specifies whether the IPv4 address of the network interface is
the primary private IPv4 address.
network-interface.addresses.association.public-ip
- The ID of the association of an Elastic IP
address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id
- The owner ID of the private IPv4 address
associated with the network interface.
network-interface.association.public-ip
- The address of the Elastic IP address (IPv4) bound to the
network interface.
network-interface.association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated
with the network interface.
network-interface.association.allocation-id
- The allocation ID returned when you allocated the
Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id
- The association ID returned when the network
interface was associated with an IPv4 address.
network-interface.attachment.attachment-id
- The ID of the interface attachment.
network-interface.attachment.instance-id
- The ID of the instance to which the network interface is
attached.
network-interface.attachment.instance-owner-id
- The owner ID of the instance to which the network
interface is attached.
network-interface.attachment.device-index
- The device index to which the network interface is
attached.
network-interface.attachment.status
- The status of the attachment (attaching
|
attached
| detaching
| detached
).
network-interface.attachment.attach-time
- The time that the network interface was attached to an
instance.
network-interface.attachment.delete-on-termination
- Specifies whether the attachment is deleted
when an instance is terminated.
network-interface.availability-zone
- The Availability Zone for the network interface.
network-interface.description
- The description of the network interface.
network-interface.group-id
- The ID of a security group associated with the network interface.
network-interface.group-name
- The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address
- The IPv6 address associated with the network
interface.
network-interface.mac-address
- The MAC address of the network interface.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.owner-id
- The ID of the owner of the network interface.
network-interface.private-dns-name
- The private DNS name of the network interface.
network-interface.requester-id
- The requester ID for the network interface.
network-interface.requester-managed
- Indicates whether the network interface is being managed by
AWS.
network-interface.status
- The status of the network interface (available
) |
in-use
).
network-interface.source-dest-check
- Whether the network interface performs source/destination
checking. A value of true
means that checking is enabled, and false
means that checking
is disabled. The value must be false
for the network interface to perform network address
translation (NAT) in your VPC.
network-interface.subnet-id
- The ID of the subnet for the network interface.
network-interface.vpc-id
- The ID of the VPC for the network interface.
owner-id
- The AWS account ID of the instance owner.
placement-group-name
- The name of the placement group for the instance.
platform
- The platform. Use windows
if you have Windows instances; otherwise, leave
blank.
private-dns-name
- The private IPv4 DNS name of the instance.
private-ip-address
- The private IPv4 address of the instance.
product-code
- The product code associated with the AMI used to launch the instance.
product-code.type
- The type of product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the instance (for example, shows
"User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that launched the instance on your behalf (for example, AWS
Management Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation. A reservation ID is created any time you
launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be
associated with more than one instance if you launch multiple instances using the same launch request. For
example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same
launch request, you also get one reservation ID.
root-device-name
- The device name of the root device volume (for example, /dev/sda1
).
root-device-type
- The type of the root device volume (ebs
|
instance-store
).
source-dest-check
- Indicates whether the instance performs source/destination checking. A value of
true
means that checking is enabled, and false
means that checking is disabled. The
value must be false
for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot Instance request.
state-reason-code
- The reason code for the state change.
state-reason-message
- A message that describes the state change.
subnet-id
- The ID of the subnet for the instance.
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.
tenancy
- The tenancy of an instance (dedicated
| default
|
host
).
virtualization-type
- The virtualization type of the instance (paravirtual
|
hvm
).
vpc-id
- The ID of the VPC that the instance is running in.
SdkInternalList<T> instanceIds
One or more instance IDs.
Default: Describes all your instances.
Integer maxResults
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 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.
String nextToken
The token to request the next page of results.
SdkInternalList<T> reservations
Zero or more reservations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
availability-zone
- 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.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
).
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
).
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
).
SdkInternalList<T> instanceIds
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
Integer maxResults
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 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.
String nextToken
The token to retrieve the next page of results.
Boolean includeAllInstances
When true
, includes the health status for all instances. When false
, includes the
health status for running instances only.
Default: false
SdkInternalList<T> instanceStatuses
One or more instance status descriptions.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
attachment.state
- The current state of the attachment between the gateway and the VPC (
available
). Present only if a VPC is attached.
attachment.vpc-id
- The ID of an attached VPC.
internet-gateway-id
- The ID of the Internet gateway.
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.
SdkInternalList<T> internetGatewayIds
One or more internet gateway IDs.
Default: Describes all your internet gateways.
SdkInternalList<T> internetGateways
Information about one or more internet gateways.
SdkInternalList<T> filters
One or more filters.
fingerprint
- The fingerprint of the key pair.
key-name
- The name of the key pair.
SdkInternalList<T> keyNames
One or more key pair names.
Default: Describes all your key pairs.
SdkInternalList<T> keyPairs
Information about one or more key pairs.
SdkInternalList<T> launchTemplateIds
One or more launch template IDs.
SdkInternalList<T> launchTemplateNames
One or more launch template names.
SdkInternalList<T> filters
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.
String nextToken
The token to request the next page of results.
Integer maxResults
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.
SdkInternalList<T> launchTemplates
Information about the launch templates.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
SdkInternalList<T> versions
One or more versions of the launch template.
String minVersion
The version number after which to describe launch template versions.
String maxVersion
The version number up to which to describe launch template versions.
String nextToken
The token to request the next page of results.
Integer maxResults
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.
SdkInternalList<T> filters
One or more filters.
create-time
- The time the launch template version was created.
ebs-optimized
- A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
iam-instance-profile
- The ARN of the IAM instance profile.
image-id
- The ID of the AMI.
instance-type
- The instance type.
is-default-version
- A boolean that indicates whether the launch template version is the default
version.
kernel-id
- The kernel ID.
ram-disk-id
- The RAM disk ID.
SdkInternalList<T> launchTemplateVersions
Information about the launch template versions.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
moving-status
- The status of the Elastic IP address (MovingToVpc
|
RestoringToClassic
).
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. This value can be
between 5 and 1000; if MaxResults
is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
String nextToken
The token for the next page of results.
SdkInternalList<T> publicIps
One or more Elastic IP addresses.
SdkInternalList<T> movingAddressStatuses
The status for each Elastic IP address.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filter
One or more filters.
nat-gateway-id
- The ID of the NAT gateway.
state
- The state of the NAT gateway (pending
| failed
|
available
| deleting
| deleted
).
subnet-id
- The ID of the subnet in which the NAT gateway resides.
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 in which the NAT gateway resides.
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value specified is greater than 1000, we return only 1000 items.
SdkInternalList<T> natGatewayIds
One or more NAT gateway IDs.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> natGateways
Information about the NAT gateways.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
association.association-id
- The ID of an association ID for the ACL.
association.network-acl-id
- The ID of the network ACL involved in the association.
association.subnet-id
- The ID of the subnet involved in the association.
default
- Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr
- The IPv4 CIDR range specified in the entry.
entry.icmp.code
- The ICMP code specified in the entry, if any.
entry.icmp.type
- The ICMP type specified in the entry, if any.
entry.ipv6-cidr
- The IPv6 CIDR range specified in the entry.
entry.port-range.from
- The start of the port range specified in the entry.
entry.port-range.to
- The end of the port range specified in the entry.
entry.protocol
- The protocol specified in the entry (tcp
| udp
|
icmp
or a protocol number).
entry.rule-action
- Allows or denies the matching traffic (allow
| deny
).
entry.rule-number
- The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id
- The ID of the network ACL.
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 ACL.
SdkInternalList<T> networkAclIds
One or more network ACL IDs.
Default: Describes all your network ACLs.
SdkInternalList<T> networkAcls
Information about one or more network ACLs.
NetworkInterfaceAttachment attachment
The attachment (if any) of the network interface.
String description
The description of the network interface.
SdkInternalList<T> groups
The security groups associated with the network interface.
String networkInterfaceId
The ID of the network interface.
Boolean sourceDestCheck
Indicates whether source/destination checking is enabled.
SdkInternalList<T> networkInterfacePermissionIds
One or more network interface permission IDs.
SdkInternalList<T> filters
One or more filters.
network-interface-permission.network-interface-permission-id
- The ID of the permission.
network-interface-permission.network-interface-id
- The ID of the network interface.
network-interface-permission.aws-account-id
- The AWS account ID.
network-interface-permission.aws-service
- The AWS service.
network-interface-permission.permission
- The type of permission (INSTANCE-ATTACH
|
EIP-ASSOCIATE
).
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. If this parameter is not specified, up to 50 results are returned
by default.
SdkInternalList<T> networkInterfacePermissions
The network interface permissions.
String nextToken
The token to use to retrieve the next page of results.
SdkInternalList<T> filters
One or more filters.
addresses.private-ip-address
- The private IPv4 addresses associated with the network interface.
addresses.primary
- Whether the private IPv4 address is the primary IP address associated with the
network interface.
addresses.association.public-ip
- The association ID returned when the network interface was
associated with the Elastic IP address (IPv4).
addresses.association.owner-id
- The owner ID of the addresses associated with the network
interface.
association.association-id
- The association ID returned when the network interface was associated
with an IPv4 address.
association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address
(IPv4) for your network interface.
association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated with the network
interface.
association.public-ip
- The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name
- The public DNS name for the network interface (IPv4).
attachment.attachment-id
- The ID of the interface attachment.
attachment.attach.time
- The time that the network interface was attached to an instance.
attachment.delete-on-termination
- Indicates whether the attachment is deleted when an instance is
terminated.
attachment.device-index
- The device index to which the network interface is attached.
attachment.instance-id
- The ID of the instance to which the network interface is attached.
attachment.instance-owner-id
- The owner ID of the instance to which the network interface is
attached.
attachment.nat-gateway-id
- The ID of the NAT gateway to which the network interface is attached.
attachment.status
- The status of the attachment (attaching
| attached
|
detaching
| detached
).
availability-zone
- The Availability Zone of the network interface.
description
- The description of the network interface.
group-id
- The ID of a security group associated with the network interface.
group-name
- The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address
- An IPv6 address associated with the network interface.
mac-address
- The MAC address of the network interface.
network-interface-id
- The ID of the network interface.
owner-id
- The AWS account ID of the network interface owner.
private-ip-address
- The private IPv4 address or addresses of the network interface.
private-dns-name
- The private DNS name of the network interface (IPv4).
requester-id
- The ID of the entity that launched the instance on your behalf (for example, AWS
Management Console, Auto Scaling, and so on).
requester-managed
- Indicates whether the network interface is being managed by an AWS service (for
example, AWS Management Console, Auto Scaling, and so on).
source-desk-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.
SdkInternalList<T> networkInterfaceIds
One or more network interface IDs.
Default: Describes all your network interfaces.
String nextToken
The token to retrieve the next page of results.
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
SdkInternalList<T> networkInterfaces
Information about one or more network interfaces.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
group-name
- The name of the placement group.
state
- The state of the placement group (pending
| available
|
deleting
| deleted
).
strategy
- The strategy of the placement group (cluster
| spread
).
SdkInternalList<T> groupNames
One or more placement group names.
Default: Describes all your placement groups, or only those otherwise specified.
SdkInternalList<T> placementGroups
One or more placement groups.
SdkInternalList<T> filters
One or more filters.
prefix-list-id
: The ID of a prefix list.
prefix-list-name
: The name of a prefix list.
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value specified is greater than 1000, we return only 1000 items.
String nextToken
The token for the next set of items to return. (You received this token from a prior call.)
SdkInternalList<T> prefixListIds
One or more prefix list IDs.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
SdkInternalList<T> prefixLists
All available prefix lists.
SdkInternalList<T> resources
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
instance
| internet-gateway
| network-acl
|
network-acl-association
| network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
|
route-table-association
| security-group
| snapshot
| subnet
| subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
String nextToken
The token to request the next page of results.
SdkInternalList<T> principals
Information about the ID format settings for the ARN.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
SdkInternalList<T> poolIds
The IDs of the address pools.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> publicIpv4Pools
Information about the address pools.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
endpoint
- The endpoint of the region (for example, ec2.us-east-1.amazonaws.com
).
region-name
- The name of the region (for example, us-east-1
).
SdkInternalList<T> regionNames
The names of one or more regions.
SdkInternalList<T> regions
Information about one or more regions.
SdkInternalList<T> filters
One or more filters.
reserved-instances-id
- The ID of the Reserved Instances.
reserved-instances-listing-id
- The ID of the Reserved Instances listing.
status
- The status of the Reserved Instance listing (pending
| active
|
cancelled
| closed
).
status-message
- The reason for the status.
String reservedInstancesId
One or more Reserved Instance IDs.
String reservedInstancesListingId
One or more Reserved Instance listing IDs.
SdkInternalList<T> reservedInstancesListings
Information about the Reserved Instance listing.
SdkInternalList<T> filters
One or more filters.
client-token
- The idempotency token for the modification request.
create-date
- The time when the modification request was created.
effective-date
- The time when the modification becomes effective.
modification-result.reserved-instances-id
- The ID for the Reserved Instances created as part of the
modification request. This ID is only available when the status of the modification is fulfilled
.
modification-result.target-configuration.availability-zone
- The Availability Zone for the new
Reserved Instances.
modification-result.target-configuration.instance-count
- The number of new Reserved Instances.
modification-result.target-configuration.instance-type
- The instance type of the new Reserved
Instances.
modification-result.target-configuration.platform
- The network platform of the new Reserved
Instances (EC2-Classic
| EC2-VPC
).
reserved-instances-id
- The ID of the Reserved Instances modified.
reserved-instances-modification-id
- The ID of the modification request.
status
- The status of the Reserved Instances modification request (processing
|
fulfilled
| failed
).
status-message
- The reason for the status.
update-date
- The time when the modification request was last updated.
SdkInternalList<T> reservedInstancesModificationIds
IDs for the submitted modification request.
String nextToken
The token to retrieve the next page of results.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> reservedInstancesModifications
The Reserved Instance modification information.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (for example, one year or three years), in seconds
(31536000
| 94608000
).
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
instance-type
- The instance type that is covered by the reservation.
marketplace
- Set to true
to show only Reserved Instance Marketplace offerings. When
this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance
Marketplace are listed.
product-description
- The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the product platform description will only be displayed to EC2-Classic account
holders and are for use with Amazon VPC. (Linux/UNIX
| Linux/UNIX (Amazon VPC)
|
SUSE Linux
| SUSE Linux (Amazon VPC)
| Red Hat Enterprise Linux
|
Red Hat Enterprise Linux (Amazon VPC)
| Windows
| Windows (Amazon VPC)
|
Windows with SQL Server Standard
| Windows with SQL Server Standard (Amazon VPC)
|
Windows with SQL Server Web
| Windows with SQL Server Web (Amazon VPC)
|
Windows with SQL Server Enterprise
| Windows with SQL Server Enterprise (Amazon VPC)
)
reserved-instances-offering-id
- The Reserved Instances offering ID.
scope
- The scope of the Reserved Instance (Availability Zone
or Region
).
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
Boolean includeMarketplace
Include Reserved Instance Marketplace offerings in the response.
String instanceType
The instance type that the reservation will cover (for example, m1.small
). For more information, see
Instance Types in the
Amazon Elastic Compute Cloud User Guide.
Long maxDuration
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
Integer maxInstanceCount
The maximum number of instances to filter when searching for offerings.
Default: 20
Long minDuration
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
String offeringClass
The offering class of the Reserved Instance. Can be standard
or convertible
.
String productDescription
The Reserved Instance product platform description. Instances that include (Amazon VPC)
in the
description are for use with Amazon VPC.
SdkInternalList<T> reservedInstancesOfferingIds
One or more Reserved Instances offering IDs.
String instanceTenancy
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
dedicated
is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated
Instances).
Important: The host
value cannot be used with this parameter. Use the default
or
dedicated
values only.
Default: default
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. The maximum is
100.
Default: 100
String nextToken
The token to retrieve the next page of results.
String offeringType
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
have access to the Medium Utilization
Reserved Instance offering type.
SdkInternalList<T> reservedInstancesOfferings
A list of Reserved Instances offerings.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (one year or three years), in seconds (
31536000
| 94608000
).
end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
instance-type
- The instance type that is covered by the reservation.
scope
- The scope of the Reserved Instance (Region
or Availability Zone
).
product-description
- The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the product platform description will only be displayed to EC2-Classic account
holders and are for use with Amazon VPC (Linux/UNIX
| Linux/UNIX (Amazon VPC)
|
SUSE Linux
| SUSE Linux (Amazon VPC)
| Red Hat Enterprise Linux
|
Red Hat Enterprise Linux (Amazon VPC)
| Windows
| Windows (Amazon VPC)
|
Windows with SQL Server Standard
| Windows with SQL Server Standard (Amazon VPC)
|
Windows with SQL Server Web
| Windows with SQL Server Web (Amazon VPC)
|
Windows with SQL Server Enterprise
| Windows with SQL Server Enterprise (Amazon VPC)
).
reserved-instances-id
- The ID of the Reserved Instance.
start
- The time at which the Reserved Instance purchase request was placed (for example,
2014-08-07T11:54:42.000Z).
state
- The state of the Reserved Instance (payment-pending
| active
|
payment-failed
| retired
).
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.
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
String offeringClass
Describes whether the Reserved Instance is Standard or Convertible.
SdkInternalList<T> reservedInstancesIds
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
String offeringType
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
have access to the Medium Utilization
Reserved Instance offering type.
SdkInternalList<T> reservedInstances
A list of Reserved Instances.
SdkInternalList<T> filters
One or more filters.
association.route-table-association-id
- The ID of an association ID for the route table.
association.route-table-id
- The ID of the route table involved in the association.
association.subnet-id
- The ID of the subnet involved in the association.
association.main
- Indicates whether the route table is the main route table for the VPC (
true
| false
). Route tables that do not have an association ID are not returned in the
response.
route-table-id
- The ID of the route table.
route.destination-cidr-block
- The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block
- The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id
- The ID (prefix) of the AWS service specified in a route in the
table.
route.egress-only-internet-gateway-id
- The ID of an egress-only Internet gateway specified in a
route in the route table.
route.gateway-id
- The ID of a gateway specified in a route in the table.
route.instance-id
- The ID of an instance specified in a route in the table.
route.nat-gateway-id
- The ID of a NAT gateway.
route.origin
- Describes how the route was created. CreateRouteTable
indicates that the
route was automatically created when the route table was created; CreateRoute
indicates that the
route was manually added to the route table; EnableVgwRoutePropagation
indicates that the route was
propagated by route propagation.
route.state
- The state of a route in the route table (active
| blackhole
). The blackhole state indicates that the route's target isn't available (for example, the specified gateway
isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id
- The ID of a VPC peering connection specified in a route in the
table.
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 route table.
SdkInternalList<T> routeTableIds
One or more route table IDs.
Default: Describes all your route tables.
String nextToken
The token to retrieve the next page of results.
Integer maxResults
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 5 and 100.
SdkInternalList<T> routeTables
Information about one or more route tables.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone (for example, us-west-2a
).
instance-type
- The instance type (for example, c4.large
).
network-platform
- The network platform (EC2-Classic
or EC2-VPC
).
platform
- The platform (Linux/UNIX
or Windows
).
SlotDateTimeRangeRequest firstSlotStartTimeRange
The time period for the first schedule to start.
Integer maxResults
The maximum number of results to return in a single call. This value can be between 5 and 300. The default value
is 300. To retrieve the remaining results, make another call with the returned NextToken
value.
Integer maxSlotDurationInHours
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours
and
less than 1,720.
Integer minSlotDurationInHours
The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
String nextToken
The token for the next set of results.
ScheduledInstanceRecurrenceRequest recurrence
The schedule recurrence.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
SdkInternalList<T> scheduledInstanceAvailabilitySet
Information about the available Scheduled Instances.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone (for example, us-west-2a
).
instance-type
- The instance type (for example, c4.large
).
network-platform
- The network platform (EC2-Classic
or EC2-VPC
).
platform
- The platform (Linux/UNIX
or Windows
).
Integer maxResults
The maximum number of results to return in a single call. This value can be between 5 and 300. The default value
is 100. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
SdkInternalList<T> scheduledInstanceIds
One or more Scheduled Instance IDs.
SlotStartTimeRangeRequest slotStartTimeRange
The time period for the first schedule to start.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
SdkInternalList<T> scheduledInstanceSet
Information about the Scheduled Instances.
SdkInternalList<T> groupId
One or more security group IDs in your account.
SdkInternalList<T> securityGroupReferenceSet
Information about the VPCs with the referencing security groups.
SdkInternalList<T> filters
One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description
- The description of the security group.
egress.ip-permission.cidr
- An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port
- For an outbound rule, the start of port range for the TCP and UDP
protocols, or an ICMP type number.
egress.ip-permission.group-id
- The ID of a security group that has been referenced in an outbound
security group rule.
egress.ip-permission.group-name
- The name of a security group that has been referenced in an
outbound security group rule.
egress.ip-permission.ipv6-cidr
- An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id
- The ID (prefix) of the AWS service to which a security group
rule allows outbound access.
egress.ip-permission.protocol
- The IP protocol for an outbound security group rule (
tcp
| udp
| icmp
or a protocol number).
egress.ip-permission.to-port
- For an outbound rule, the end of port range for the TCP and UDP
protocols, or an ICMP code.
egress.ip-permission.user-id
- The ID of an AWS account that has been referenced in an outbound
security group rule.
group-id
- The ID of the security group.
group-name
- The name of the security group.
ip-permission.cidr
- An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port
- For an inbound rule, the start of port range for the TCP and UDP
protocols, or an ICMP type number.
ip-permission.group-id
- The ID of a security group that has been referenced in an inbound security
group rule.
ip-permission.group-name
- The name of a security group that has been referenced in an inbound
security group rule.
ip-permission.ipv6-cidr
- An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id
- The ID (prefix) of the AWS service from which a security group rule
allows inbound access.
ip-permission.protocol
- The IP protocol for an inbound security group rule (tcp
|
udp
| icmp
or a protocol number).
ip-permission.to-port
- For an inbound rule, the end of port range for the TCP and UDP protocols, or
an ICMP code.
ip-permission.user-id
- The ID of an AWS account that has been referenced in an inbound security
group rule.
owner-id
- The AWS account ID of the owner of the security group.
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 specified when the security group was created.
SdkInternalList<T> groupIds
One or more security group IDs. Required for security groups in a nondefault VPC.
Default: Describes all your security groups.
SdkInternalList<T> groupNames
[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group
name or the security group ID. For security groups in a nondefault VPC, use the group-name
filter to
describe security groups by name.
Default: Describes all your security groups.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another request
with the returned NextToken
value. This value can be between 5 and 1000. If this parameter is not
specified, then all results are returned.
SdkInternalList<T> securityGroups
Information about one or more security groups.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> createVolumePermissions
A list of permissions for creating volumes from the snapshot.
SdkInternalList<T> productCodes
A list of product codes.
String snapshotId
The ID of the EBS snapshot.
SdkInternalList<T> filters
One or more filters.
description
- A description of the snapshot.
owner-alias
- Value from an Amazon-maintained list (amazon
|
aws-marketplace
| microsoft
) of snapshot owners. Not to be confused with the
user-configured AWS account alias, which is set from the IAM console.
owner-id
- The ID of the AWS account that owns the snapshot.
progress
- The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id
- The snapshot ID.
start-time
- The time stamp when the snapshot was initiated.
status
- The status of the snapshot (pending
| completed
|
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 ID of the volume the snapshot is for.
volume-size
- The size of the volume, in GiB.
Integer maxResults
The maximum number of snapshot results returned by DescribeSnapshots
in paginated output. When this
parameter is used, DescribeSnapshots
only returns MaxResults
results in a single page
along with a NextToken
response element. The remaining results of the initial request can be seen by
sending another DescribeSnapshots
request with the returned NextToken
value. This value
can be between 5 and 1000; if MaxResults
is given a value larger than 1000, only 1000 results are
returned. If this parameter is not used, then DescribeSnapshots
returns all results. You cannot
specify this parameter and the snapshot IDs parameter in the same request.
String nextToken
The NextToken
value returned from a previous paginated DescribeSnapshots
request where
MaxResults
was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.
SdkInternalList<T> ownerIds
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
SdkInternalList<T> restorableByUserIds
One or more AWS accounts IDs that can create volumes from the snapshot.
SdkInternalList<T> snapshotIds
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
SdkInternalList<T> snapshots
Information about the snapshots.
String nextToken
The NextToken
value to include in a future DescribeSnapshots
request. When the results
of a DescribeSnapshots
request exceed MaxResults
, this value can be used to retrieve
the next page of results. This value is null
when there are no more results to return.
SpotDatafeedSubscription spotDatafeedSubscription
The Spot Instance data feed subscription.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
String spotFleetRequestId
The ID of the Spot Fleet request.
SdkInternalList<T> activeInstances
The running instances. This list is refreshed periodically and might be out of date.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
String spotFleetRequestId
The ID of the Spot Fleet request.
String eventType
The type of events to describe. By default, all events are described.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
String spotFleetRequestId
The ID of the Spot Fleet request.
Date startTime
The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SdkInternalList<T> historyRecords
Information about the events in the history of the Spot Fleet request.
Date lastEvaluatedTime
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken
indicates that there are more results, this value is not present.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
String spotFleetRequestId
The ID of the Spot Fleet request.
Date startTime
The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
SdkInternalList<T> spotFleetRequestIds
The IDs of the Spot Fleet requests.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
SdkInternalList<T> spotFleetRequestConfigs
Information about the configuration of your Spot Fleet.
SdkInternalList<T> filters
One or more filters.
availability-zone-group
- The Availability Zone group.
create-time
- The time stamp when the Spot Instance request was created.
fault-code
- The fault code related to the request.
fault-message
- The fault message related to the request.
instance-id
- The ID of the instance that fulfilled the request.
launch-group
- The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination
- Indicates whether the EBS volume is deleted on
instance termination.
launch.block-device-mapping.device-name
- The device name for the volume in the block device mapping
(for example, /dev/sdh
or xvdh
).
launch.block-device-mapping.snapshot-id
- The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size
- The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type
- The type of EBS volume: gp2
for General
Purpose SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD,
sc1
for Cold HDD, or standard
for Magnetic.
launch.group-id
- The ID of the security group for the instance.
launch.group-name
- The name of the security group for the instance.
launch.image-id
- The ID of the AMI.
launch.instance-type
- The type of instance (for example, m3.medium
).
launch.kernel-id
- The kernel ID.
launch.key-name
- The name of the key pair the instance launched with.
launch.monitoring-enabled
- Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id
- The RAM disk ID.
launched-availability-zone
- The Availability Zone in which the request is launched.
network-interface.addresses.primary
- Indicates whether the IP address is the primary private IP
address.
network-interface.delete-on-termination
- Indicates whether the network interface is deleted when
the instance is terminated.
network-interface.description
- A description of the network interface.
network-interface.device-index
- The index of the device for the network interface attachment on the
instance.
network-interface.group-id
- The ID of the security group associated with the network interface.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.private-ip-address
- The primary private IP address of the network interface.
network-interface.subnet-id
- The ID of the subnet for the instance.
product-description
- The product description associated with the instance (Linux/UNIX
| Windows
).
spot-instance-request-id
- The Spot Instance request ID.
spot-price
- The maximum hourly price for any Spot Instance launched to fulfill the request.
state
- The state of the Spot Instance request (open
| active
|
closed
| cancelled
| failed
). Spot request status information can help you
track your Amazon EC2 Spot Instance requests. For more information, see Spot Request Status in the
Amazon EC2 User Guide for Linux Instances.
status-code
- The short code describing the most recent evaluation of your Spot Instance request.
status-message
- The message explaining the status of the Spot Instance request.
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.
type
- The type of Spot Instance request (one-time
| persistent
).
valid-from
- The start date of the request.
valid-until
- The end date of the request.
SdkInternalList<T> spotInstanceRequestIds
One or more Spot Instance request IDs.
SdkInternalList<T> spotInstanceRequests
One or more Spot Instance requests.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone for which prices should be returned.
instance-type
- The type of instance (for example, m3.medium
).
product-description
- The product description for the Spot price (Linux/UNIX
|
SUSE Linux
| Windows
| Linux/UNIX (Amazon VPC)
|
SUSE Linux (Amazon VPC)
| Windows (Amazon VPC)
).
spot-price
- The Spot price. The value must match exactly (or use wildcards; greater than or less
than comparison is not supported).
timestamp
- The time stamp of the Spot price history, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or
less than comparison is not supported.
String availabilityZone
Filters the results by the specified Availability Zone.
Date endTime
The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SdkInternalList<T> instanceTypes
Filters the results by the specified instance types.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
SdkInternalList<T> productDescriptions
Filters the results by the specified basic product descriptions.
Date startTime
The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String nextToken
The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.
SdkInternalList<T> spotPriceHistory
The historical Spot prices.
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a prior call.)
String vpcId
The ID of the VPC.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
SdkInternalList<T> staleSecurityGroupSet
Information about the stale security groups.
SdkInternalList<T> filters
One or more filters.
availabilityZone
- The Availability Zone for the subnet. You can also use
availability-zone
as the filter name.
available-ip-address-count
- The number of IPv4 addresses in the subnet that are available.
cidrBlock
- The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the
subnet's CIDR block for information to be returned for the subnet. You can also use cidr
or
cidr-block
as the filter names.
defaultForAz
- Indicates whether this is the default subnet for the Availability Zone. You can also
use default-for-az
as the filter name.
ipv6-cidr-block-association.ipv6-cidr-block
- An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id
- An association ID for an IPv6 CIDR block associated
with the subnet.
ipv6-cidr-block-association.state
- The state of an IPv6 CIDR block associated with the subnet.
state
- The state of the subnet (pending
| available
).
subnet-id
- The ID of the subnet.
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 subnet.
SdkInternalList<T> subnetIds
One or more subnet IDs.
Default: Describes all your subnets.
SdkInternalList<T> subnets
Information about one or more subnets.
SdkInternalList<T> filters
One or more filters.
key
- The tag key.
resource-id
- The ID of the resource.
resource-type
- The resource type (customer-gateway
| dedicated-host
|
dhcp-options
| elastic-ip
| fleet
| fpga-image
|
image
| instance
| internet-gateway
| launch-template
|
natgateway
| network-acl
| network-interface
|
reserved-instances
| route-table
| security-group
| snapshot
| spot-instances-request
| subnet
| volume
| vpc
|
vpc-peering-connection
| vpn-connection
| vpn-gateway
).
tag
:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the
filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value
- The tag value.
Integer maxResults
The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the
remaining results, make another call with the returned NextToken
value.
String nextToken
The token to retrieve the next page of results.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> tags
The tags.
Boolean autoEnableIO
The state of autoEnableIO
attribute.
SdkInternalList<T> productCodes
A list of product codes.
String volumeId
The ID of the volume.
SdkInternalList<T> volumeIds
One or more volume IDs for which in-progress modifications will be described.
SdkInternalList<T> filters
One or more filters. Supported filters: volume-id
, modification-state
,
target-size
, target-iops
, target-volume-type
, original-size
,
original-iops
, original-volume-type
, start-time
.
String nextToken
The nextToken
value returned by a previous paginated request.
Integer maxResults
The maximum number of results (up to a limit of 500) to be returned in a paginated request.
SdkInternalList<T> volumesModifications
A list of returned VolumeModification objects.
String nextToken
Token for pagination, null if there are no more results
SdkInternalList<T> filters
One or more 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.
create-time
- The time stamp when the volume was created.
encrypted
- The encryption status of the volume.
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was created.
status
- The status 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. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for
Cold HDD, or standard
for Magnetic volumes.
SdkInternalList<T> volumeIds
One or more volume IDs.
Integer maxResults
The maximum number of volume results returned by DescribeVolumes
in paginated output. When this
parameter is used, DescribeVolumes
only returns MaxResults
results in a single page
along with a NextToken
response element. The remaining results of the initial request can be seen by
sending another DescribeVolumes
request with the returned NextToken
value. This value
can be between 5 and 500; if MaxResults
is given a value larger than 500, only 500 results are
returned. If this parameter is not used, then DescribeVolumes
returns all results. You cannot
specify this parameter and the volume IDs parameter in the same request.
String nextToken
The NextToken
value returned from a previous paginated DescribeVolumes
request where
MaxResults
was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.
SdkInternalList<T> volumes
Information about the volumes.
String nextToken
The NextToken
value to include in a future DescribeVolumes
request. When the results of
a DescribeVolumes
request exceed MaxResults
, this value can be used to retrieve the
next page of results. This value is null
when there are no more results to return.
SdkInternalList<T> filters
One or more 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
).
Integer maxResults
The maximum number of volume results returned by DescribeVolumeStatus
in paginated output. When this
parameter is used, the request only returns MaxResults
results in a single page along with a
NextToken
response element. The remaining results of the initial request can be seen by sending
another request with the returned NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is
not used, then DescribeVolumeStatus
returns all results. You cannot specify this parameter and the
volume IDs parameter in the same request.
String nextToken
The NextToken
value to include in a future DescribeVolumeStatus
request. When the
results of the request exceed MaxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
SdkInternalList<T> volumeIds
One or more volume IDs.
Default: Describes all your volumes.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> volumeStatuses
A list of volumes.
String vpcId
The ID of the VPC.
Boolean enableDnsHostnames
Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true
,
instances in the VPC get DNS hostnames; otherwise, they do not.
Boolean enableDnsSupport
Indicates whether DNS resolution is enabled for the VPC. If this attribute is true
, the Amazon DNS
server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a prior call.)
SdkInternalList<T> vpcIds
One or more VPC IDs.
String nextToken
The token to use when requesting the next set of items.
SdkInternalList<T> vpcs
Information about the ClassicLink DNS support status of the VPCs.
SdkInternalList<T> filters
One or more filters.
is-classic-link-enabled
- Whether the VPC is enabled for ClassicLink (true
|
false
).
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.
SdkInternalList<T> vpcIds
One or more VPCs for which you want to describe the ClassicLink status.
SdkInternalList<T> vpcs
The ClassicLink status of one or more VPCs.
String connectionNotificationId
The ID of the notification.
SdkInternalList<T> filters
One or more filters.
connection-notification-arn
- The ARN of SNS topic for the notification.
connection-notification-id
- The ID of the notification.
connection-notification-state
- The state of the notification (Enabled
|
Disabled
).
connection-notification-type
- The type of notification (Topic
).
service-id
- The ID of the endpoint service.
vpc-endpoint-id
- The ID of the VPC endpoint.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another request
with the returned NextToken
value.
String nextToken
The token to request the next page of results.
SdkInternalList<T> connectionNotificationSet
One or more notifications.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
service-id
- The ID of the service.
vpc-endpoint-owner
- The AWS account number of the owner of the endpoint.
vpc-endpoint-state
- The state of the endpoint (pendingAcceptance
|
pending
| available
| deleting
| deleted
|
rejected
| failed
).
vpc-endpoint-id
- The ID of the endpoint.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. This value can be
between 5 and 1000; if MaxResults
is given a value larger than 1000, only 1000 results are returned.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> vpcEndpointConnections
Information about one or more VPC endpoint connections.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> serviceIds
The IDs of one or more services.
SdkInternalList<T> filters
One or more filters.
service-name
- The name of the service.
service-id
- The ID of the service.
service-state
- The state of the service (Pending
| Available
|
Deleting
| Deleted
| Failed
).
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. This value can be
between 5 and 1000; if MaxResults
is given a value larger than 1000, only 1000 results are returned.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> serviceConfigurations
Information about one or more services.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String serviceId
The ID of the service.
SdkInternalList<T> filters
One or more filters.
principal
- The ARN of the principal.
principal-type
- The principal type (All
| Service
|
OrganizationUnit
| Account
| User
| Role
).
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. This value can be
between 5 and 1000; if MaxResults
is given a value larger than 1000, only 1000 results are returned.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> allowedPrincipals
Information about one or more allowed principals.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> serviceNames
One or more service names.
SdkInternalList<T> filters
One or more filters.
service-name
: The name of the service.
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1000, we return only 1000 items.
String nextToken
The token for the next set of items to return. (You received this token from a prior call.)
SdkInternalList<T> serviceNames
A list of supported services.
SdkInternalList<T> serviceDetails
Information about the service.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
SdkInternalList<T> vpcEndpointIds
One or more endpoint IDs.
SdkInternalList<T> filters
One or more filters.
service-name
: The name of the service.
vpc-id
: The ID of the VPC in which the endpoint resides.
vpc-endpoint-id
: The ID of the endpoint.
vpc-endpoint-state
: The state of the endpoint. (pending
| available
|
deleting
| deleted
)
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1000, we return only 1000 items.
String nextToken
The token for the next set of items to return. (You received this token from a prior call.)
SdkInternalList<T> vpcEndpoints
Information about the endpoints.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
SdkInternalList<T> filters
One or more filters.
accepter-vpc-info.cidr-block
- The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id
- The AWS account ID of the owner of the accepter VPC.
accepter-vpc-info.vpc-id
- The ID of the accepter VPC.
expiration-time
- The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block
- The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id
- The AWS account ID of the owner of the requester VPC.
requester-vpc-info.vpc-id
- The ID of the requester VPC.
status-code
- The status of the VPC peering connection (pending-acceptance
|
failed
| expired
| provisioning
| active
|
deleting
| deleted
| rejected
).
status-message
- A message that provides more information about the status of the VPC peering
connection, if applicable.
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-peering-connection-id
- The ID of the VPC peering connection.
SdkInternalList<T> vpcPeeringConnectionIds
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
SdkInternalList<T> vpcPeeringConnections
Information about the VPC peering connections.
SdkInternalList<T> filters
One or more filters.
cidr
- The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the
VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits
(for example, /28
).
cidr-block-association.cidr-block
- An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id
- The association ID for an IPv4 CIDR block associated with
the VPC.
cidr-block-association.state
- The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id
- The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block
- An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.association-id
- The association ID for an IPv6 CIDR block associated
with the VPC.
ipv6-cidr-block-association.state
- The state of an IPv6 CIDR block associated with the VPC.
isDefault
- Indicates whether the VPC is the default VPC.
state
- The state of the VPC (pending
| available
).
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.
SdkInternalList<T> vpcIds
One or more VPC IDs.
Default: Describes all your VPCs.
SdkInternalList<T> vpcs
Information about one or more VPCs.
SdkInternalList<T> filters
One or more filters.
customer-gateway-configuration
- The configuration information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway associated with the VPN connection.
state
- The state of the VPN connection (pending
| available
|
deleting
| deleted
).
option.static-routes-only
- Indicates whether the connection has static routes only. Used for
devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR block. This corresponds to the subnet used in a
customer data center.
bgp-asn
- The BGP Autonomous System Number (ASN) associated with a BGP device.
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.
type
- The type of VPN connection. Currently the only supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway associated with the VPN connection.
SdkInternalList<T> vpnConnectionIds
One or more VPN connection IDs.
Default: Describes your VPN connections.
SdkInternalList<T> vpnConnections
Information about one or more VPN connections.
SdkInternalList<T> filters
One or more filters.
amazon-side-asn
- The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state
- The current state of the attachment between the gateway and the VPC (
attaching
| attached
| detaching
| detached
).
attachment.vpc-id
- The ID of an attached VPC.
availability-zone
- The Availability Zone for the virtual private gateway (if applicable).
state
- The state of the virtual private gateway (pending
| available
|
deleting
| deleted
).
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.
type
- The type of virtual private gateway. Currently the only supported type is
ipsec.1
.
vpn-gateway-id
- The ID of the virtual private gateway.
SdkInternalList<T> vpnGatewayIds
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
SdkInternalList<T> vpnGateways
Information about one or more virtual private gateways.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String device
The device name.
Boolean force
Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.
String instanceId
The ID of the instance.
String volumeId
The ID of the volume.
VolumeAttachment attachment
Describes volume attachment details.
String key
The name of a DHCP option.
SdkInternalList<T> values
One or more values for the DHCP option.
SdkInternalList<T> dhcpConfigurations
One or more DHCP options in the set.
String dhcpOptionsId
The ID of the set of DHCP options.
SdkInternalList<T> tags
Any tags assigned to the DHCP options set.
String vpcId
The ID of the VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcId
The ID of the VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String associationId
The ID of the IAM instance profile association.
IamInstanceProfileAssociation iamInstanceProfileAssociation
Information about the IAM instance profile association.
String associationId
The association ID representing the current association between the route table and subnet.
String associationId
The association ID for the CIDR block.
SubnetIpv6CidrBlockAssociation ipv6CidrBlockAssociation
Information about the IPv6 CIDR block association.
String subnetId
The ID of the subnet.
String associationId
The association ID for the CIDR block.
VpcIpv6CidrBlockAssociation ipv6CidrBlockAssociation
Information about the IPv6 CIDR block association.
VpcCidrBlockAssociation cidrBlockAssociation
Information about the IPv4 CIDR block association.
String vpcId
The ID of the VPC.
String description
A description of the disk image.
DiskImageDetail image
Information about the disk image.
VolumeDetail volume
Information about the volume.
String checksum
The checksum computed for the disk image.
String format
The disk image format.
String importManifestUrl
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
Long size
The size of the disk image, in GiB.
Long bytes
The size of the disk image, in GiB.
String format
The disk image format.
String importManifestUrl
A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports. For io1
, this represents
the number of IOPS that are provisioned for the volume. For gp2
, this represents the baseline
performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more
information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the
Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100-20000 IOPS for io1
volumes and 100-10000 IOPS for gp2
volumes.
Condition: This parameter is required for requests to create io1
volumes; it is not used in requests
to create gp2
, st1
, sc1
, or standard
volumes.
String snapshotId
The ID of the snapshot.
Integer volumeSize
The size of the volume, in GiB.
Constraints: 1-16384 for General Purpose SSD (gp2
), 4-16384 for Provisioned IOPS SSD (
io1
), 500-16384 for Throughput Optimized HDD (st1
), 500-16384 for Cold HDD (
sc1
), and 1-1024 for Magnetic (standard
) volumes. If you specify a snapshot, the volume
size must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
String volumeType
The volume type: gp2
, io1
, st1
, sc1
, or standard
.
Default: standard
Boolean encrypted
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption.
If you are creating a volume from a snapshot, you cannot specify an encryption value. This is because only blank volumes can be encrypted on creation. If you are creating a snapshot from an existing EBS volume, you cannot specify an encryption value that differs from that of the EBS volume. We recommend that you omit the encryption value from the block device mappings when creating an image from an instance.
String kmsKeyId
Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet, and
RequestSpotInstances
.
SdkInternalList<T> attachments
Information about the attachment of the egress-only internet gateway.
String egressOnlyInternetGatewayId
The ID of the egress-only internet gateway.
String elasticGpuId
The ID of the Elastic GPU.
String elasticGpuAssociationId
The ID of the association.
String elasticGpuAssociationState
The state of the association between the instance and the Elastic GPU.
String elasticGpuAssociationTime
The time the Elastic GPU was associated with the instance.
String status
The health status.
String elasticGpuId
The ID of the Elastic GPU.
String availabilityZone
The Availability Zone in the which the Elastic GPU resides.
String elasticGpuType
The type of Elastic GPU.
ElasticGpuHealth elasticGpuHealth
The status of the Elastic GPU.
String elasticGpuState
The state of the Elastic GPU.
String instanceId
The ID of the instance to which the Elastic GPU is attached.
String type
The type of Elastic GPU.
String type
The elastic GPU type.
String volumeId
The ID of the volume.
String vpcId
The ID of the VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcId
The ID of the VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String eventDescription
The description of the event.
String eventSubType
The event.
The following are the error
events:
iamFleetRoleInvalid
- The Spot Fleet did not have the required permissions either to launch or
terminate an instance.
launchSpecTemporarilyBlacklisted
- The configuration is not valid and several attempts to launch
instances have failed. For more information, see the description of the event.
spotFleetRequestConfigurationInvalid
- The configuration is not valid. For more information, see the
description of the event.
spotInstanceCountLimitExceeded
- You've reached the limit on the number of Spot Instances that you
can launch.
The following are the fleetRequestChange
events:
active
- The Spot Fleet has been validated and Amazon EC2 is attempting to maintain the target
number of running Spot Instances.
cancelled
- The Spot Fleet is canceled and has no running Spot Instances. The Spot Fleet will be
deleted two days after its instances were terminated.
cancelled_running
- The Spot Fleet is canceled and does not launch additional Spot Instances.
Existing Spot Instances continue to run until they are interrupted or terminated.
cancelled_terminating
- The Spot Fleet is canceled and its Spot Instances are terminating.
expired
- The Spot Fleet request has expired. A subsequent event indicates that the instances were
terminated, if the request was created with TerminateInstancesWithExpiration
set.
modify_in_progress
- A request to modify the Spot Fleet request was accepted and is in progress.
modify_successful
- The Spot Fleet request was modified.
price_update
- The price for a launch configuration was adjusted because it was too high. This
change is permanent.
submitted
- The Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the
target number of Spot Instances.
The following are the instanceChange
events:
launched
- A request was fulfilled and a new instance was launched.
terminated
- An instance was terminated by the user.
The following are the Information
events:
launchSpecUnusable
- The price in a launch specification is not valid because it is below the Spot
price or the Spot price is above the On-Demand price.
fleetProgressHalted
- The price in every launch specification is not valid. A launch specification
might become valid if the Spot price changes.
String instanceId
The ID of the instance. This information is available only for instanceChange
events.
String description
A description of the resource being exported.
String exportTaskId
The ID of the export task.
ExportToS3Task exportToS3Task
Information about the export task.
InstanceExportDetails instanceExportDetails
Information about the instance to export.
String state
The state of the export task.
String statusMessage
The status message related to the export task.
String containerFormat
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
String diskImageFormat
The format for the exported image.
String s3Bucket
The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP
permissions to the AWS account [email protected]
.
String s3Key
The encryption key for your S3 bucket.
String containerFormat
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
String diskImageFormat
The format for the exported image.
String s3Bucket
The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP
permissions to the AWS account [email protected]
.
String s3Prefix
The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
String name
The name of the filter. Filter names are case-sensitive.
SdkInternalList<T> values
One or more filter values. Filter values are case-sensitive.
String activityStatus
The progress of the EC2 Fleet. If there is an error, the status is error
. After all requests are
placed, the status is pending_fulfillment
. If the size of the EC2 Fleet is equal to or greater than
its target capacity, the status is fulfilled
. If the size of the EC2 Fleet is decreased, the status
is pending_termination
while instances are terminating.
Date createTime
The creation date and time of the EC2 Fleet.
String fleetId
The ID of the EC2 Fleet.
String fleetState
The state of the EC2 Fleet.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
String excessCapacityTerminationPolicy
Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Double fulfilledCapacity
The number of units fulfilled by this request compared to the set target capacity.
Double fulfilledOnDemandCapacity
The number of units fulfilled by this request compared to the set target On-Demand capacity.
SdkInternalList<T> launchTemplateConfigs
The launch template and overrides.
TargetCapacitySpecification targetCapacitySpecification
The number of units to request. You can choose to set the target capacity in terms of instances or a performance
characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type
is maintain
, you can specify a target capacity of 0 and add capacity later.
Boolean terminateInstancesWithExpiration
Indicates whether running instances should be terminated when the EC2 Fleet expires.
String type
The type of request. Indicates whether the EC2 Fleet only requests
the target capacity, or also
attempts to maintain
it. If you request a certain target capacity, EC2 Fleet only places the
required requests; it does not attempt to replenish instances if capacity is diminished, and does not submit
requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2
Fleet places the required requests to meet this target capacity. It also automatically replenishes any
interrupted Spot Instances. Default: maintain
.
Date validFrom
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
Date validUntil
The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
Boolean replaceUnhealthyInstances
Indicates whether EC2 Fleet should replace unhealthy instances.
SpotOptions spotOptions
The configuration of Spot Instances in an EC2 Fleet.
OnDemandOptions onDemandOptions
The allocation strategy of On-Demand Instances in an EC2 Fleet.
SdkInternalList<T> tags
The tags for an EC2 Fleet resource.
SdkInternalList<T> errors
Information about the instances that could not be launched by the fleet. Valid only when Type is set to
instant
.
SdkInternalList<T> instances
Information about the instances that were launched by the fleet. Valid only when Type is set to
instant
.
FleetLaunchTemplateSpecification launchTemplateSpecification
The launch template.
SdkInternalList<T> overrides
Any parameters that you specify override the same parameters in the launch template.
FleetLaunchTemplateSpecificationRequest launchTemplateSpecification
The launch template to use. You must specify either the launch template ID or launch template name in the request.
SdkInternalList<T> overrides
Any parameters that you specify override the same parameters in the launch template.
String instanceType
The instance type.
String maxPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance.
String subnetId
The ID of the subnet in which to launch the instances.
String availabilityZone
The Availability Zone in which to launch the instances.
Double weightedCapacity
The number of units provided by the specified instance type.
Double priority
The priority for the launch template override. If AllocationStrategy is set to prioritized
,
EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand
capacity. The highest priority is launched first. Valid values are whole numbers starting at 0
. The
lower the number, the higher the priority. If no number is set, the override has the lowest priority.
PlacementResponse placement
The location where the instance launched, if applicable.
String instanceType
The instance type.
String maxPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance.
String subnetId
The ID of the subnet in which to launch the instances.
String availabilityZone
The Availability Zone in which to launch the instances.
Double weightedCapacity
The number of units provided by the specified instance type.
Double priority
The priority for the launch template override. If AllocationStrategy is set to prioritized
,
EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand
capacity. The highest priority is launched first. Valid values are whole numbers starting at 0
. The
lower the number, the higher the priority. If no number is set, the launch template override has the lowest
priority.
Placement placement
The location where the instance launched, if applicable.
String launchTemplateId
The ID of the launch template. You must specify either a template ID or a template name.
String launchTemplateName
The name of the launch template. You must specify either a template name or a template ID.
String version
The version number of the launch template. You must specify a version number.
Date creationTime
The date and time the flow log was created.
String deliverLogsErrorMessage
Information about the error that occurred. Rate limited
indicates that CloudWatch Logs throttling
has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups
that you can create. Access error
indicates that the IAM role associated with the flow log does not
have sufficient permissions to publish to CloudWatch Logs. Unknown error
indicates an internal
error.
String deliverLogsPermissionArn
The ARN of the IAM role that posts logs to CloudWatch Logs.
String deliverLogsStatus
The status of the logs delivery (SUCCESS
| FAILED
).
String flowLogId
The flow log ID.
String flowLogStatus
The status of the flow log (ACTIVE
).
String logGroupName
The name of the flow log group.
String resourceId
The ID of the resource on which the flow log was created.
String trafficType
The type of traffic captured for the flow log.
String logDestinationType
Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
String logDestination
Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.
String fpgaImageId
The FPGA image identifier (AFI ID).
String fpgaImageGlobalId
The global FPGA image identifier (AGFI ID).
String name
The name of the AFI.
String description
The description of the AFI.
String shellVersion
The version of the AWS Shell that was used to create the bitstream.
PciId pciId
Information about the PCI bus.
FpgaImageState state
Information about the state of the AFI.
Date createTime
The date and time the AFI was created.
Date updateTime
The time of the most recent update to the AFI.
String ownerId
The AWS account ID of the AFI owner.
String ownerAlias
The alias of the AFI owner. Possible values include self
, amazon
, and
aws-marketplace
.
SdkInternalList<T> productCodes
The product codes for the AFI.
SdkInternalList<T> tags
Any tags assigned to the AFI.
Boolean publicValue
Indicates whether the AFI is public.
String fpgaImageId
The ID of the AFI.
String name
The name of the AFI.
String description
The description of the AFI.
SdkInternalList<T> loadPermissions
One or more load permissions.
SdkInternalList<T> productCodes
One or more product codes.
String code
The state. The following are the possible values:
pending
- AFI bitstream generation is in progress.
available
- The AFI is available for use.
failed
- AFI bitstream generation failed.
unavailable
- The AFI is no longer available for use.
String message
If the state is failed
, this is the error message.
SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts with which the reservation is associated.
String offeringId
The offering ID of the reservation.
String currencyCode
The currency in which the totalUpfrontPrice
and totalHourlyPrice
amounts are specified.
At this time, the only supported currency is USD
.
SdkInternalList<T> purchase
The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
String totalHourlyPrice
The potential total hourly price of the reservation per hour.
String totalUpfrontPrice
The potential total upfront price. This is billed immediately.
String instanceId
The ID of the instance.
ResponseLaunchTemplateData launchTemplateData
The instance data.
String instanceId
The ID of the Windows instance.
SdkInternalList<T> reservedInstanceIds
The IDs of the Convertible Reserved Instances to exchange.
SdkInternalList<T> targetConfigurations
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
String currencyCode
The currency of the transaction.
Boolean isValidExchange
If true
, the exchange is valid. If false
, the exchange cannot be completed.
Date outputReservedInstancesWillExpireAt
The new end date of the reservation term.
String paymentDue
The total true upfront charge for the exchange.
ReservationValue reservedInstanceValueRollup
The cost associated with the Reserved Instance.
SdkInternalList<T> reservedInstanceValueSet
The configuration of your Convertible Reserved Instances.
ReservationValue targetConfigurationValueRollup
The cost associated with the Reserved Instance.
SdkInternalList<T> targetConfigurationValueSet
The values of the target Convertible Reserved Instances.
String validationFailureReason
Describes the reason why the exchange cannot be completed.
EventInformation eventInformation
Information about the event.
String eventType
The event type.
error
- An error with the Spot Fleet request.
fleetRequestChange
- A change in the status or configuration of the Spot Fleet request.
instanceChange
- An instance was launched or terminated.
Information
- An informational event.
Date timestamp
The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
EventInformation eventInformation
Information about the event.
String eventType
The event type.
Date timestamp
The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String autoPlacement
Whether auto-placement is on or off.
String availabilityZone
The Availability Zone of the Dedicated Host.
AvailableCapacity availableCapacity
The number of new instances that can be launched onto the Dedicated Host.
String clientToken
Unique, case-sensitive identifier that you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
String hostId
The ID of the Dedicated Host.
HostProperties hostProperties
The hardware specifications of the Dedicated Host.
String hostReservationId
The reservation ID of the Dedicated Host. This returns a null
response if the Dedicated Host doesn't
have an associated reservation.
SdkInternalList<T> instances
The IDs and instance type that are currently running on the Dedicated Host.
String state
The Dedicated Host's state.
Date allocationTime
The time that the Dedicated Host was allocated.
Date releaseTime
The time that the Dedicated Host was released.
SdkInternalList<T> tags
Any tags assigned to the Dedicated Host.
String currencyCode
The currency of the offering.
Integer duration
The duration of the offering (in seconds).
String hourlyPrice
The hourly price of the offering.
String instanceFamily
The instance family of the offering.
String offeringId
The ID of the offering.
String paymentOption
The available payment option.
String upfrontPrice
The upfront price of the offering. Does not apply to No Upfront offerings.
Integer cores
The number of cores on the Dedicated Host.
String instanceType
The instance type size that the Dedicated Host supports (for example, m3.medium
).
Integer sockets
The number of sockets on the Dedicated Host.
Integer totalVCpus
The number of vCPUs on the Dedicated Host.
Integer count
The number of Dedicated Hosts the reservation is associated with.
String currencyCode
The currency in which the upfrontPrice
and hourlyPrice
amounts are specified. At this
time, the only supported currency is USD
.
Integer duration
The length of the reservation's term, specified in seconds. Can be 31536000 (1 year)
|
94608000 (3 years)
.
Date end
The date and time that the reservation ends.
SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts associated with the reservation.
String hostReservationId
The ID of the reservation that specifies the associated Dedicated Hosts.
String hourlyPrice
The hourly price of the reservation.
String instanceFamily
The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
String offeringId
The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
String paymentOption
The payment option selected for this reservation.
Date start
The date and time that the reservation started.
String state
The state of the reservation.
String upfrontPrice
The upfront price of the reservation.
String associationId
The ID of the association.
String instanceId
The ID of the instance.
IamInstanceProfile iamInstanceProfile
The IAM instance profile.
String state
The state of the association.
Date timestamp
The time the IAM instance profile was associated with the instance.
Date deadline
The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
String resource
The type of resource.
Boolean useLongIds
Indicates whether longer IDs (17-character IDs) are enabled for the resource.
String architecture
The architecture of the image.
String creationDate
The date and time the image was created.
String imageId
The ID of the AMI.
String imageLocation
The location of the AMI.
String imageType
The type of image.
Boolean publicValue
Indicates whether the image has public launch permissions. The value is true
if this image has
public launch permissions or false
if it has only implicit and explicit launch permissions.
String kernelId
The kernel associated with the image, if any. Only applicable for machine images.
String ownerId
The AWS account ID of the image owner.
String platform
The value is Windows
for Windows AMIs; otherwise blank.
SdkInternalList<T> productCodes
Any product codes associated with the AMI.
String ramdiskId
The RAM disk associated with the image, if any. Only applicable for machine images.
String state
The current state of the AMI. If the state is available
, the image is successfully registered and
can be used to launch an instance.
SdkInternalList<T> blockDeviceMappings
Any block device mapping entries.
String description
The description of the AMI that was provided during image creation.
Boolean enaSupport
Specifies whether enhanced networking with ENA is enabled.
String hypervisor
The hypervisor type of the image.
String imageOwnerAlias
The AWS account alias (for example, amazon
, self
) or the AWS account ID of the AMI
owner.
String name
The name of the AMI that was provided during image creation.
String rootDeviceName
The device name of the root device volume (for example, /dev/sda1
).
String rootDeviceType
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
String sriovNetSupport
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason stateReason
The reason for the state change.
SdkInternalList<T> tags
Any tags assigned to the image.
String virtualizationType
The type of virtualization of the AMI.
SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
String imageId
The ID of the AMI.
SdkInternalList<T> launchPermissions
One or more launch permissions.
SdkInternalList<T> productCodes
One or more product codes.
String description
A description for the AMI.
String kernelId
The kernel ID.
String ramdiskId
The RAM disk ID.
String sriovNetSupport
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
String description
The description of the disk image.
String deviceName
The block device mapping for the disk.
String format
The format of the disk image being imported.
Valid values: VHD
| VMDK
| OVA
String snapshotId
The ID of the EBS snapshot to be used for importing the snapshot.
String url
The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)
UserBucket userBucket
The S3 bucket for the disk image.
String architecture
The architecture of the virtual machine.
Valid values: i386
| x86_64
ClientData clientData
The client-specific data.
String clientToken
The token to enable idempotency for VM import requests.
String description
A description string for the import image task.
SdkInternalList<T> diskContainers
Information about the disk containers.
Boolean encrypted
Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used
unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId
. For more
information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
String hypervisor
The target hypervisor platform.
Valid values: xen
String kmsKeyId
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not
specified, the default CMK for EBS is used. If a KmsKeyId
is specified, the Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias, in the form alias/ExampleAlias
ARN using key ID. The ID ARN contains the arn:aws:kms
namespace, followed by the region of the CMK,
the AWS account ID of the CMK owner, the key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the region of the
CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even
though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the region that the AMI is being copied to.
String licenseType
The license type to be used for the Amazon Machine Image (AMI) after importing.
Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
Valid values: AWS
| BYOL
String platform
The operating system of the virtual machine.
Valid values: Windows
| Linux
String roleName
The name of the role to use when not using the default role, 'vmimport'.
String architecture
The architecture of the virtual machine.
String description
A description of the import task.
Boolean encrypted
Indicates whether the AMI is encypted.
String hypervisor
The target hypervisor of the import task.
String imageId
The ID of the Amazon Machine Image (AMI) created by the import task.
String importTaskId
The task ID of the import image task.
String kmsKeyId
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted AMI.
String licenseType
The license type of the virtual machine.
String platform
The operating system of the virtual machine.
String progress
The progress of the task.
SdkInternalList<T> snapshotDetails
Information about the snapshots.
String status
A brief status of the task.
String statusMessage
A detailed status message of the import task.
String architecture
The architecture of the virtual machine.
Valid values: i386
| x86_64
String description
A description of the import task.
Boolean encrypted
Indicates whether the image is encrypted.
String hypervisor
The target hypervisor for the import task.
Valid values: xen
String imageId
The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
String importTaskId
The ID of the import image task.
String kmsKeyId
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted image.
String licenseType
The license type of the virtual machine.
String platform
The description string for the import image task.
String progress
The percentage of progress of the import image task.
SdkInternalList<T> snapshotDetails
Information about the snapshots.
String status
A brief status for the import image task.
String statusMessage
A descriptive status message for the import image task.
String additionalInfo
Reserved.
String architecture
The architecture of the instance.
SdkInternalList<T> groupIds
One or more security group IDs.
SdkInternalList<T> groupNames
One or more security group names.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String instanceType
The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.
Boolean monitoring
Indicates whether monitoring is enabled.
Placement placement
The placement information for the instance.
String privateIpAddress
[EC2-VPC] An available IP address from the IP address range of the subnet.
String subnetId
[EC2-VPC] The ID of the subnet in which to launch the instance.
UserData userData
The Base64-encoded user data to make available to the instance.
String description
A description for the instance being imported.
SdkInternalList<T> diskImages
The disk image.
ImportInstanceLaunchSpecification launchSpecification
The launch specification.
String platform
The instance operating system.
ConversionTask conversionTask
Information about the conversion task.
String description
A description of the task.
String instanceId
The ID of the instance.
String platform
The instance operating system.
SdkInternalList<T> volumes
One or more volumes.
String availabilityZone
The Availability Zone where the resulting instance will reside.
Long bytesConverted
The number of bytes converted so far.
String description
A description of the task.
DiskImageDescription image
The image.
String status
The status of the import of this particular disk image.
String statusMessage
The status information or errors related to the disk image.
DiskImageVolumeDescription volume
The volume.
ClientData clientData
The client-specific data.
String clientToken
Token to enable idempotency for VM import requests.
String description
The description string for the import snapshot task.
SnapshotDiskContainer diskContainer
Information about the disk container.
Boolean encrypted
Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is
used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId
. For
more information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
String kmsKeyId
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is
not specified, the default CMK for EBS is used. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias, in the form alias/ExampleAlias
ARN using key ID. The ID ARN contains the arn:aws:kms
namespace, followed by the region of the CMK,
the AWS account ID of the CMK owner, the key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the region of the
CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even
though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the region that the snapshot is being copied to.
String roleName
The name of the role to use when not using the default role, 'vmimport'.
String description
A description of the import snapshot task.
String importTaskId
The ID of the import snapshot task.
SnapshotTaskDetail snapshotTaskDetail
Information about the import snapshot task.
String description
A description of the import snapshot task.
String importTaskId
The ID of the import snapshot task.
SnapshotTaskDetail snapshotTaskDetail
Describes an import snapshot task.
String availabilityZone
The Availability Zone for the resulting EBS volume.
String description
A description of the volume.
DiskImageDetail image
The disk image.
VolumeDetail volume
The volume size.
ConversionTask conversionTask
Information about the conversion task.
String availabilityZone
The Availability Zone where the resulting volume will reside.
Long bytesConverted
The number of bytes converted so far.
String description
The description you provided when starting the import volume task.
DiskImageDescription image
The image.
DiskImageVolumeDescription volume
The volume.
Integer amiLaunchIndex
The AMI launch index, which can be used to find this instance in the launch group.
String imageId
The ID of the AMI used to launch the instance.
String instanceId
The ID of the instance.
String instanceType
The instance type.
String kernelId
The kernel associated with this instance, if applicable.
String keyName
The name of the key pair, if this instance was launched with an associated key pair.
Date launchTime
The time the instance was launched.
Monitoring monitoring
The monitoring for the instance.
Placement placement
The location where the instance launched, if applicable.
String platform
The value is Windows
for Windows instances; otherwise blank.
String privateDnsName
(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the
Amazon EC2 network. This name is not available until the instance enters the running
state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
String privateIpAddress
The private IPv4 address assigned to the instance.
SdkInternalList<T> productCodes
The product codes attached to this instance, if applicable.
String publicDnsName
(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters
the running
state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your
VPC.
String publicIpAddress
The public IPv4 address assigned to the instance, if applicable.
String ramdiskId
The RAM disk associated with this instance, if applicable.
InstanceState state
The current state of the instance.
String stateTransitionReason
The reason for the most recent state transition. This might be an empty string.
String subnetId
[EC2-VPC] The ID of the subnet in which the instance is running.
String vpcId
[EC2-VPC] The ID of the VPC in which the instance is running.
String architecture
The architecture of the image.
SdkInternalList<T> blockDeviceMappings
Any block device mapping entries for the instance.
String clientToken
The idempotency token you provided when you launched the instance, if applicable.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Boolean enaSupport
Specifies whether enhanced networking with ENA is enabled.
String hypervisor
The hypervisor type of the instance.
IamInstanceProfile iamInstanceProfile
The IAM instance profile associated with the instance, if applicable.
String instanceLifecycle
Indicates whether this is a Spot Instance or a Scheduled Instance.
SdkInternalList<T> elasticGpuAssociations
The Elastic GPU associated with the instance.
SdkInternalList<T> networkInterfaces
[EC2-VPC] One or more network interfaces for the instance.
String rootDeviceName
The device name of the root device volume (for example, /dev/sda1
).
String rootDeviceType
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
SdkInternalList<T> securityGroups
One or more security groups for the instance.
Boolean sourceDestCheck
Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether
source/destination checking is enabled on the instance. A value of true
means that checking is
enabled, and false
means that checking is disabled. The value must be false
for the
instance to perform NAT. For more information, see NAT Instances in the
Amazon Virtual Private Cloud User Guide.
String spotInstanceRequestId
If the request is a Spot Instance request, the ID of the request.
String sriovNetSupport
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason stateReason
The reason for the most recent state transition.
SdkInternalList<T> tags
Any tags assigned to the instance.
String virtualizationType
The virtualization type of the instance.
CpuOptions cpuOptions
The CPU options for the instance.
String capacityReservationId
The ID of the Capacity Reservation.
CapacityReservationSpecificationResponse capacityReservationSpecification
Information about the Capacity Reservation targeting option.
SdkInternalList<T> groups
The security groups associated with the instance.
SdkInternalList<T> blockDeviceMappings
The block device mapping of the instance.
Boolean disableApiTermination
If the value is true
, you can't terminate the instance through the Amazon EC2 console, CLI, or API;
otherwise, you can.
Boolean enaSupport
Indicates whether enhanced networking with ENA is enabled.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O.
String instanceId
The ID of the instance.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String instanceType
The instance type.
String kernelId
The kernel ID.
SdkInternalList<T> productCodes
A list of product codes.
String ramdiskId
The RAM disk ID.
String rootDeviceName
The device name of the root device volume (for example, /dev/sda1
).
Boolean sourceDestCheck
Indicates whether source/destination checking is enabled. A value of true
means that checking is
enabled, and false
means that checking is disabled. This value must be false
for a NAT
instance to perform NAT.
String sriovNetSupport
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
String userData
The user data.
String deviceName
The device name (for example, /dev/sdh
or xvdh
).
EbsInstanceBlockDevice ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String deviceName
The device name (for example, /dev/sdh
or xvdh
).
EbsInstanceBlockDeviceSpecification ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String noDevice
suppress the specified device included in the block device mapping.
String virtualName
The virtual device name.
Integer availableCapacity
The number of instances that can still be launched onto the Dedicated Host.
String instanceType
The instance type size supported by the Dedicated Host.
Integer totalCapacity
The total number of instances that can be launched onto the Dedicated Host.
String ipv6Address
The IPv6 address.
String ipv6Address
The IPv6 address.
String marketType
The market type.
SpotMarketOptions spotOptions
The options for Spot Instances.
String instanceId
The ID of the instance.
Monitoring monitoring
The monitoring for the instance.
InstanceNetworkInterfaceAssociation association
The association information for an Elastic IPv4 associated with the network interface.
InstanceNetworkInterfaceAttachment attachment
The network interface attachment.
String description
The description.
SdkInternalList<T> groups
One or more security groups.
SdkInternalList<T> ipv6Addresses
One or more IPv6 addresses associated with the network interface.
String macAddress
The MAC address.
String networkInterfaceId
The ID of the network interface.
String ownerId
The ID of the AWS account that created the network interface.
String privateDnsName
The private DNS name.
String privateIpAddress
The IPv4 address of the network interface within the subnet.
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses associated with the network interface.
Boolean sourceDestCheck
Indicates whether to validate network traffic to or from this network interface.
String status
The status of the network interface.
String subnetId
The ID of the subnet.
String vpcId
The ID of the VPC.
Date attachTime
The time stamp when the attachment initiated.
String attachmentId
The ID of the network interface attachment.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
Integer deviceIndex
The index of the device on the instance for the network interface attachment.
String status
The attachment state.
Boolean associatePublicIpAddress
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can
only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an
existing one. You cannot specify more than one network interface in the request. If launching into a default
subnet, the default value is true
.
Boolean deleteOnTermination
If set to true
, the interface is deleted when the instance is terminated. You can specify
true
only if creating a new network interface when launching an instance.
String description
The description of the network interface. Applies only if creating a network interface when launching an instance.
Integer deviceIndex
The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
SdkInternalList<T> groups
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
Integer ipv6AddressCount
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
SdkInternalList<T> ipv6Addresses
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
String networkInterfaceId
The ID of the network interface.
String privateIpAddress
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
String subnetId
The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
InstanceNetworkInterfaceAssociation association
The association information for an Elastic IP address for the network interface.
Boolean primary
Indicates whether this IPv4 address is the primary private IP address of the network interface.
String privateDnsName
The private IPv4 DNS name.
String privateIpAddress
The private IPv4 address of the network interface.
InstanceState currentState
The current state of the instance.
String instanceId
The ID of the instance.
InstanceState previousState
The previous state of the instance.
String availabilityZone
The Availability Zone of the instance.
SdkInternalList<T> events
Any scheduled events associated with the instance.
String instanceId
The ID of the instance.
InstanceState instanceState
The intended state of the instance. DescribeInstanceStatus requires that an instance be in the
running
state.
InstanceStatusSummary instanceStatus
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
InstanceStatusSummary systemStatus
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
String code
The event code.
String description
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].
Date notAfter
The latest scheduled end time for the event.
Date notBefore
The earliest scheduled start time for the event.
SdkInternalList<T> details
The system instance health or application instance health.
String status
The status.
SdkInternalList<T> attachments
Any VPCs attached to the internet gateway.
String internetGatewayId
The ID of the internet gateway.
SdkInternalList<T> tags
Any tags assigned to the internet gateway.
Integer fromPort
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1
indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
String ipProtocol
The IP protocol name (tcp
, udp
, icmp
) or number (see Protocol Numbers).
[EC2-VPC only] Use -1
to specify all protocols. When authorizing security group rules, specifying
-1
or a protocol number other than tcp
, udp
, icmp
, or
58
(ICMPv6) allows traffic on all ports, regardless of any port range you specify. For
tcp
, udp
, and icmp
, you must specify a port range. For 58
(ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed when
authorizing rules.
SdkInternalList<T> ipv6Ranges
[EC2-VPC only] One or more IPv6 ranges.
SdkInternalList<T> prefixListIds
[EC2-VPC only] One or more prefix list IDs for an AWS service. With AuthorizeSecurityGroupEgress, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1
indicates
all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all
codes.
SdkInternalList<T> userIdGroupPairs
One or more security group and AWS account ID pairs.
SdkInternalList<T> ipv4Ranges
One or more IPv4 ranges.
String cidrIp
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
String description
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
String ipv6CidrBlock
The IPv6 CIDR block.
String cidrIpv6
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
String description
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
String keyFingerprint
If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
String keyName
The name of the key pair.
SdkInternalList<T> add
The AWS account ID to add to the list of launch permissions for the AMI.
SdkInternalList<T> remove
The AWS account ID to remove from the list of launch permissions for the AMI.
String userData
The Base64-encoded user data for the instance.
String addressingType
Deprecated.
SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
Boolean ebsOptimized
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String imageId
The ID of the AMI.
String instanceType
The instance type.
String kernelId
The ID of the kernel.
String keyName
The name of the key pair.
SdkInternalList<T> networkInterfaces
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotPlacement placement
The placement information for the instance.
String ramdiskId
The ID of the RAM disk.
String subnetId
The ID of the subnet in which to launch the instance.
SdkInternalList<T> allSecurityGroups
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
Boolean monitoringEnabled
SdkInternalList<T> securityGroups
One or more security group names.
String launchTemplateId
The ID of the launch template.
String launchTemplateName
The name of the launch template.
Date createTime
The time launch template was created.
String createdBy
The principal that created the launch template.
Long defaultVersionNumber
The version number of the default version of the launch template.
Long latestVersionNumber
The version number of the latest version of the launch template.
SdkInternalList<T> tags
The tags for the launch template.
FleetLaunchTemplateSpecification launchTemplateSpecification
The launch template.
FleetLaunchTemplateOverrides overrides
Any parameters that you specify override the same parameters in the launch template.
String deviceName
The device name.
String virtualName
The virtual device name (ephemeralN).
LaunchTemplateEbsBlockDevice ebs
Information about the block device for an EBS volume.
String noDevice
Suppresses the specified device included in the block device mapping of the AMI.
String deviceName
The device name (for example, /dev/sdh or xvdh).
String virtualName
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
LaunchTemplateEbsBlockDeviceRequest ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String noDevice
Suppresses the specified device included in the block device mapping of the AMI.
String capacityReservationPreference
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open
Capacity Reservation that has matching
attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs in On-Demand capacity.
CapacityReservationTarget capacityReservationTarget
Information about the target Capacity Reservation.
String capacityReservationPreference
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open
Capacity Reservation that has matching
attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs in On-Demand capacity.
CapacityReservationTargetResponse capacityReservationTarget
Information about the target Capacity Reservation.
FleetLaunchTemplateSpecification launchTemplateSpecification
The launch template.
SdkInternalList<T> overrides
Any parameters that you specify override the same parameters in the launch template.
Boolean encrypted
Indicates whether the EBS volume is encrypted.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports.
String kmsKeyId
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
String snapshotId
The ID of the snapshot.
Integer volumeSize
The size of the volume, in GiB.
String volumeType
The volume type.
Boolean encrypted
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
String kmsKeyId
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
String snapshotId
The ID of the snapshot.
Integer volumeSize
The size of the volume, in GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
String volumeType
The volume type.
String marketType
The market type.
LaunchTemplateSpotMarketOptions spotOptions
The options for Spot Instances.
String marketType
The market type.
LaunchTemplateSpotMarketOptionsRequest spotOptions
The options for Spot Instances.
Boolean associatePublicIpAddress
Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
String description
A description for the network interface.
Integer deviceIndex
The device index for the network interface attachment.
SdkInternalList<T> groups
The IDs of one or more security groups.
Integer ipv6AddressCount
The number of IPv6 addresses for the network interface.
SdkInternalList<T> ipv6Addresses
The IPv6 addresses for the network interface.
String networkInterfaceId
The ID of the network interface.
String privateIpAddress
The primary private IPv4 address of the network interface.
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses for the network interface.
String subnetId
The ID of the subnet for the network interface.
Boolean associatePublicIpAddress
Associates a public IPv4 address with eth0 for a new network interface.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
String description
A description for the network interface.
Integer deviceIndex
The device index for the network interface attachment.
SdkInternalList<T> groups
The IDs of one or more security groups.
Integer ipv6AddressCount
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
SdkInternalList<T> ipv6Addresses
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
String networkInterfaceId
The ID of the network interface.
String privateIpAddress
The primary private IPv4 address of the network interface.
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses to assign to a network interface.
String subnetId
The ID of the subnet for the network interface.
String instanceType
The instance type.
String spotPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance.
String subnetId
The ID of the subnet in which to launch the instances.
String availabilityZone
The Availability Zone in which to launch the instances.
Double weightedCapacity
The number of units provided by the specified instance type.
Double priority
The priority for the launch template override. If OnDemandAllocationStrategy is set to
prioritized
, Spot Fleet uses priority to determine which launch template override to use first in
fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at
0
. The lower the number, the higher the priority. If no number is set, the launch template override
has the lowest priority.
String availabilityZone
The Availability Zone of the instance.
String affinity
The affinity setting for the instance on the Dedicated Host.
String groupName
The name of the placement group for the instance.
String hostId
The ID of the Dedicated Host for the instance.
String tenancy
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of
dedicated
runs on single-tenant hardware.
String spreadDomain
Reserved for future use.
String availabilityZone
The Availability Zone for the instance.
String affinity
The affinity setting for an instance on a Dedicated Host.
String groupName
The name of the placement group for the instance.
String hostId
The ID of the Dedicated Host for the instance.
String tenancy
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
String spreadDomain
Reserved for future use.
Boolean enabled
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Boolean enabled
Specify true
to enable detailed monitoring. Otherwise, basic monitoring is enabled.
String maxPrice
The maximum hourly price you're willing to pay for the Spot Instances.
String spotInstanceType
The Spot Instance request type.
Integer blockDurationMinutes
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
Date validUntil
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted.
String maxPrice
The maximum hourly price you're willing to pay for the Spot Instances.
String spotInstanceType
The Spot Instance request type.
Integer blockDurationMinutes
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
Date validUntil
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
String resourceType
The type of resource.
SdkInternalList<T> tags
The tags for the resource.
String resourceType
The type of resource to tag. Currently, the resource types that support tagging on creation are
instance
and volume
. To tag a resource after it has been created, see
CreateTags.
SdkInternalList<T> tags
The tags to apply to the resource.
String launchTemplateId
The ID of the launch template.
String launchTemplateName
The name of the launch template.
Long versionNumber
The version number.
String versionDescription
The description for the version.
Date createTime
The time the version was created.
String createdBy
The principal that created the version.
Boolean defaultVersion
Indicates whether the version is the default version.
ResponseLaunchTemplateData launchTemplateData
Information about the launch template.
ClassicLoadBalancersConfig classicLoadBalancersConfig
The Classic Load Balancers.
TargetGroupsConfig targetGroupsConfig
The target groups.
SdkInternalList<T> add
The load permissions to add.
SdkInternalList<T> remove
The load permissions to remove.
String capacityReservationId
The ID of the Capacity Reservation.
Integer instanceCount
The number of instances for which to reserve capacity.
Date endDate
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
expired
when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate
value if EndDateType
is limited
. Omit
EndDate
if EndDateType
is unlimited
.
String endDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide
an EndDate
value if EndDateType
is unlimited
.
limited
- The Capacity Reservation expires automatically at a specified date and time. You must
provide an EndDate
value if EndDateType
is limited
.
Boolean returnValue
Information about the Capacity Reservation.
String excessCapacityTerminationPolicy
Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
String fleetId
The ID of the EC2 Fleet.
TargetCapacitySpecificationRequest targetCapacitySpecification
The size of the EC2 Fleet.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String fpgaImageId
The ID of the AFI.
String attribute
The name of the attribute.
String operationType
The operation type.
SdkInternalList<T> userIds
One or more AWS account IDs. This parameter is valid only when modifying the loadPermission
attribute.
SdkInternalList<T> userGroups
One or more user groups. This parameter is valid only when modifying the loadPermission
attribute.
SdkInternalList<T> productCodes
One or more product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid
only when modifying the productCodes
attribute.
LoadPermissionModifications loadPermission
The load permission for the AFI.
String description
A description for the AFI.
String name
A name for the AFI.
FpgaImageAttribute fpgaImageAttribute
Information about the attribute.
String autoPlacement
Specify whether to enable or disable auto-placement.
SdkInternalList<T> hostIds
The IDs of the Dedicated Hosts to modify.
SdkInternalList<T> successful
The IDs of the Dedicated Hosts that were successfully modified.
SdkInternalList<T> unsuccessful
The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
String principalArn
The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all
to
modify the ID format for all IAM users, IAM roles, and the root user of the account.
String resource
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
internet-gateway
| network-acl
| network-acl-association
|
network-interface
| network-interface-attachment
| prefix-list
|
route-table
| route-table-association
| security-group
|
subnet
| subnet-cidr-block-association
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
.
Alternatively, use the all-current
option to include all resource types that are currently within
their opt-in period for longer IDs.
Boolean useLongIds
Indicates whether the resource should use longer IDs (17-character IDs)
String resource
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
internet-gateway
| network-acl
| network-acl-association
|
network-interface
| network-interface-attachment
| prefix-list
|
route-table
| route-table-association
| security-group
|
subnet
| subnet-cidr-block-association
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
.
Alternatively, use the all-current
option to include all resource types that are currently within
their opt-in period for longer IDs.
Boolean useLongIds
Indicate whether the resource should use longer IDs (17-character IDs).
String attribute
The name of the attribute to modify. The valid values are description
, launchPermission
, and productCodes
.
String description
A new description for the AMI.
String imageId
The ID of the AMI.
LaunchPermissionModifications launchPermission
A new launch permission for the AMI.
String operationType
The operation type. This parameter can be used only when the Attribute
parameter is
launchPermission
.
SdkInternalList<T> productCodes
One or more DevPay product codes. After you add a product code to an AMI, it can't be removed.
SdkInternalList<T> userGroups
One or more user groups. This parameter can be used only when the Attribute
parameter is
launchPermission
.
SdkInternalList<T> userIds
One or more AWS account IDs. This parameter can be used only when the Attribute
parameter is
launchPermission
.
String value
The value of the attribute being modified. This parameter can be used only when the Attribute
parameter is description
or productCodes
.
Boolean sourceDestCheck
Specifies whether source/destination checking is enabled. A value of true
means that checking is
enabled, and false
means that checking is disabled. This value must be false
for a NAT
instance to perform NAT.
String attribute
The name of the attribute.
SdkInternalList<T> blockDeviceMappings
Modifies the DeleteOnTermination
attribute for volumes that are currently attached. The volume must
be owned by the caller. If no value is specified for DeleteOnTermination
, the default is
true
and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
Boolean disableApiTermination
If the value is true
, you can't terminate the instance using the Amazon EC2 console, CLI, or API;
otherwise, you can. You cannot use this parameter for Spot Instances.
Boolean ebsOptimized
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Boolean enaSupport
Set to true
to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
SdkInternalList<T> groups
[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.
String instanceId
The ID of the instance.
String instanceInitiatedShutdownBehavior
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String instanceType
Changes the instance type to the specified value. For more information, see Instance Types. If the instance
type is not valid, the error returned is InvalidInstanceAttributeValue
.
String kernel
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
String ramdisk
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
String sriovNetSupport
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the
instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
String userData
Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
String value
A new value for the attribute. Use only with the kernel
, ramdisk
, userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
attribute.
String instanceId
The ID of the instance to be modified.
CapacityReservationSpecification capacityReservationSpecification
Information about the Capacity Reservation targeting option.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String clientToken
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
SdkInternalList<T> instanceCreditSpecifications
Information about the credit option for CPU usage.
SdkInternalList<T> successfulInstanceCreditSpecifications
Information about the instances whose credit option for CPU usage was successfully modified.
SdkInternalList<T> unsuccessfulInstanceCreditSpecifications
Information about the instances whose credit option for CPU usage was not modified.
String affinity
The affinity setting for the instance.
String groupName
The name of the placement group in which to place the instance. For spread placement groups, the instance must
have a tenancy of default
. For cluster placement groups, the instance must have a tenancy of
default
or dedicated
.
To remove an instance from a placement group, specify an empty string ("").
String hostId
The ID of the Dedicated Host with which to associate the instance.
String instanceId
The ID of the instance that you are modifying.
String tenancy
The tenancy for the instance.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
String defaultVersion
The version number of the launch template to set as the default version.
LaunchTemplate launchTemplate
Information about the launch template.
NetworkInterfaceAttachmentChanges attachment
Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
String description
A description for the network interface.
SdkInternalList<T> groups
Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
String networkInterfaceId
The ID of the network interface.
Boolean sourceDestCheck
Indicates whether source/destination checking is enabled. A value of true
means checking is enabled,
and false
means checking is disabled. This value must be false
for a NAT instance to
perform NAT. For more information, see NAT Instances in the
Amazon Virtual Private Cloud User Guide.
SdkInternalList<T> reservedInstancesIds
The IDs of the Reserved Instances to modify.
String clientToken
A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
SdkInternalList<T> targetConfigurations
The configuration settings for the Reserved Instances to modify.
String reservedInstancesModificationId
The ID for the modification.
String attribute
The snapshot attribute to modify. Only volume creation permissions can be modified.
CreateVolumePermissionModifications createVolumePermission
A JSON representation of the snapshot attribute modification.
SdkInternalList<T> groupNames
The group to modify for the snapshot.
String operationType
The type of operation to perform to the attribute.
String snapshotId
The ID of the snapshot.
SdkInternalList<T> userIds
The account ID to modify for the snapshot.
String excessCapacityTerminationPolicy
Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
String spotFleetRequestId
The ID of the Spot Fleet request.
Integer targetCapacity
The size of the fleet.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
Boolean assignIpv6AddressOnCreation
Specify true
to indicate that network interfaces created in the specified subnet should be assigned
an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the
instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an
IPv6 address if it's created using version 2016-11-15
or later of the Amazon EC2 API.
Boolean mapPublicIpOnLaunch
Specify true
to indicate that network interfaces created in the specified subnet should be assigned
a public IPv4 address. This includes a network interface that's created when launching an instance into the
subnet (the instance therefore receives a public IPv4 address).
String subnetId
The ID of the subnet.
String volumeId
The ID of the volume.
Integer size
The target size of the volume, in GiB. The target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS volume sizes, see Amazon EBS Volume Types.
Default: If no size is specified, the existing size is retained.
String volumeType
The target EBS volume type of the volume.
Default: If no type is specified, the existing type is retained.
Integer iops
The target IOPS rate of the volume.
This is only valid for Provisioned IOPS SSD (io1
) volumes. For more information, see Provisioned
IOPS SSD (io1) Volumes.
Default: If no IOPS value is specified, the existing value is retained.
VolumeModification volumeModification
Information about the volume modification.
Boolean enableDnsHostnames
Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
Boolean enableDnsSupport
Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
String vpcId
The ID of the VPC.
String connectionNotificationId
The ID of the notification.
String connectionNotificationArn
The ARN for the SNS topic for the notification.
SdkInternalList<T> connectionEvents
One or more events for the endpoint. Valid values are Accept
, Connect
,
Delete
, and Reject
.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcEndpointId
The ID of the endpoint.
Boolean resetPolicy
(Gateway endpoint) Specify true
to reset the policy document to the default policy. The default
policy allows full access to the service.
String policyDocument
(Gateway endpoint) A policy document to attach to the endpoint. The policy must be in valid JSON format.
SdkInternalList<T> addRouteTableIds
(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
SdkInternalList<T> removeRouteTableIds
(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
SdkInternalList<T> addSubnetIds
(Interface endpoint) One or more subnet IDs in which to serve the endpoint.
SdkInternalList<T> removeSubnetIds
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
SdkInternalList<T> addSecurityGroupIds
(Interface endpoint) One or more security group IDs to associate with the network interface.
SdkInternalList<T> removeSecurityGroupIds
(Interface endpoint) One or more security group IDs to disassociate from the network interface.
Boolean privateDnsEnabled
(Interface endpoint) Indicate whether a private hosted zone is associated with the VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String serviceId
The ID of the service.
Boolean acceptanceRequired
Indicate whether requests to create an endpoint to your service must be accepted.
SdkInternalList<T> addNetworkLoadBalancerArns
The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
SdkInternalList<T> removeNetworkLoadBalancerArns
The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String serviceId
The ID of the service.
SdkInternalList<T> addAllowedPrincipals
The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).
SdkInternalList<T> removeAllowedPrincipals
The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
PeeringConnectionOptionsRequest accepterPeeringConnectionOptions
The VPC peering connection options for the accepter VPC.
PeeringConnectionOptionsRequest requesterPeeringConnectionOptions
The VPC peering connection options for the requester VPC.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
PeeringConnectionOptions accepterPeeringConnectionOptions
Information about the VPC peering connection options for the accepter VPC.
PeeringConnectionOptions requesterPeeringConnectionOptions
Information about the VPC peering connection options for the requester VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, returns an error.
String state
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
SdkInternalList<T> instanceIds
One or more instance IDs.
SdkInternalList<T> instanceMonitorings
The monitoring information.
String publicIp
The Elastic IP address.
Date createTime
The date and time the NAT gateway was created.
Date deleteTime
The date and time the NAT gateway was deleted, if applicable.
String failureCode
If the NAT gateway could not be created, specifies the error code for the failure. (
InsufficientFreeAddressesInSubnet
| Gateway.NotAttached
|
InvalidAllocationID.NotFound
| Resource.AlreadyAssociated
| InternalError
| InvalidSubnetID.NotFound
)
String failureMessage
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
SdkInternalList<T> natGatewayAddresses
Information about the IP addresses and network interface associated with the NAT gateway.
String natGatewayId
The ID of the NAT gateway.
ProvisionedBandwidth provisionedBandwidth
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String state
The state of the NAT gateway.
pending
: The NAT gateway is being created and is not ready to process traffic.
failed
: The NAT gateway could not be created. Check the failureCode
and
failureMessage
fields for the reason.
available
: The NAT gateway is able to process traffic. This status remains until you delete the NAT
gateway, and does not indicate the health of the NAT gateway.
deleting
: The NAT gateway is in the process of being terminated and may still be processing traffic.
deleted
: The NAT gateway has been terminated and is no longer processing traffic.
String subnetId
The ID of the subnet in which the NAT gateway is located.
String vpcId
The ID of the VPC in which the NAT gateway is located.
SdkInternalList<T> tags
The tags for the NAT gateway.
String allocationId
The allocation ID of the Elastic IP address that's associated with the NAT gateway.
String networkInterfaceId
The ID of the network interface associated with the NAT gateway.
String privateIp
The private IP address associated with the Elastic IP address.
String publicIp
The Elastic IP address associated with the NAT gateway.
SdkInternalList<T> associations
Any associations between the network ACL and one or more subnets
SdkInternalList<T> entries
One or more entries (rules) in the network ACL.
Boolean isDefault
Indicates whether this is the default network ACL for the VPC.
String networkAclId
The ID of the network ACL.
SdkInternalList<T> tags
Any tags assigned to the network ACL.
String vpcId
The ID of the VPC for the network ACL.
String cidrBlock
The IPv4 network range to allow or deny, in CIDR notation.
Boolean egress
Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP type and code.
String ipv6CidrBlock
The IPv6 network range to allow or deny, in CIDR notation.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to.
String protocol
The protocol number. A value of "-1" means all protocols.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Integer ruleNumber
The rule number for the entry. ACL entries are processed in ascending order by rule number.
NetworkInterfaceAssociation association
The association information for an Elastic IP address (IPv4) associated with the network interface.
NetworkInterfaceAttachment attachment
The network interface attachment.
String availabilityZone
The Availability Zone.
String description
A description.
SdkInternalList<T> groups
Any security groups for the network interface.
String interfaceType
The type of interface.
SdkInternalList<T> ipv6Addresses
The IPv6 addresses associated with the network interface.
String macAddress
The MAC address.
String networkInterfaceId
The ID of the network interface.
String ownerId
The AWS account ID of the owner of the network interface.
String privateDnsName
The private DNS name.
String privateIpAddress
The IPv4 address of the network interface within the subnet.
SdkInternalList<T> privateIpAddresses
The private IPv4 addresses associated with the network interface.
String requesterId
The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).
Boolean requesterManaged
Indicates whether the network interface is being managed by AWS.
Boolean sourceDestCheck
Indicates whether traffic to or from the instance is validated.
String status
The status of the network interface.
String subnetId
The ID of the subnet.
SdkInternalList<T> tagSet
Any tags assigned to the network interface.
String vpcId
The ID of the VPC.
String allocationId
The allocation ID.
String associationId
The association ID.
String ipOwnerId
The ID of the Elastic IP address owner.
String publicDnsName
The public DNS name.
String publicIp
The address of the Elastic IP address bound to the network interface.
Date attachTime
The timestamp indicating when the attachment initiated.
String attachmentId
The ID of the network interface attachment.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
Integer deviceIndex
The device index of the network interface attachment on the instance.
String instanceId
The ID of the instance.
String instanceOwnerId
The AWS account ID of the owner of the instance.
String status
The attachment state.
String ipv6Address
The IPv6 address.
String networkInterfacePermissionId
The ID of the network interface permission.
String networkInterfaceId
The ID of the network interface.
String awsAccountId
The AWS account ID.
String awsService
The AWS service.
String permission
The type of permission.
NetworkInterfacePermissionState permissionState
Information about the state of the permission.
NetworkInterfaceAssociation association
The association information for an Elastic IP address (IPv4) associated with the network interface.
Boolean primary
Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
String privateDnsName
The private DNS name.
String privateIpAddress
The private IPv4 address.
String allocationStrategy
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
lowest-price
, EC2 Fleet uses price to determine the order, launching the lowest price first. If you
specify prioritized
, EC2 Fleet uses the priority that you assigned to each launch template override,
launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to
lowest-price
.
Boolean singleInstanceType
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Integer minTargetCapacity
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
String allocationStrategy
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
lowest-price
, EC2 Fleet uses price to determine the order, launching the lowest price first. If you
specify prioritized
, EC2 Fleet uses the priority that you assigned to each launch template override,
launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to
lowest-price
.
Boolean singleInstanceType
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Integer minTargetCapacity
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Boolean allowDnsResolutionFromRemoteVpc
If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.
Boolean allowEgressFromLocalClassicLinkToRemoteVpc
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
Boolean allowEgressFromLocalVpcToRemoteClassicLink
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
Boolean allowDnsResolutionFromRemoteVpc
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
Boolean allowEgressFromLocalClassicLinkToRemoteVpc
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
Boolean allowEgressFromLocalVpcToRemoteClassicLink
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
String availabilityZone
The Availability Zone of the instance.
String affinity
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
String groupName
The name of the placement group the instance is in.
String hostId
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
String tenancy
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of
dedicated
runs on single-tenant hardware. The host
tenancy is not supported for the
ImportInstance command.
String spreadDomain
Reserved for future use.
String groupName
The name of the placement group the instance is in.
SdkInternalList<T> cidrs
The IP address range of the AWS service.
String prefixListId
The ID of the prefix.
String prefixListName
The name of the prefix.
Boolean active
The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
String currencyCode
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
USD
.
Double price
The fixed price for the term.
Long term
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
String currencyCode
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
USD
.
Double price
The fixed price for the term.
Long term
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
String arn
PrincipalIdFormatARN description
SdkInternalList<T> statuses
PrincipalIdFormatStatuses description
String gatewayId
The ID of the virtual private gateway.
String cidr
The public IPv4 address range, in CIDR notation. The most specific prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this or another region.
CidrAuthorizationContext cidrAuthorizationContext
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
String description
A description for the address range and the address pool.
ByoipCidr byoipCidr
Information about the address pool.
Date provisionTime
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String provisioned
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
Date requestTime
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String requested
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String status
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String poolId
The ID of the IPv4 address pool.
String description
A description of the address pool.
SdkInternalList<T> poolAddressRanges
The address ranges.
Integer totalAddressCount
The total number of addresses.
Integer totalAvailableAddressCount
The total number of available addresses.
String firstAddress
The first IP address in the range.
String lastAddress
The last IP address in the range.
Integer addressCount
The number of addresses in the range.
Integer availableAddressCount
The number of available addresses in the range.
String currencyCode
The currency in which the UpfrontPrice
and HourlyPrice
amounts are specified. At this
time, the only supported currency is USD
.
Integer duration
The duration of the reservation's term in seconds.
SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts associated with the reservation.
String hostReservationId
The ID of the reservation.
String hourlyPrice
The hourly price of the reservation per hour.
String instanceFamily
The instance family on the Dedicated Host that the reservation can be associated with.
String paymentOption
The payment option for the reservation.
String upfrontPrice
The upfront price of the reservation.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
String currencyCode
The currency in which the totalUpfrontPrice
, LimitPrice
, and
totalHourlyPrice
amounts are specified. At this time, the only supported currency is
USD
.
SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts with which the reservation will be associated.
String limitPrice
The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's
upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit,
the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the
purchase. At this time, the only supported currency is USD
. For example, to indicate a limit price
of USD 100, specify 100.00.
String offeringId
The ID of the offering.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
String currencyCode
The currency in which the totalUpfrontPrice
and totalHourlyPrice
amounts are specified.
At this time, the only supported currency is USD
.
SdkInternalList<T> purchase
Describes the details of the purchase.
String totalHourlyPrice
The total hourly price of the reservation calculated per hour.
String totalUpfrontPrice
The total amount charged to your account when you purchase the reservation.
Integer instanceCount
The number of Reserved Instances to purchase.
String reservedInstancesOfferingId
The ID of the Reserved Instance offering to purchase.
ReservedInstanceLimitPrice limitPrice
Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
String reservedInstancesId
The IDs of the purchased Reserved Instances.
String clientToken
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
SdkInternalList<T> purchaseRequests
One or more purchase requests.
SdkInternalList<T> scheduledInstanceSet
Information about the Scheduled Instances.
SdkInternalList<T> instanceIds
One or more instance IDs.
String imageLocation
The full path to your AMI manifest in Amazon S3 storage.
String architecture
The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386
. For instance store-backed AMIs, the architecture
specified in the manifest file.
SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
String description
A description for your AMI.
Boolean enaSupport
Set to true
to enable enhanced networking with ENA for the AMI and any instances that you launch
from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
String kernelId
The ID of the kernel.
String name
A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
SdkInternalList<T> billingProducts
The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.
String ramdiskId
The ID of the RAM disk.
String rootDeviceName
The device name of the root device volume (for example, /dev/sda1
).
String sriovNetSupport
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the
AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport
at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
String virtualizationType
The type of virtualization (hvm
| paravirtual
).
Default: paravirtual
String imageId
The ID of the newly registered AMI.
String serviceId
The ID of the service.
SdkInternalList<T> vpcEndpointIds
The IDs of one or more VPC endpoints.
SdkInternalList<T> unsuccessful
Information about the endpoints that were not rejected, if applicable.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
SdkInternalList<T> hostIds
The IDs of the Dedicated Hosts to release.
SdkInternalList<T> successful
The IDs of the Dedicated Hosts that were successfully released.
SdkInternalList<T> unsuccessful
The IDs of the Dedicated Hosts that could not be released, including an error message.
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String associationId
The ID of the existing IAM instance profile association.
IamInstanceProfileAssociation iamInstanceProfileAssociation
Information about the IAM instance profile association.
String newAssociationId
The ID of the new association.
String cidrBlock
The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24
).
Boolean egress
Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
String ipv6CidrBlock
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64
).
String networkAclId
The ID of the ACL.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
String protocol
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Integer ruleNumber
The rule number of the entry to replace.
String destinationCidrBlock
The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
String destinationIpv6CidrBlock
The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
String egressOnlyInternetGatewayId
[IPv6 traffic only] The ID of an egress-only internet gateway.
String gatewayId
The ID of an internet gateway or virtual private gateway.
String instanceId
The ID of a NAT instance in your VPC.
String natGatewayId
[IPv4 traffic only] The ID of a NAT gateway.
String networkInterfaceId
The ID of a network interface.
String routeTableId
The ID of the route table.
String vpcPeeringConnectionId
The ID of a VPC peering connection.
String newAssociationId
The ID of the new association.
String description
Descriptive text about the health state of your instance.
Date endTime
The time at which the reported instance health state ended.
SdkInternalList<T> instances
One or more instances.
SdkInternalList<T> reasonCodes
One or more reason codes that describe the health state of your instance.
instance-stuck-in-state
: My instance is stuck in a state.
unresponsive
: My instance is unresponsive.
not-accepting-credentials
: My instance is not accepting my credentials.
password-not-available
: A password is not available for my instance.
performance-network
: My instance is experiencing performance problems that I believe are network
related.
performance-instance-store
: My instance is experiencing performance problems that I believe are
related to the instance stores.
performance-ebs-volume
: My instance is experiencing performance problems that I believe are related
to an EBS volume.
performance-other
: My instance is experiencing performance problems.
other
: [explain using the description parameter]
Date startTime
The time at which the reported instance health state began.
String status
The status of all instances listed.
String kernelId
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
LaunchTemplateIamInstanceProfileSpecificationRequest iamInstanceProfile
The IAM instance profile.
SdkInternalList<T> blockDeviceMappings
The block device mapping.
Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
SdkInternalList<T> networkInterfaces
One or more network interfaces.
String imageId
The ID of the AMI, which you can get by using DescribeImages.
String instanceType
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
String keyName
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
LaunchTemplatesMonitoringRequest monitoring
The monitoring for the instance.
LaunchTemplatePlacementRequest placement
The placement for the instance.
String ramDiskId
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.
Boolean disableApiTermination
If set to true
, you can't terminate the instance using the Amazon EC2 console, CLI, or API. To
change this attribute to false
after launch, use ModifyInstanceAttribute.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
String userData
The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).
SdkInternalList<T> tagSpecifications
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
SdkInternalList<T> elasticGpuSpecifications
An elastic GPU to associate with the instance.
SdkInternalList<T> securityGroupIds
One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
SdkInternalList<T> securityGroups
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
LaunchTemplateInstanceMarketOptionsRequest instanceMarketOptions
The market (purchasing) option for the instances.
CreditSpecificationRequest creditSpecification
The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.
LaunchTemplateCpuOptionsRequest cpuOptions
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.
LaunchTemplateCapacityReservationSpecificationRequest capacityReservationSpecification
Information about the Capacity Reservation targeting option.
SpotFleetRequestConfigData spotFleetRequestConfig
The configuration for the Spot Fleet request.
String spotFleetRequestId
The ID of the Spot Fleet request.
String availabilityZoneGroup
The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
Integer blockDurationMinutes
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
You can't specify an Availability Zone group or a launch group if you specify a duration.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.
Integer instanceCount
The maximum number of Spot Instances to launch.
Default: 1
String launchGroup
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
LaunchSpecification launchSpecification
The launch specification.
String spotPrice
The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
String type
The Spot Instance request type.
Default: one-time
Date validFrom
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
Date validUntil
The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
SdkInternalList<T> spotInstanceRequests
One or more Spot Instance requests.
SdkInternalList<T> groups
[EC2-Classic only] One or more security groups.
SdkInternalList<T> instances
One or more instances.
String ownerId
The ID of the AWS account that owns the reservation.
String requesterId
The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).
String reservationId
The ID of the reservation.
SdkInternalList<T> groupNames
One or more security group names.
String hourlyPrice
The hourly rate of the reservation.
String remainingTotalValue
The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
String remainingUpfrontValue
The remaining upfront cost of the reservation.
ReservationValue reservationValue
The total value of the Convertible Reserved Instance that you are exchanging.
String reservedInstanceId
The ID of the Convertible Reserved Instance that you are exchanging.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
Long duration
The duration of the Reserved Instance, in seconds.
Date end
The time when the Reserved Instance expires.
Float fixedPrice
The purchase price of the Reserved Instance.
Integer instanceCount
The number of reservations purchased.
String instanceType
The instance type on which the Reserved Instance can be used.
String productDescription
The Reserved Instance product platform description.
String reservedInstancesId
The ID of the Reserved Instance.
Date start
The date and time the Reserved Instance started.
String state
The state of the Reserved Instance purchase.
Float usagePrice
The usage price of the Reserved Instance, per hour.
String currencyCode
The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the
only supported currency is USD
.
String instanceTenancy
The tenancy of the instance.
String offeringClass
The offering class of the Reserved Instance.
String offeringType
The Reserved Instance offering type.
SdkInternalList<T> recurringCharges
The recurring charge tag assigned to the resource.
String scope
The scope of the Reserved Instance.
SdkInternalList<T> tags
Any tags assigned to the resource.
String availabilityZone
The Availability Zone for the modified Reserved Instances.
Integer instanceCount
The number of modified Reserved Instances.
String instanceType
The instance type for the modified Reserved Instances.
String platform
The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
String scope
Whether the Reserved Instance is applied to instances in a region or instances in a specific Availability Zone.
String reservedInstancesId
The ID of the Reserved Instance.
String clientToken
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
Date createDate
The time the listing was created.
SdkInternalList<T> instanceCounts
The number of instances in this state.
SdkInternalList<T> priceSchedules
The price of the Reserved Instance listing.
String reservedInstancesId
The ID of the Reserved Instance.
String reservedInstancesListingId
The ID of the Reserved Instance listing.
String status
The status of the Reserved Instance listing.
String statusMessage
The reason for the current status of the Reserved Instance listing. The response can be blank.
SdkInternalList<T> tags
Any tags assigned to the resource.
Date updateDate
The last modified timestamp of the listing.
String clientToken
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
Date createDate
The time when the modification request was created.
Date effectiveDate
The time for the modification to become effective.
SdkInternalList<T> modificationResults
Contains target configurations along with their corresponding new Reserved Instance IDs.
SdkInternalList<T> reservedInstancesIds
The IDs of one or more Reserved Instances.
String reservedInstancesModificationId
A unique ID for the Reserved Instance modification.
String status
The status of the Reserved Instances modification request.
String statusMessage
The reason for the status.
Date updateDate
The time when the modification request was last updated.
String reservedInstancesId
The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
ReservedInstancesConfiguration targetConfiguration
The target Reserved Instances configurations supplied as part of the modification request.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
Long duration
The duration of the Reserved Instance, in seconds.
Float fixedPrice
The purchase price of the Reserved Instance.
String instanceType
The instance type on which the Reserved Instance can be used.
String productDescription
The Reserved Instance product platform description.
String reservedInstancesOfferingId
The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
Float usagePrice
The usage price of the Reserved Instance, per hour.
String currencyCode
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard
currency codes. At this time, the only supported currency is USD
.
String instanceTenancy
The tenancy of the instance.
Boolean marketplace
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a
Reserved Instance Marketplace offering, this is true
.
String offeringClass
If convertible
it can be exchanged for Reserved Instances of the same or higher monetary value, with
different configurations. If standard
, it is not possible to perform an exchange.
String offeringType
The Reserved Instance offering type.
SdkInternalList<T> pricingDetails
The pricing details of the Reserved Instance offering.
SdkInternalList<T> recurringCharges
The recurring charge tag assigned to the resource.
String scope
Whether the Reserved Instance is applied to instances in a region or an Availability Zone.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String attribute
The attribute to reset.
You can only reset the following attributes: kernel
| ramdisk
|
sourceDestCheck
. To change an instance attribute, use ModifyInstanceAttribute.
String instanceId
The ID of the instance.
String kernelId
The ID of the kernel, if applicable.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O.
LaunchTemplateIamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
SdkInternalList<T> blockDeviceMappings
The block device mappings.
SdkInternalList<T> networkInterfaces
The network interfaces.
String imageId
The ID of the AMI that was used to launch the instance.
String instanceType
The instance type.
String keyName
The name of the key pair.
LaunchTemplatesMonitoring monitoring
The monitoring for the instance.
LaunchTemplatePlacement placement
The placement of the instance.
String ramDiskId
The ID of the RAM disk, if applicable.
Boolean disableApiTermination
If set to true
, indicates that the instance cannot be terminated using the Amazon EC2 console,
command line tool, or API.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String userData
The user data for the instance.
SdkInternalList<T> tagSpecifications
The tags.
SdkInternalList<T> elasticGpuSpecifications
The elastic GPU specification.
SdkInternalList<T> securityGroupIds
The security group IDs.
SdkInternalList<T> securityGroups
The security group names.
LaunchTemplateInstanceMarketOptions instanceMarketOptions
The market (purchasing) option for the instances.
CreditSpecification creditSpecification
The credit option for CPU usage of the instance.
LaunchTemplateCpuOptions cpuOptions
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.
LaunchTemplateCapacityReservationSpecificationResponse capacityReservationSpecification
Information about the Capacity Reservation targeting option.
String publicIp
The Elastic IP address.
String groupId
The ID of the security group.
SdkInternalList<T> ipPermissions
One or more sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
String cidrIp
Not supported. Use a set of IP permissions to specify the CIDR.
Integer fromPort
Not supported. Use a set of IP permissions to specify the port.
String ipProtocol
Not supported. Use a set of IP permissions to specify the protocol name or number.
Integer toPort
Not supported. Use a set of IP permissions to specify the port.
String sourceSecurityGroupName
Not supported. Use a set of IP permissions to specify a destination security group.
String sourceSecurityGroupOwnerId
Not supported. Use a set of IP permissions to specify a destination security group.
String cidrIp
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
Integer fromPort
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use
-1
to specify all ICMP types.
String groupId
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
String groupName
[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
SdkInternalList<T> ipPermissions
One or more sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
String ipProtocol
The IP protocol name (tcp
, udp
, icmp
) or number (see Protocol Numbers). Use
-1
to specify all.
String sourceSecurityGroupName
[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
String sourceSecurityGroupOwnerId
[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use
-1
to specify all ICMP codes for the ICMP type.
String destinationCidrBlock
The IPv4 CIDR block used for the destination match.
String destinationIpv6CidrBlock
The IPv6 CIDR block used for the destination match.
String destinationPrefixListId
The prefix of the AWS service.
String egressOnlyInternetGatewayId
The ID of the egress-only internet gateway.
String gatewayId
The ID of a gateway attached to your VPC.
String instanceId
The ID of a NAT instance in your VPC.
String instanceOwnerId
The AWS account ID of the owner of the instance.
String natGatewayId
The ID of a NAT gateway.
String networkInterfaceId
The ID of the network interface.
String origin
Describes how the route was created.
CreateRouteTable
- The route was automatically created when the route table was created.
CreateRoute
- The route was manually added to the route table.
EnableVgwRoutePropagation
- The route was propagated by route propagation.
String state
The state of the route. The blackhole
state indicates that the route's target isn't available (for
example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
String vpcPeeringConnectionId
The ID of the VPC peering connection.
SdkInternalList<T> associations
The associations between the route table and one or more subnets.
SdkInternalList<T> propagatingVgws
Any virtual private gateway (VGW) propagating routes.
String routeTableId
The ID of the route table.
SdkInternalList<T> routes
The routes in the route table.
SdkInternalList<T> tags
Any tags assigned to the route table.
String vpcId
The ID of the VPC.
Boolean main
Indicates whether this is the main route table.
String routeTableAssociationId
The ID of the association between a route table and a subnet.
String routeTableId
The ID of the route table.
String subnetId
The ID of the subnet. A subnet ID is not returned for an implicit association.
SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
String imageId
The ID of the AMI, which you can get by calling DescribeImages. An AMI is required to launch an instance and must be specified here or in a launch template.
String instanceType
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
Integer ipv6AddressCount
[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
SdkInternalList<T> ipv6Addresses
[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
String kernelId
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
String keyName
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
Integer maxCount
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target
Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount
.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
Integer minCount
The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
Boolean monitoring
The monitoring for the instance.
Placement placement
The placement for the instance.
String ramdiskId
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
SdkInternalList<T> securityGroupIds
One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
SdkInternalList<T> securityGroups
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.
Default: Amazon EC2 uses the default security group.
String subnetId
[EC2-VPC] The ID of the subnet to launch the instance into.
String userData
The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
String additionalInfo
Reserved.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
Boolean disableApiTermination
If you set this parameter to true
, you can't terminate the instance using the Amazon EC2 console,
CLI, or API; otherwise, you can. To change this attribute to false
after launch, use
ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior
to
terminate
, you can terminate the instance by running the shutdown command from the instance.
Default: false
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
SdkInternalList<T> networkInterfaces
One or more network interfaces.
String privateIpAddress
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
SdkInternalList<T> elasticGpuSpecification
An elastic GPU to associate with the instance.
SdkInternalList<T> tagSpecifications
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
LaunchTemplateSpecification launchTemplate
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
InstanceMarketOptionsRequest instanceMarketOptions
The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when
InstanceInterruptionBehavior is set to either hibernate
or stop
.
CreditSpecificationRequest creditSpecification
The credit option for CPU usage of the instance. Valid values are standard
and
unlimited
. To change this attribute after launch, use ModifyInstanceCreditSpecification. For
more information, see Burstable
Performance Instances in the Amazon Elastic Compute Cloud User Guide.
Default: standard
(T2 instances) or unlimited
(T3 instances)
CpuOptionsRequest cpuOptions
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.
CapacityReservationSpecification capacityReservationSpecification
Information about the Capacity Reservation targeting option.
Reservation reservation
Describes a reservation.
String clientToken
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
Integer instanceCount
The number of instances.
Default: 1
ScheduledInstancesLaunchSpecification launchSpecification
The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.
String scheduledInstanceId
The Scheduled Instance ID.
SdkInternalList<T> instanceIdSet
The IDs of the newly launched instances.
String aWSAccessKeyId
The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.
String bucket
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
String prefix
The beginning of the file name of the AMI.
String uploadPolicy
An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
String uploadPolicySignature
The signature of the JSON document.
String availabilityZone
The Availability Zone.
Date createDate
The date when the Scheduled Instance was purchased.
String hourlyPrice
The hourly price for a single instance.
Integer instanceCount
The number of instances.
String instanceType
The instance type.
String networkPlatform
The network platform (EC2-Classic
or EC2-VPC
).
Date nextSlotStartTime
The time for the next schedule to start.
String platform
The platform (Linux/UNIX
or Windows
).
Date previousSlotEndTime
The time that the previous schedule ended or will end.
ScheduledInstanceRecurrence recurrence
The schedule recurrence.
String scheduledInstanceId
The Scheduled Instance ID.
Integer slotDurationInHours
The number of hours in the schedule.
Date termEndDate
The end date for the Scheduled Instance.
Date termStartDate
The start date for the Scheduled Instance.
Integer totalScheduledInstanceHours
The total number of hours for a single instance for the entire term.
String availabilityZone
The Availability Zone.
Integer availableInstanceCount
The number of available instances.
Date firstSlotStartTime
The time period for the first schedule to start.
String hourlyPrice
The hourly price for a single instance.
String instanceType
The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
Integer maxTermDurationInDays
The maximum term. The only possible value is 365 days.
Integer minTermDurationInDays
The minimum term. The only possible value is 365 days.
String networkPlatform
The network platform (EC2-Classic
or EC2-VPC
).
String platform
The platform (Linux/UNIX
or Windows
).
String purchaseToken
The purchase token. This token expires in two hours.
ScheduledInstanceRecurrence recurrence
The schedule recurrence.
Integer slotDurationInHours
The number of hours in the schedule.
Integer totalScheduledInstanceHours
The total number of hours for a single instance for the entire term.
String frequency
The frequency (Daily
, Weekly
, or Monthly
).
Integer interval
The interval quantity. The interval unit depends on the value of frequency
. For example, every 2
weeks or every 2 months.
SdkInternalList<T> occurrenceDaySet
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
Boolean occurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month.
String occurrenceUnit
The unit for occurrenceDaySet
(DayOfWeek
or DayOfMonth
).
String frequency
The frequency (Daily
, Weekly
, or Monthly
).
Integer interval
The interval quantity. The interval unit depends on the value of Frequency
. For example, every 2
weeks or every 2 months.
SdkInternalList<T> occurrenceDays
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
Boolean occurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
String occurrenceUnit
The unit for OccurrenceDays
(DayOfWeek
or DayOfMonth
). This value is
required for a monthly schedule. You can't specify DayOfWeek
with a weekly schedule. You can't
specify this value with a daily schedule.
String deviceName
The device name (for example, /dev/sdh
or xvdh
).
ScheduledInstancesEbs ebs
Parameters used to set up EBS volumes automatically when the instance is launched.
String noDevice
Suppresses the specified device included in the block device mapping of the AMI.
String virtualName
The virtual device name (ephemeral
N). Instance store volumes are numbered starting from 0. An
instance type with two available instance store volumes can specify mappings for ephemeral0
and
ephemeral1
. The number of available instance store volumes depends on the instance type. After you
connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Boolean deleteOnTermination
Indicates whether the volume is deleted on instance termination.
Boolean encrypted
Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports. For io1 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. For more
information about gp2
baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the
Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100-20000 IOPS for io1
volumes and 100-10000 IOPS for gp2
volumes.
Condition: This parameter is required for requests to create io1
volumes; it is not used in requests
to create gp2
, st1
, sc1
, or standard
volumes.
String snapshotId
The ID of the snapshot.
Integer volumeSize
The size of the volume, in GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
String volumeType
The volume type. gp2
for General Purpose SSD, io1
for Provisioned IOPS SSD, Throughput
Optimized HDD for st1
, Cold HDD for sc1
, or standard
for Magnetic.
Default: standard
String ipv6Address
The IPv6 address.
SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
Boolean ebsOptimized
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
ScheduledInstancesIamInstanceProfile iamInstanceProfile
The IAM instance profile.
String imageId
The ID of the Amazon Machine Image (AMI).
String instanceType
The instance type.
String kernelId
The ID of the kernel.
String keyName
The name of the key pair.
ScheduledInstancesMonitoring monitoring
Enable or disable monitoring for the instances.
SdkInternalList<T> networkInterfaces
One or more network interfaces.
ScheduledInstancesPlacement placement
The placement information.
String ramdiskId
The ID of the RAM disk.
SdkInternalList<T> securityGroupIds
The IDs of one or more security groups.
String subnetId
The ID of the subnet in which to launch the instances.
String userData
The base64-encoded MIME user data.
Boolean enabled
Indicates whether monitoring is enabled.
Boolean associatePublicIpAddress
Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can
only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an
existing one. You cannot specify more than one network interface in the request. If launching into a default
subnet, the default value is true
.
Boolean deleteOnTermination
Indicates whether to delete the interface when the instance is terminated.
String description
The description.
Integer deviceIndex
The index of the device for the network interface attachment.
SdkInternalList<T> groups
The IDs of one or more security groups.
Integer ipv6AddressCount
The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.
SdkInternalList<T> ipv6Addresses
One or more specific IPv6 addresses from the subnet range.
String networkInterfaceId
The ID of the network interface.
String privateIpAddress
The IPv4 address of the network interface within the subnet.
SdkInternalList<T> privateIpAddressConfigs
The private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses.
String subnetId
The ID of the subnet.
String description
A description of the security group.
String groupName
The name of the security group.
SdkInternalList<T> ipPermissions
One or more inbound rules associated with the security group.
String ownerId
The AWS account ID of the owner of the security group.
String groupId
The ID of the security group.
SdkInternalList<T> ipPermissionsEgress
[EC2-VPC] One or more outbound rules associated with the security group.
SdkInternalList<T> tags
Any tags assigned to the security group.
String vpcId
[EC2-VPC] The ID of the VPC for the security group.
SdkInternalList<T> serviceType
The type of service.
String serviceId
The ID of the service.
String serviceName
The name of the service.
String serviceState
The service state.
SdkInternalList<T> availabilityZones
In the Availability Zones in which the service is available.
Boolean acceptanceRequired
Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
SdkInternalList<T> networkLoadBalancerArns
The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
SdkInternalList<T> baseEndpointDnsNames
The DNS names for the service.
String privateDnsName
The private DNS name for the service.
String serviceName
The Amazon Resource Name (ARN) of the service.
SdkInternalList<T> serviceType
The type of service.
SdkInternalList<T> availabilityZones
The Availability Zones in which the service is available.
String owner
The AWS account ID of the service owner.
SdkInternalList<T> baseEndpointDnsNames
The DNS names for the service.
String privateDnsName
The private DNS name for the service.
Boolean vpcEndpointPolicySupported
Indicates whether the service supports endpoint policies.
Boolean acceptanceRequired
Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
String serviceType
The type of service.
Date earliestTime
The earliest date and time, in UTC, for the Scheduled Instance to start.
Date latestTime
The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
String dataEncryptionKeyId
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.
String description
The description for the snapshot.
Boolean encrypted
Indicates whether the snapshot is encrypted.
String kmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
String ownerId
The AWS account ID of the EBS snapshot owner.
String progress
The progress of the snapshot, as a percentage.
String snapshotId
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
Date startTime
The time stamp when the snapshot was initiated.
String state
The snapshot state.
String stateMessage
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.
String volumeId
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
Integer volumeSize
The size of the volume, in GiB.
String ownerAlias
Value from an Amazon-maintained list (amazon
| aws-marketplace
| microsoft
) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM
console.
SdkInternalList<T> tags
Any tags assigned to the snapshot.
String description
A description for the snapshot.
String deviceName
The block device mapping for the snapshot.
Double diskImageSize
The size of the disk in the snapshot, in GiB.
String format
The format of the disk image from which the snapshot is created.
String progress
The percentage of progress for the task.
String snapshotId
The snapshot ID of the disk being imported.
String status
A brief status of the snapshot creation.
String statusMessage
A detailed status message for the snapshot creation.
String url
The URL used to access the disk image.
UserBucketDetails userBucket
The S3 bucket for the disk image.
String description
The description of the disk image being imported.
String format
The format of the disk image being imported.
Valid values: VHD
| VMDK
| OVA
String url
The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).
UserBucket userBucket
The S3 bucket for the disk image.
String description
The description of the snapshot.
Double diskImageSize
The size of the disk in the snapshot, in GiB.
Boolean encrypted
Indicates whether the snapshot is encrypted.
String format
The format of the disk image from which the snapshot is created.
String kmsKeyId
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted snapshot.
String progress
The percentage of completion for the import snapshot task.
String snapshotId
The snapshot ID of the disk being imported.
String status
A brief status for the import snapshot task.
String statusMessage
A detailed status message for the import snapshot task.
String url
The URL of the disk image from which the snapshot is created.
UserBucketDetails userBucket
The S3 bucket for the disk image.
String bucket
The Amazon S3 bucket where the Spot Instance data feed is located.
SpotInstanceStateFault fault
The fault codes for the Spot Instance request, if any.
String ownerId
The AWS account ID of the account.
String prefix
The prefix that is prepended to data feed files.
String state
The state of the Spot Instance data feed subscription.
SdkInternalList<T> securityGroups
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
String addressingType
Deprecated.
SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
Boolean ebsOptimized
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String imageId
The ID of the AMI.
String instanceType
The instance type.
String kernelId
The ID of the kernel.
String keyName
The name of the key pair.
SpotFleetMonitoring monitoring
Enable or disable monitoring for the instances.
SdkInternalList<T> networkInterfaces
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotPlacement placement
The placement information.
String ramdiskId
The ID of the RAM disk.
String spotPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified,
the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot
price by the value of WeightedCapacity
.
String subnetId
The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08".
String userData
The Base64-encoded user data to make available to the instances.
Double weightedCapacity
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).
If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
SdkInternalList<T> tagSpecifications
The tags to apply during creation.
Boolean enabled
Enables monitoring for the instance.
Default: false
String activityStatus
The progress of the Spot Fleet request. If there is an error, the status is error
. After all
requests are placed, the status is pending_fulfillment
. If the size of the fleet is equal to or
greater than its target capacity, the status is fulfilled
. If the size of the fleet is decreased,
the status is pending_termination
while Spot Instances are terminating.
Date createTime
The creation date and time of the request.
SpotFleetRequestConfigData spotFleetRequestConfig
The configuration of the Spot Fleet request.
String spotFleetRequestId
The ID of the Spot Fleet request.
String spotFleetRequestState
The state of the Spot Fleet request.
String allocationStrategy
Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The
default is lowestPrice
.
String onDemandAllocationStrategy
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
lowestPrice
, Spot Fleet uses price to determine the order, launching the lowest price first. If you
specify prioritized
, Spot Fleet uses the priority that you assign to each Spot Fleet launch template
override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to
lowestPrice
.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
String excessCapacityTerminationPolicy
Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
Double fulfilledCapacity
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
Double onDemandFulfilledCapacity
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
String iamFleetRole
Grants the Spot Fleet permission to terminate Spot Instances on your behalf when you cancel its Spot Fleet
request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set
terminateInstancesWithExpiration
.
SdkInternalList<T> launchSpecifications
The launch specifications for the Spot Fleet request.
SdkInternalList<T> launchTemplateConfigs
The launch template and overrides.
String spotPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
Integer targetCapacity
The number of units to request. You can choose to set the target capacity in terms of instances or a performance
characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type
is maintain
, you can specify a target capacity of 0 and add capacity later.
Integer onDemandTargetCapacity
The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a
performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the
request type is maintain
, you can specify a target capacity of 0 and add capacity later.
Boolean terminateInstancesWithExpiration
Indicates whether running Spot Instances should be terminated when the Spot Fleet request expires.
String type
The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to
maintain it. When this value is request
, the Spot Fleet only places the required requests. It does
not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative
Spot pools if capacity is not available. To maintain a certain target capacity, the Spot Fleet places the
required requests to meet capacity and automatically replenishes any interrupted instances. Default:
maintain
.
Date validFrom
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
Date validUntil
The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot Instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
Boolean replaceUnhealthyInstances
Indicates whether Spot Fleet should replace unhealthy instances.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
LoadBalancersConfig loadBalancersConfig
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
Integer instancePoolsToUseCount
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot
AllocationStrategy is set to lowest-price
. Spot Fleet selects the cheapest Spot pools and
evenly allocates your target Spot capacity across the number of Spot pools that you specify.
String resourceType
The type of resource. Currently, the only resource type that is supported is instance
.
SdkInternalList<T> tags
The tags.
String actualBlockHourlyPrice
If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.
String availabilityZoneGroup
The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
Integer blockDurationMinutes
The duration for the Spot Instance, in minutes.
Date createTime
The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SpotInstanceStateFault fault
The fault codes for the Spot Instance request, if any.
String instanceId
The instance ID, if an instance has been launched to fulfill the Spot Instance request.
String launchGroup
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
LaunchSpecification launchSpecification
Additional information for launching instances.
String launchedAvailabilityZone
The Availability Zone in which the request is launched.
String productDescription
The product description associated with the Spot Instance.
String spotInstanceRequestId
The ID of the Spot Instance request.
String spotPrice
The maximum price per hour that you are willing to pay for a Spot Instance.
String state
The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot Status in the Amazon EC2 User Guide for Linux Instances.
SpotInstanceStatus status
The status code and status message describing the Spot Instance request.
SdkInternalList<T> tags
Any tags assigned to the resource.
String type
The Spot Instance request type.
Date validFrom
The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.
Date validUntil
The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted.
String code
The status code. For a list of status codes, see Spot Status Codes in the Amazon EC2 User Guide for Linux Instances.
String message
The description for the status code.
Date updateTime
The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String maxPrice
The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price.
String spotInstanceType
The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported
when InstanceInterruptionBehavior is set to either hibernate
or stop
.
Integer blockDurationMinutes
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
Date validUntil
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
String allocationStrategy
Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The
default is lowest-price
.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
Integer instancePoolsToUseCount
The number of Spot pools across which to allocate your target Spot capacity. Valid only when
AllocationStrategy is set to lowestPrice
. EC2 Fleet selects the cheapest Spot pools and
evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Boolean singleInstanceType
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Integer minTargetCapacity
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
String allocationStrategy
Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The
default is lowestPrice
.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
Integer instancePoolsToUseCount
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot
AllocationStrategy is set to lowest-price
. EC2 Fleet selects the cheapest Spot pools and
evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Boolean singleInstanceType
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Integer minTargetCapacity
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
String availabilityZone
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
String groupName
The name of the placement group.
String tenancy
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of
dedicated
runs on single-tenant hardware. The host
tenancy is not supported for Spot
Instances.
String availabilityZone
The Availability Zone.
String instanceType
The instance type.
String productDescription
A general description of the AMI.
String spotPrice
The maximum price per hour that you are willing to pay for a Spot Instance.
Date timestamp
The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Integer fromPort
The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1
indicates all ICMP types.
String ipProtocol
The IP protocol name (for tcp
, udp
, and icmp
) or number (see Protocol Numbers).
SdkInternalList<T> ipRanges
One or more IP ranges. Not applicable for stale security group rules.
SdkInternalList<T> prefixListIds
One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.
Integer toPort
The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1
indicates all ICMP types.
SdkInternalList<T> userIdGroupPairs
One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
String description
The description of the security group.
String groupId
The ID of the security group.
String groupName
The name of the security group.
SdkInternalList<T> staleIpPermissions
Information about the stale inbound rules in the security group.
SdkInternalList<T> staleIpPermissionsEgress
Information about the stale outbound rules in the security group.
String vpcId
The ID of the VPC for the security group.
SdkInternalList<T> instanceIds
One or more instance IDs.
String additionalInfo
Reserved.
SdkInternalList<T> startingInstances
Information about one or more started instances.
String code
The reason code for the state change.
String message
The message for the state change.
Server.InsufficientInstanceCapacity
: There was insufficient capacity available to satisfy the launch
request.
Server.InternalError
: An internal error caused the instance to terminate during launch.
Server.ScheduledStop
: The instance was stopped due to a scheduled retirement.
Server.SpotInstanceShutdown
: The instance was stopped because the number of Spot requests with a
maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the
Spot price.
Server.SpotInstanceTermination
: The instance was terminated because the number of Spot requests with
a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in
the Spot price.
Client.InstanceInitiatedShutdown
: The instance was shut down using the shutdown -h
command from the instance.
Client.InstanceTerminated
: The instance was terminated or rebooted during AMI creation.
Client.InternalError
: A client error caused the instance to terminate during launch.
Client.InvalidSnapshot.NotFound
: The specified snapshot was not found.
Client.UserInitiatedShutdown
: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded
: The limit on the number of EBS volumes or total storage was exceeded.
Decrease usage or request an increase in your account limits.
SdkInternalList<T> instanceIds
One or more instance IDs.
Boolean force
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
SdkInternalList<T> stoppingInstances
Information about one or more stopped instances.
S3Storage s3
An Amazon S3 storage location.
String availabilityZone
The Availability Zone of the subnet.
Integer availableIpAddressCount
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
String cidrBlock
The IPv4 CIDR block assigned to the subnet.
Boolean defaultForAz
Indicates whether this is the default subnet for the Availability Zone.
Boolean mapPublicIpOnLaunch
Indicates whether instances launched in this subnet receive a public IPv4 address.
String state
The current state of the subnet.
String subnetId
The ID of the subnet.
String vpcId
The ID of the VPC the subnet is in.
Boolean assignIpv6AddressOnCreation
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
SdkInternalList<T> ipv6CidrBlockAssociationSet
Information about the IPv6 CIDR blocks associated with the subnet.
SdkInternalList<T> tags
Any tags assigned to the subnet.
String associationId
The association ID for the CIDR block.
String ipv6CidrBlock
The IPv6 CIDR block.
SubnetCidrBlockState ipv6CidrBlockState
Information about the state of the CIDR block.
String instanceId
The ID of the instance.
String resourceType
The type of resource to tag. Currently, the resource types that support tagging on creation are
fleet
, dedicated-host
, instance
, snapshot
, and
volume
. To tag a resource after it has been created, see CreateTags.
SdkInternalList<T> tags
The tags to apply to the resource.
Integer totalTargetCapacity
The number of units to request, filled using DefaultTargetCapacityType
.
Integer onDemandTargetCapacity
The number of On-Demand units to request.
Integer spotTargetCapacity
The maximum number of Spot units to launch.
String defaultTargetCapacityType
The default TotalTargetCapacity
, which is either Spot
or On-Demand
.
Integer totalTargetCapacity
The number of units to request, filled using DefaultTargetCapacityType
.
Integer onDemandTargetCapacity
The number of On-Demand units to request.
Integer spotTargetCapacity
The number of Spot units to request.
String defaultTargetCapacityType
The default TotalTargetCapacity
, which is either Spot
or On-Demand
.
String arn
The Amazon Resource Name (ARN) of the target group.
SdkInternalList<T> targetGroups
One or more target groups.
ReservationValue reservationValue
The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.
TargetConfiguration targetConfiguration
The configuration of the Convertible Reserved Instances that make up the exchange.
SdkInternalList<T> instanceIds
One or more instance IDs.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
SdkInternalList<T> terminatingInstances
Information about one or more terminated instances.
SdkInternalList<T> ipv6Addresses
The IPv6 addresses to unassign from the network interface.
String networkInterfaceId
The ID of the network interface.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> unassignedIpv6Addresses
The IPv6 addresses that have been unassigned from the network interface.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> privateIpAddresses
The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
SdkInternalList<T> instanceIds
One or more instance IDs.
SdkInternalList<T> instanceMonitorings
The monitoring information.
String instanceId
The ID of the instance.
UnsuccessfulInstanceCreditSpecificationItemError error
The applicable error for the T2 or T3 instance whose credit option for CPU usage was not modified.
UnsuccessfulItemError error
Information about the error.
String resourceId
The ID of the resource.
String groupId
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
String groupName
[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
SdkInternalList<T> ipPermissions
The IP permissions for the security group rule.
Boolean returnValue
Returns true
if the request succeeds; otherwise, returns an error.
String groupId
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
String groupName
[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
SdkInternalList<T> ipPermissions
The IP permissions for the security group rule.
Boolean returnValue
Returns true
if the request succeeds; otherwise, returns an error.
String data
The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
String description
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
String groupId
The ID of the security group.
String groupName
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
String peeringStatus
The status of a VPC peering connection, if applicable.
String userId
The ID of an AWS account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.
String vpcId
The ID of the VPC for the referenced security group, if applicable.
String vpcPeeringConnectionId
The ID of the VPC peering connection, if applicable.
Integer acceptedRouteCount
The number of accepted routes.
Date lastStatusChange
The date and time of the last change in status.
String outsideIpAddress
The Internet-routable IP address of the virtual private gateway's outside interface.
String status
The status of the VPN tunnel.
String statusMessage
If an error occurs, a description of the error.
SdkInternalList<T> attachments
Information about the volume attachments.
String availabilityZone
The Availability Zone for the volume.
Date createTime
The time stamp when volume creation was initiated.
Boolean encrypted
Indicates whether the volume will be encrypted.
String kmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
Integer size
The size of the volume, in GiBs.
String snapshotId
The snapshot from which the volume was created, if applicable.
String state
The volume state.
String volumeId
The ID of the volume.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100-32000 IOPS for io1 volumes and 100-10000 IOPS for gp2
volumes.
Condition: This parameter is required for requests to create io1
volumes; it is not used in requests
to create gp2
, st1
, sc1
, or standard
volumes.
SdkInternalList<T> tags
Any tags assigned to the volume.
String volumeType
The volume type. This can be gp2
for General Purpose SSD, io1
for Provisioned IOPS SSD,
st1
for Throughput Optimized HDD, sc1
for Cold HDD, or standard
for
Magnetic volumes.
Date attachTime
The time stamp when the attachment initiated.
String device
The device name.
String instanceId
The ID of the instance.
String state
The attachment state of the volume.
String volumeId
The ID of the volume.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Long size
The size of the volume, in GiB.
String volumeId
The ID of the volume.
String modificationState
The current modification state. The modification state is null for unmodified volumes.
String statusMessage
A status message about the modification progress or failure.
Integer targetSize
The target size of the volume, in GiB.
Integer targetIops
The target IOPS rate of the volume.
String targetVolumeType
The target EBS volume type of the volume.
Integer originalSize
The original size of the volume.
Integer originalIops
The original IOPS rate of the volume.
String originalVolumeType
The original EBS volume type of the volume.
Long progress
The modification progress, from 0 to 100 percent complete.
Date startTime
The modification start time.
Date endTime
The modification completion or failure time.
SdkInternalList<T> details
The details of the volume status.
String status
The status of the volume.
SdkInternalList<T> actions
The details of the operation.
String availabilityZone
The Availability Zone of the volume.
SdkInternalList<T> events
A list of events associated with the volume.
String volumeId
The volume ID.
VolumeStatusInfo volumeStatus
The volume status.
String cidrBlock
The primary IPv4 CIDR block for the VPC.
String dhcpOptionsId
The ID of the set of DHCP options you've associated with the VPC (or default
if the default options
are associated with the VPC).
String state
The current state of the VPC.
String vpcId
The ID of the VPC.
String instanceTenancy
The allowed tenancy of instances launched into the VPC.
SdkInternalList<T> ipv6CidrBlockAssociationSet
Information about the IPv6 CIDR blocks associated with the VPC.
SdkInternalList<T> cidrBlockAssociationSet
Information about the IPv4 CIDR blocks associated with the VPC.
Boolean isDefault
Indicates whether the VPC is the default VPC.
SdkInternalList<T> tags
Any tags assigned to the VPC.
String associationId
The association ID for the IPv4 CIDR block.
String cidrBlock
The IPv4 CIDR block.
VpcCidrBlockState cidrBlockState
Information about the state of the CIDR block.
Boolean classicLinkEnabled
Indicates whether the VPC is enabled for ClassicLink.
SdkInternalList<T> tags
Any tags assigned to the VPC.
String vpcId
The ID of the VPC.
String vpcEndpointId
The ID of the VPC endpoint.
String vpcEndpointType
The type of endpoint.
String vpcId
The ID of the VPC to which the endpoint is associated.
String serviceName
The name of the service to which the endpoint is associated.
String state
The state of the VPC endpoint.
String policyDocument
The policy document associated with the endpoint, if applicable.
SdkInternalList<T> routeTableIds
(Gateway endpoint) One or more route tables associated with the endpoint.
SdkInternalList<T> subnetIds
(Interface endpoint) One or more subnets in which the endpoint is located.
SdkInternalList<T> groups
(Interface endpoint) Information about the security groups associated with the network interface.
Boolean privateDnsEnabled
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
SdkInternalList<T> networkInterfaceIds
(Interface endpoint) One or more network interfaces for the endpoint.
SdkInternalList<T> dnsEntries
(Interface endpoint) The DNS entries for the endpoint.
Date creationTimestamp
The date and time the VPC endpoint was created.
String serviceId
The ID of the service to which the endpoint is connected.
String vpcEndpointId
The ID of the VPC endpoint.
String vpcEndpointOwner
The AWS account ID of the owner of the VPC endpoint.
String vpcEndpointState
The state of the VPC endpoint.
Date creationTimestamp
The date and time the VPC endpoint was created.
String associationId
The association ID for the IPv6 CIDR block.
String ipv6CidrBlock
The IPv6 CIDR block.
VpcCidrBlockState ipv6CidrBlockState
Information about the state of the CIDR block.
VpcPeeringConnectionVpcInfo accepterVpcInfo
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
Date expirationTime
The time that an unaccepted VPC peering connection will expire.
VpcPeeringConnectionVpcInfo requesterVpcInfo
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
VpcPeeringConnectionStateReason status
The status of the VPC peering connection.
SdkInternalList<T> tags
Any tags assigned to the resource.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
Boolean allowDnsResolutionFromRemoteVpc
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
Boolean allowEgressFromLocalClassicLinkToRemoteVpc
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
Boolean allowEgressFromLocalVpcToRemoteClassicLink
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
String cidrBlock
The IPv4 CIDR block for the VPC.
SdkInternalList<T> ipv6CidrBlockSet
The IPv6 CIDR block for the VPC.
SdkInternalList<T> cidrBlockSet
Information about the IPv4 CIDR blocks for the VPC.
String ownerId
The AWS account ID of the VPC owner.
VpcPeeringConnectionOptionsDescription peeringOptions
Information about the VPC peering connection options for the accepter or requester VPC.
String vpcId
The ID of the VPC.
String region
The region in which the VPC is located.
String customerGatewayConfiguration
The configuration information for the VPN connection's customer gateway (in the native XML format). This element
is always present in the CreateVpnConnection response; however, it's present in the
DescribeVpnConnections response only if the VPN connection is in the pending
or
available
state.
String customerGatewayId
The ID of the customer gateway at your end of the VPN connection.
String category
The category of the VPN connection. A value of VPN
indicates an AWS VPN connection. A value of
VPN-Classic
indicates an AWS Classic VPN connection. For more information, see AWS Managed VPN
Categories in the Amazon Virtual Private Cloud User Guide.
String state
The current state of the VPN connection.
String type
The type of VPN connection.
String vpnConnectionId
The ID of the VPN connection.
String vpnGatewayId
The ID of the virtual private gateway at the AWS side of the VPN connection.
VpnConnectionOptions options
The VPN connection options.
SdkInternalList<T> routes
The static routes associated with the VPN connection.
SdkInternalList<T> tags
Any tags assigned to the VPN connection.
SdkInternalList<T> vgwTelemetry
Information about the VPN tunnel.
Boolean staticRoutesOnly
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
Boolean staticRoutesOnly
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device
that does not support BGP, you must specify true
. Use CreateVpnConnectionRoute to create a
static route.
Default: false
SdkInternalList<T> tunnelOptions
The tunnel options for the VPN connection.
String availabilityZone
The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
String state
The current state of the virtual private gateway.
String type
The type of VPN connection the virtual private gateway supports.
SdkInternalList<T> vpcAttachments
Any VPCs attached to the virtual private gateway.
String vpnGatewayId
The ID of the virtual private gateway.
Long amazonSideAsn
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
SdkInternalList<T> tags
Any tags assigned to the virtual private gateway.
String tunnelInsideCidr
The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16
range. The following CIDR blocks are
reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
String preSharedKey
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters and ._. Must be between 8 and 64 characters in length and cannot start with zero (0).
String cidr
The public IPv4 address range, in CIDR notation.
ByoipCidr byoipCidr
Information about the address pool.
Copyright © 2018. All rights reserved.