com.amazonaws.internal.SdkInternalList<T> reservedInstanceIds
The IDs of the Convertible Reserved Instances that you want to exchange for other Convertible Reserved Instances of the same or higher value.
com.amazonaws.internal.SdkInternalList<T> targetConfigurations
The configurations of the Convertible Reserved Instance offerings you are purchasing in this exchange.
String exchangeId
The ID of the successful exchange.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
VpcPeeringConnection vpcPeeringConnection
Information about the VPC peering connection.
String attributeName
The name of the account attribute.
com.amazonaws.internal.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 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.
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 publicIp
The Elastic IP address.
String domain
Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard
) or
instances in a VPC (vpc
).
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 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 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 instanceType
Specify the instance type that you want your Dedicated Hosts to be configured for. 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 you want to allocate to your account with these parameters.
String availabilityZone
The Availability Zone for the Dedicated Hosts.
com.amazonaws.internal.SdkInternalList<T> hostIds
The ID of the allocated Dedicated Host. This is used when you want to launch an instance onto a specific host.
String networkInterfaceId
The ID of the network interface.
com.amazonaws.internal.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.
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 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.
String allocationId
[EC2-VPC] The allocation ID. This is required for EC2-VPC.
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.
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 associationId
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
String associationId
The route table association ID (needed to disassociate the route table).
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.
com.amazonaws.internal.SdkInternalList<T> groups
The ID of one or more of the VPC's security groups. You cannot specify security groups from a different 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.
String sourceSecurityGroupName
The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.
String sourceSecurityGroupOwnerId
The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.
String ipProtocol
The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.
Integer fromPort
The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.
String cidrIp
The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.
com.amazonaws.internal.SdkInternalList<T> ipPermissions
A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
String groupName
[EC2-Classic, default VPC] The name of the security group.
String groupId
The ID of the security group. Required for a nondefault VPC.
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 number 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.
String ipProtocol
The IP protocol name (tcp
, udp
, icmp
) or number (see Protocol Numbers). (VPC only)
Use -1
to specify all traffic. If you specify -1
, traffic on all ports is allowed,
regardless of any ports you specify.
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.
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 cidrIp
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
com.amazonaws.internal.SdkInternalList<T> ipPermissions
A set of IP permissions. Can be used to specify multiple rules in a single command.
String zoneName
The name of the Availability Zone.
String state
The state of the Availability Zone.
String regionName
The name of the region.
com.amazonaws.internal.SdkInternalList<T> messages
Any messages about the Availability Zone.
String message
The message about the Availability Zone.
com.amazonaws.internal.SdkInternalList<T> availableInstanceCapacity
The total number of instances that the Dedicated Host supports.
Integer availableVCpus
The number of vCPUs available on the Dedicated Host.
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.
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.
String deviceName
The device name exposed to the instance (for example, /dev/sdh
or xvdh
).
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 instanceId
The ID of the instance associated with this bundle task.
String bundleId
The ID of the bundle task.
String state
The state of the task.
Date startTime
The time this task started.
Date updateTime
The time of the most recent update for the task.
Storage storage
The Amazon S3 storage locations.
String progress
The level of task completion, as a percent (for example, 20%).
BundleTaskError bundleTaskError
If the task fails, a description of the error.
String bundleId
The ID of the bundle task.
BundleTask bundleTask
Information about the bundle task.
String exportTaskId
The ID of the export task. This is the ID returned by CreateInstanceExportTask
.
String reservedInstancesListingId
The ID of the Reserved Instance listing.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesListings
The Reserved Instance listing.
String spotFleetRequestId
The ID of the Spot fleet request.
CancelSpotFleetRequestsError error
The error.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> unsuccessfulFleetRequests
Information about the Spot fleet requests that are not successfully canceled.
com.amazonaws.internal.SdkInternalList<T> successfulFleetRequests
Information about the Spot fleet requests that are successfully canceled.
String spotFleetRequestId
The ID of the Spot fleet request.
String currentSpotFleetRequestState
The current state of the Spot fleet request.
String previousSpotFleetRequestState
The previous state of the Spot fleet request.
com.amazonaws.internal.SdkInternalList<T> spotInstanceRequestIds
One or more Spot instance request IDs.
com.amazonaws.internal.SdkInternalList<T> cancelledSpotInstanceRequests
One or more Spot instance requests.
String instanceId
The ID of the instance.
String vpcId
The ID of the VPC.
com.amazonaws.internal.SdkInternalList<T> groups
A list of security groups.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the instance.
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 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.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the task.
String sourceRegion
The name of the region that contains the AMI to copy.
String sourceImageId
The ID of the AMI to copy.
String name
The name of the new AMI in the destination region.
String description
A description for the new AMI in the destination region.
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.
Boolean encrypted
Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is
used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId
. For
more information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
String kmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image
during a copy operation. 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. The 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. The specified
CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.
String imageId
The ID of the new AMI.
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 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.
CopySnapshot
sends the snapshot copy to the regional endpoint that you send the HTTP request to,
such as ec2.us-east-1.amazonaws.com
(in the AWS CLI, this is specified with the
--region
parameter or the default region in your AWS configuration file).
String presignedUrl
The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying
an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases.
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.
Boolean encrypted
Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot
using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your default CMK
for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with
KmsKeyId
. For more information, see Amazon EBS Encryption in the
Amazon Elastic Compute Cloud User Guide.
String kmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. 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. The 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. The specified
CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.
String snapshotId
The ID of the new snapshot.
String type
The type of VPN connection that this customer gateway supports (ipsec.1
).
String publicIp
The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
Integer bgpAsn
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
CustomerGateway customerGateway
Information about the customer gateway.
com.amazonaws.internal.SdkInternalList<T> dhcpConfigurations
A DHCP configuration option.
DhcpOptions dhcpOptions
A set of DHCP options.
com.amazonaws.internal.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 logGroupName
The name of the CloudWatch log group.
String deliverLogsPermissionArn
The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
com.amazonaws.internal.SdkInternalList<T> flowLogIds
The IDs of the flow logs.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
com.amazonaws.internal.SdkInternalList<T> unsuccessful
Information about the flow logs that could not be created successfully.
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(_)
String description
A description for the new image.
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.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
Information about one or more block device mappings.
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.
String instanceId
The ID of the instance.
String targetEnvironment
The target virtualization environment.
ExportToS3TaskSpecification exportToS3Task
The format and location for an instance export task.
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 subnetId
The subnet in which to create the NAT gateway.
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 you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
Constraint: Maximum 64 ASCII characters.
NatGateway natGateway
Information about 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.
String networkAclId
The ID of the network ACL.
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 protocol
The protocol. A value of -1 means all protocols.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Boolean egress
Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
String cidrBlock
The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24
).
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to.
String vpcId
The ID of the VPC.
NetworkAcl networkAcl
Information about the network ACL.
String subnetId
The ID of the subnet to associate with the network interface.
String description
A description for the network interface.
String privateIpAddress
The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects
one for you from the subnet 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).
com.amazonaws.internal.SdkInternalList<T> groups
The IDs of one or more security groups.
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
One or more private IP addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IP addresses to assign to a network interface. When you specify a number of
secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet 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 Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
NetworkInterface networkInterface
Information about the network interface.
String reservedInstancesId
The ID of the active Standard Reserved Instance.
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.
com.amazonaws.internal.SdkInternalList<T> priceSchedules
A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
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.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesListings
Information about the Standard Reserved Instance listing.
String routeTableId
The ID of the route table for the route.
String destinationCidrBlock
The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
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 networkInterfaceId
The ID of a network interface.
String vpcPeeringConnectionId
The ID of a VPC peering connection.
String natGatewayId
The ID of a NAT gateway.
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 groupName
The name of the security group.
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 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 vpcId
[EC2-VPC] The ID of the VPC. Required for EC2-VPC.
String groupId
The ID of the security group.
Snapshot snapshot
Describes a snapshot.
SpotDatafeedSubscription spotDatafeedSubscription
The Spot instance data feed subscription.
String vpcId
The ID of the VPC.
String cidrBlock
The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24
.
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.
Subnet subnet
Information about the subnet.
com.amazonaws.internal.SdkInternalList<T> resources
The IDs of one or more resources to tag. For example, ami-1a2b3c4d.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> add
Adds a specific AWS account ID or group to a volume's list of create volume permissions.
com.amazonaws.internal.SdkInternalList<T> remove
Removes a specific AWS account ID or group from a volume's list of create volume permissions.
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 availabilityZone
The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
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.
Default: standard
Integer iops
Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.
Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
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.
String kmsKeyId
The full ARN of 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. The 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. If
a KmsKeyId
is specified, the Encrypted
flag must also be set.
Volume volume
Describes a volume.
String vpcId
The ID of the VPC in which the endpoint will be used.
String serviceName
The AWS service name, in the form com.amazonaws.region.service
. To get a list of
available services, use the DescribeVpcEndpointServices request.
String policyDocument
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.
com.amazonaws.internal.SdkInternalList<T> routeTableIds
One or more route table IDs.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
VpcEndpoint vpcEndpoint
Information about the endpoint.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
VpcPeeringConnection vpcPeeringConnection
Information about the VPC peering connection.
String cidrBlock
The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16
.
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 type
The type of VPN connection (ipsec.1
).
String customerGatewayId
The ID of the customer gateway.
String vpnGatewayId
The ID of the virtual private gateway.
VpnConnectionOptionsSpecification options
Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device
that does not support BGP, you must specify true
.
Default: false
VpnConnection vpnConnection
Information about the VPN connection.
VpnGateway vpnGateway
Information about the virtual private gateway.
String customerGatewayId
The ID of the customer gateway.
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
).
String ipAddress
The Internet-routable IP address of the customer gateway's outside interface.
String bgpAsn
The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> flowLogIds
One or more flow log IDs.
com.amazonaws.internal.SdkInternalList<T> unsuccessful
Information about the flow logs that could not be deleted successfully.
String internetGatewayId
The ID of the Internet gateway.
String keyName
The name of the key pair.
String natGatewayId
The ID of the NAT gateway.
String natGatewayId
The ID of the NAT gateway.
String networkAclId
The ID of the network ACL.
String networkInterfaceId
The ID of the network interface.
String groupName
The name of the placement group.
String routeTableId
The ID of the route table.
String snapshotId
The ID of the EBS snapshot.
String subnetId
The ID of the subnet.
com.amazonaws.internal.SdkInternalList<T> resources
The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.
com.amazonaws.internal.SdkInternalList<T> tags
One or more tags to delete. If you omit the value
parameter, we delete the tag regardless of its
value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an
empty string.
String volumeId
The ID of the volume.
com.amazonaws.internal.SdkInternalList<T> vpcEndpointIds
One or more endpoint IDs.
com.amazonaws.internal.SdkInternalList<T> unsuccessful
Information about the 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 imageId
The ID of the AMI.
com.amazonaws.internal.SdkInternalList<T> attributeNames
One or more account attribute names.
com.amazonaws.internal.SdkInternalList<T> accountAttributes
Information about one or more account attributes.
com.amazonaws.internal.SdkInternalList<T> publicIps
[EC2-Classic] One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> allocationIds
[EC2-VPC] One or more allocation IDs.
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.SdkInternalList<T> addresses
Information about one or more Elastic IP addresses.
com.amazonaws.internal.SdkInternalList<T> zoneNames
The names of one or more Availability Zones.
com.amazonaws.internal.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-name
- The name of the Availability Zone (for example, us-east-1a
).
com.amazonaws.internal.SdkInternalList<T> availabilityZones
Information about one or more Availability Zones.
com.amazonaws.internal.SdkInternalList<T> bundleIds
One or more bundle task IDs.
Default: Describes all your bundle tasks.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> bundleTasks
Information about one or more bundle tasks.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
com.amazonaws.internal.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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
vpc-id
- The ID of the VPC that the instance is linked to.
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 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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> conversionTaskIds
One or more conversion task IDs.
com.amazonaws.internal.SdkInternalList<T> conversionTasks
Information about the conversion tasks.
com.amazonaws.internal.SdkInternalList<T> customerGatewayIds
One or more customer gateway IDs.
Default: Describes all your customer gateways.
com.amazonaws.internal.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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
com.amazonaws.internal.SdkInternalList<T> customerGateways
Information about one or more customer gateways.
com.amazonaws.internal.SdkInternalList<T> dhcpOptionsIds
The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
com.amazonaws.internal.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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
com.amazonaws.internal.SdkInternalList<T> dhcpOptions
Information about one or more DHCP options sets.
com.amazonaws.internal.SdkInternalList<T> exportTaskIds
One or more export task IDs.
com.amazonaws.internal.SdkInternalList<T> exportTasks
Information about the export tasks.
com.amazonaws.internal.SdkInternalList<T> flowLogIds
One or more flow log IDs.
com.amazonaws.internal.SdkInternalList<T> filter
One or more filters.
deliver-log-status
- The status of the logs delivery (SUCCESS
| FAILED
).
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
)
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. 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.
com.amazonaws.internal.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.
String offeringId
The ID of the reservation offering.
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.
Integer maxDuration
This is the maximum 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 94608000 for three years.
com.amazonaws.internal.SdkInternalList<T> filter
One or more filters.
instance-family
- The instance family of the offering (e.g., m4
).
payment-option
- The payment option (No Upfront
| Partial Upfront
|
All Upfront
).
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 will receive an error.
String nextToken
The token to use to retrieve the next page of results.
com.amazonaws.internal.SdkInternalList<T> offeringSet
Information about the 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.
com.amazonaws.internal.SdkInternalList<T> hostReservationIdSet
One or more host reservation IDs.
com.amazonaws.internal.SdkInternalList<T> filter
One or more filters.
instance-family
- The instance family (e.g., m4
).
payment-option
- The payment option (No Upfront
| Partial Upfront
|
All Upfront
).
state
- The state of the reservation (payment-pending
| payment-failed
|
active
| retired
).
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 will receive an error.
String nextToken
The token to use to retrieve the next page of results.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> hostIds
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
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. This value can be between 5 and 500; if
maxResults
is given a larger value than 500, you will receive an error. You cannot specify this
parameter and the host IDs parameter in the same request.
com.amazonaws.internal.SdkInternalList<T> filter
One or more filters.
instance-type
- The instance type size that the Dedicated Host is configured to support.
auto-placement
- Whether auto-placement is enabled or disabled (on
| off
).
host-reservation-id
- The ID of the reservation assigned to this host.
client-token
- The idempotency token you provided when you launched the instance
state
- The allocation state of the Dedicated Host (available
|
under-assessment
| permanent-failure
| released
|
released-permanent-failure
).
availability-zone
- The Availability Zone of the host.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> statuses
Information about the ID format for the resources.
String resource
The type of resource: instance
| reservation
| snapshot
|
volume
com.amazonaws.internal.SdkInternalList<T> statuses
Information about the ID format for the resource.
String imageId
The ID of the AMI.
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.
ImageAttribute imageAttribute
Describes an image attribute.
com.amazonaws.internal.SdkInternalList<T> imageIds
One or more image IDs.
Default: Describes all images available to you.
com.amazonaws.internal.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.
com.amazonaws.internal.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).
com.amazonaws.internal.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 for the EBS volume (for example,
/dev/sdh
).
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).
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 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.
tag
:key=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any
resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
virtualization-type
- The virtualization type (paravirtual
| hvm
).
com.amazonaws.internal.SdkInternalList<T> images
Information about one or more images.
com.amazonaws.internal.SdkInternalList<T> importTaskIds
A list of import image task IDs.
String nextToken
A token that indicates 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.
com.amazonaws.internal.SdkInternalList<T> filters
Filter tasks using the task-state
filter and one of the following values: active, completed,
deleting, deleted.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> importTaskIds
A list of import snapshot task IDs.
String nextToken
A token that indicates 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.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
Default: Describes all your instances.
com.amazonaws.internal.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 for the EBS volume (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 an
opaque internal value 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 IP 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 monitoring is enabled for the instance (disabled
|
enabled
).
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 DNS name of the instance.
private-ip-address
- The private IP 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'll get one reservation ID. If you launch ten instances using the same
launch request, you'll also get one reservation ID.
root-device-name
- The name of the root device for the instance (for example, /dev/sda1
or /dev/xvda
).
root-device-type
- The type of root device that the instance uses (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 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=value - The key/value combination of a tag assigned to the resource, where
tag
:key is the tag's key.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
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.
network-interface.description
- The description of the network interface.
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.
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.availability-zone
- The Availability Zone for 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.mac-address
- The MAC address of the network interface.
network-interface.private-dns-name
- The private DNS name of the network interface.
network-interface.source-dest-check
- 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.
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.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.addresses.private-ip-address
- The private IP address associated with the network
interface.
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.addresses.primary
- Specifies whether the IP address of the network interface is
the primary private IP address.
network-interface.addresses.association.public-ip
- The ID of the association of an Elastic IP
address with a network interface.
network-interface.addresses.association.ip-owner-id
- The owner ID of the private IP address
associated with the network interface.
association.public-ip
- The address of the Elastic IP address bound to the network interface.
association.ip-owner-id
- The owner of the Elastic IP address associated with the network interface.
association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address for
your network interface.
association.association-id
- The association ID returned when the network interface was associated
with an IP address.
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 5 and 1000. You cannot specify this
parameter and the instance IDs parameter or tag filters in the same call.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
com.amazonaws.internal.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 an opaque internal value 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
).
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 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.
Boolean includeAllInstances
When true
, includes the health status for all instances. When false
, includes the
health status for running instances only.
Default: false
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> internetGatewayIds
One or more Internet gateway IDs.
Default: Describes all your Internet gateways.
com.amazonaws.internal.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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
com.amazonaws.internal.SdkInternalList<T> internetGateways
Information about one or more Internet gateways.
com.amazonaws.internal.SdkInternalList<T> keyNames
One or more key pair names.
Default: Describes all your key pairs.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
fingerprint
- The fingerprint of the key pair.
key-name
- The name of the key pair.
com.amazonaws.internal.SdkInternalList<T> keyPairs
Information about one or more key pairs.
com.amazonaws.internal.SdkInternalList<T> publicIps
One or more Elastic IP addresses.
String nextToken
The token to use to retrieve the next page of results.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> natGatewayIds
One or more NAT gateway IDs.
com.amazonaws.internal.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.
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.
String nextToken
The token to retrieve the next page of results.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> networkAclIds
One or more network ACL IDs.
Default: Describes all your network ACLs.
com.amazonaws.internal.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 CIDR range specified in the entry.
entry.egress
- Indicates whether the entry applies to egress traffic.
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.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 ACL's set of entries.
network-acl-id
- The ID of the network ACL.
tag
:key=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
vpc-id
- The ID of the VPC for the network ACL.
com.amazonaws.internal.SdkInternalList<T> networkAcls
Information about one or more network ACLs.
String networkInterfaceId
The ID of the network interface.
String description
The description of the network interface.
Boolean sourceDestCheck
Indicates whether source/destination checking is enabled.
com.amazonaws.internal.SdkInternalList<T> groups
The security groups associated with the network interface.
NetworkInterfaceAttachment attachment
The attachment (if any) of the network interface.
com.amazonaws.internal.SdkInternalList<T> networkInterfaceIds
One or more network interface IDs.
Default: Describes all your network interfaces.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
addresses.private-ip-address
- The private IP addresses associated with the network interface.
addresses.primary
- Whether the private IP 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.
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 IP address.
association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address for
your network interface.
association.ip-owner-id
- The owner of the Elastic IP address associated with the network interface.
association.public-ip
- The address of the Elastic IP address bound to the network interface.
association.public-dns-name
- The public DNS name for the network interface.
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.
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 IP address or addresses of the network interface.
private-dns-name
- The private DNS name of the network interface.
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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
vpc-id
- The ID of the VPC for the network interface.
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
Information about one or more network interfaces.
com.amazonaws.internal.SdkInternalList<T> groupNames
One or more placement group names.
Default: Describes all your placement groups, or only those otherwise specified.
com.amazonaws.internal.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
).
com.amazonaws.internal.SdkInternalList<T> placementGroups
One or more placement groups.
com.amazonaws.internal.SdkInternalList<T> prefixListIds
One or more prefix list IDs.
com.amazonaws.internal.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.)
com.amazonaws.internal.SdkInternalList<T> prefixLists
All available prefix lists.
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.
com.amazonaws.internal.SdkInternalList<T> regionNames
The names of one or more regions.
com.amazonaws.internal.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
).
com.amazonaws.internal.SdkInternalList<T> regions
Information about one or more regions.
String reservedInstancesId
One or more Reserved Instance IDs.
String reservedInstancesListingId
One or more Reserved Instance listing IDs.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesListings
Information about the Reserved Instance listing.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesModificationIds
IDs for the submitted modification request.
String nextToken
The token to retrieve the next page of results.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesModifications
The Reserved Instance modification information.
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.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesOfferingIds
One or more Reserved Instances offering IDs.
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.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
String productDescription
The Reserved Instance product platform description. Instances that include (Amazon VPC)
in the
description are for use with Amazon VPC.
com.amazonaws.internal.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).
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).
Default: default
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.
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 of the initial
request can be seen by sending another request with the returned NextToken
value. The maximum is
100.
Default: 100
Boolean includeMarketplace
Include Reserved Instance Marketplace offerings in the response.
Long minDuration
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
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
String offeringClass
The offering class of the Reserved Instance. Can be standard
or convertible
.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesIds
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
com.amazonaws.internal.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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
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.
String offeringClass
Describes whether the Reserved Instance is Standard or Convertible.
com.amazonaws.internal.SdkInternalList<T> reservedInstances
A list of Reserved Instances.
com.amazonaws.internal.SdkInternalList<T> routeTableIds
One or more route table IDs.
Default: Describes all your route tables.
com.amazonaws.internal.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-table-id
- The ID of the route table.
route.destination-cidr-block
- The CIDR range specified in a route in the table.
route.destination-prefix-list-id
- The ID (prefix) of the AWS service specified in a route in the
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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
vpc-id
- The ID of the VPC for the route table.
com.amazonaws.internal.SdkInternalList<T> routeTables
Information about one or more route tables.
ScheduledInstanceRecurrenceRequest recurrence
The schedule recurrence.
SlotDateTimeRangeRequest firstSlotStartTimeRange
The time period for the first schedule to start.
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.
Integer maxSlotDurationInHours
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours
and
less than 1,720.
String nextToken
The token for the next set of results.
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.
com.amazonaws.internal.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
).
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
com.amazonaws.internal.SdkInternalList<T> scheduledInstanceAvailabilitySet
Information about the available Scheduled Instances.
com.amazonaws.internal.SdkInternalList<T> scheduledInstanceIds
One or more Scheduled Instance IDs.
SlotStartTimeRangeRequest slotStartTimeRange
The time period for the first schedule to start.
String nextToken
The token for the next set of results.
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.
com.amazonaws.internal.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
).
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
com.amazonaws.internal.SdkInternalList<T> scheduledInstanceSet
Information about the Scheduled Instances.
com.amazonaws.internal.SdkInternalList<T> groupId
One or more security group IDs in your account.
com.amazonaws.internal.SdkInternalList<T> securityGroupReferenceSet
Information about the VPCs with the referencing security groups.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> groupIds
One or more security group IDs. Required for security groups in a nondefault VPC.
Default: Describes all your security groups.
com.amazonaws.internal.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.prefix-list-id
- The ID (prefix) of the AWS service to which the security group
allows access.
group-id
- The ID of the security group.
group-name
- The name of the security group.
ip-permission.cidr
- A CIDR range that has been granted permission.
ip-permission.from-port
- 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 granted permission.
ip-permission.group-name
- The name of a security group that has been granted permission.
ip-permission.protocol
- The IP protocol for the permission (tcp
| udp
|
icmp
or a protocol number).
ip-permission.to-port
- 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 granted permission.
owner-id
- The AWS account ID of the owner of the security group.
tag-key
- The key of a tag assigned to the security group.
tag-value
- The value of a tag assigned to the security group.
vpc-id
- The ID of the VPC specified when the security group was created.
com.amazonaws.internal.SdkInternalList<T> securityGroups
Information about one or more security groups.
String snapshotId
The ID of the EBS snapshot.
com.amazonaws.internal.SdkInternalList<T> createVolumePermissions
A list of permissions for creating volumes from the snapshot.
com.amazonaws.internal.SdkInternalList<T> productCodes
A list of product codes.
com.amazonaws.internal.SdkInternalList<T> snapshotIds
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
com.amazonaws.internal.SdkInternalList<T> ownerIds
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
com.amazonaws.internal.SdkInternalList<T> restorableByUserIds
One or more AWS accounts IDs that can create volumes from the snapshot.
com.amazonaws.internal.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 consolew.
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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
volume-id
- The ID of the volume the snapshot is for.
volume-size
- The size of the volume, in GiB.
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.
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.
com.amazonaws.internal.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.
String spotFleetRequestId
The ID of the Spot fleet request.
String nextToken
The token for the next set of results.
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 spotFleetRequestId
The ID of the Spot fleet request.
com.amazonaws.internal.SdkInternalList<T> activeInstances
The running instances. Note that 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.
Date startTime
The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String nextToken
The token for the next set of results.
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 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).
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.
com.amazonaws.internal.SdkInternalList<T> historyRecords
Information about the events in the history of the Spot fleet request.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
com.amazonaws.internal.SdkInternalList<T> spotFleetRequestIds
The IDs of the Spot fleet requests.
String nextToken
The token for the next set of results.
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.
com.amazonaws.internal.SdkInternalList<T> spotFleetRequestConfigs
Information about the configuration of your Spot fleet.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
com.amazonaws.internal.SdkInternalList<T> spotInstanceRequestIds
One or more Spot instance request IDs.
com.amazonaws.internal.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 Amazon EBS volume is
deleted on instance termination.
launch.block-device-mapping.device-name
- The device name for the Amazon EBS volume (for example,
/dev/sdh
).
launch.block-device-mapping.snapshot-id
- The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size
- The size of the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type
- The type of the Amazon 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 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 monitoring is enabled for the Spot instance.
launch.ramdisk-id
- The RAM disk ID.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.device-index
- The index of the device for the network interface attachment on the
instance.
network-interface.subnet-id
- The ID of the subnet for the instance.
network-interface.description
- A description of the network interface.
network-interface.private-ip-address
- The primary private IP address of the network interface.
network-interface.delete-on-termination
- Indicates whether the network interface is deleted when
the instance is terminated.
network-interface.group-id
- The ID of the security group associated with the network interface.
network-interface.group-name
- The name of the security group associated with the network interface.
network-interface.addresses.primary
- Indicates whether the IP address is the primary private IP
address.
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 bid status information can help you
track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon
Elastic Compute Cloud User Guide.
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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
type
- The type of Spot instance request (one-time
| persistent
).
launched-availability-zone
- The Availability Zone in which the bid is launched.
valid-from
- The start date of the request.
valid-until
- The end date of the request.
com.amazonaws.internal.SdkInternalList<T> spotInstanceRequests
One or more Spot instance requests.
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).
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).
com.amazonaws.internal.SdkInternalList<T> instanceTypes
Filters the results by the specified instance types.
com.amazonaws.internal.SdkInternalList<T> productDescriptions
Filters the results by the specified basic product descriptions.
com.amazonaws.internal.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 timestamp 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.
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.
com.amazonaws.internal.SdkInternalList<T> spotPriceHistory
The historical Spot prices.
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 vpcId
The ID of the VPC.
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.)
com.amazonaws.internal.SdkInternalList<T> staleSecurityGroupSet
Information about the stale security groups.
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.
com.amazonaws.internal.SdkInternalList<T> subnetIds
One or more subnet IDs.
Default: Describes all your subnets.
com.amazonaws.internal.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 IP addresses in the subnet that are available.
cidrBlock
- The 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.
state
- The state of the subnet (pending
| available
).
subnet-id
- The ID of the subnet.
tag
:key=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
vpc-id
- The ID of the VPC for the subnet.
com.amazonaws.internal.SdkInternalList<T> subnets
Information about one or more subnets.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type (customer-gateway
| dhcp-options
|
image
| instance
| internet-gateway
| network-acl
|
network-interface
| reserved-instances
| route-table
|
security-group
| snapshot
| spot-instances-request
| subnet
|
volume
| vpc
| vpn-connection
| vpn-gateway
).
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.
com.amazonaws.internal.SdkInternalList<T> tags
A list of tags.
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 volumeId
The ID of the volume.
Boolean autoEnableIO
The state of autoEnableIO
attribute.
com.amazonaws.internal.SdkInternalList<T> productCodes
A list of product codes.
com.amazonaws.internal.SdkInternalList<T> volumeIds
One or more volume IDs.
com.amazonaws.internal.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 that is exposed to the instance (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
| detached
).
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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
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.
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.
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 1000; if MaxResults
is given a value larger than 1000, only 1000 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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> volumeIds
One or more volume IDs.
Default: Describes all your volumes.
com.amazonaws.internal.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
).
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.
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.
com.amazonaws.internal.SdkInternalList<T> volumeStatuses
A list of 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.
String vpcId
The ID of the VPC.
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.
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.
com.amazonaws.internal.SdkInternalList<T> vpcIds
One or more VPC IDs.
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.)
com.amazonaws.internal.SdkInternalList<T> vpcs
Information about the ClassicLink DNS support status of the VPCs.
String nextToken
The token to use when requesting the next set of items.
com.amazonaws.internal.SdkInternalList<T> vpcIds
One or more VPCs for which you want to describe the ClassicLink status.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
is-classic-link-enabled
- Whether the VPC is enabled for ClassicLink (true
|
false
).
tag
:key=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
com.amazonaws.internal.SdkInternalList<T> vpcs
The ClassicLink status of one or more VPCs.
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.)
com.amazonaws.internal.SdkInternalList<T> serviceNames
A list of supported AWS services.
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.
com.amazonaws.internal.SdkInternalList<T> vpcEndpointIds
One or more endpoint IDs.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
service-name
: The name of the AWS 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.)
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> vpcPeeringConnectionIds
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
accepter-vpc-info.cidr-block
- The CIDR block of the peer VPC.
accepter-vpc-info.owner-id
- The AWS account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id
- The ID of the peer VPC.
expiration-time
- The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block
- The 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
|
deleted
| rejected
).
status-message
- A message that provides more information about the status of the VPC peering
connection, if applicable.
tag
:key=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
vpc-peering-connection-id
- The ID of the VPC peering connection.
com.amazonaws.internal.SdkInternalList<T> vpcPeeringConnections
Information about the VPC peering connections.
com.amazonaws.internal.SdkInternalList<T> vpcIds
One or more VPC IDs.
Default: Describes all your VPCs.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
cidr
- The 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
).
dhcp-options-id
- The ID of a set of DHCP options.
isDefault
- Indicates whether the VPC is the default VPC.
state
- The state of the VPC (pending
| available
).
tag
:key=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
vpc-id
- The ID of the VPC.
com.amazonaws.internal.SdkInternalList<T> vpcs
Information about one or more VPCs.
com.amazonaws.internal.SdkInternalList<T> vpnConnectionIds
One or more VPN connection IDs.
Default: Describes your VPN connections.
com.amazonaws.internal.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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
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.
com.amazonaws.internal.SdkInternalList<T> vpnConnections
Information about one or more VPN connections.
com.amazonaws.internal.SdkInternalList<T> vpnGatewayIds
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
com.amazonaws.internal.SdkInternalList<T> filters
One or more filters.
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=value - The key/value combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
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.
com.amazonaws.internal.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 volumeId
The ID of the volume.
String instanceId
The ID of the instance.
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.
VolumeAttachment attachment
Describes volume attachment details.
String key
The name of a DHCP option.
com.amazonaws.internal.SdkInternalList<T> values
One or more values for the DHCP option.
String dhcpOptionsId
The ID of the set of DHCP options.
com.amazonaws.internal.SdkInternalList<T> dhcpConfigurations
One or more DHCP options in the set.
com.amazonaws.internal.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 association ID representing the current association between the route table and subnet.
DiskImageDetail image
Information about the disk image.
String description
A description of the disk image.
VolumeDetail volume
Information about the volume.
String format
The disk image format.
Long size
The size of the disk image, in GiB.
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.
String checksum
The checksum computed for the disk image.
String format
The disk image format.
Long bytes
The size of the disk image, in GiB.
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.
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.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
String volumeType
The volume type: gp2
, io1
, st1
, sc1
, or standard
.
Default: standard
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.
Boolean encrypted
Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
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 instanceId
The ID of the instance. This information is available only for instanceChange
events.
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 will not launch additional Spot instances, but
its 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 bid 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 bid was fulfilled and a new instance was launched.
terminated
- An instance was terminated by the user.
String eventDescription
The description of the event.
String exportTaskId
The ID of the export task.
String description
A description of the resource being exported.
String state
The state of the export task.
String statusMessage
The status message related to the export task.
InstanceExportDetails instanceExportDetails
Information about the instance to export.
ExportToS3Task exportToS3Task
Information about the export task.
String diskImageFormat
The format for the exported image.
String containerFormat
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
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 diskImageFormat
The format for the exported image.
String containerFormat
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
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.
com.amazonaws.internal.SdkInternalList<T> values
One or more filter values. Filter values are case-sensitive.
Date creationTime
The date and time the flow log was created.
String flowLogId
The flow log ID.
String flowLogStatus
The status of the flow log (ACTIVE
).
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 logGroupName
The name of the flow log group.
String deliverLogsStatus
The status of the logs delivery (SUCCESS
| FAILED
).
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 CloudWatch
Logs 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 instanceId
The ID of the instance.
String offeringId
The offering ID of the reservation.
com.amazonaws.internal.SdkInternalList<T> hostIdSet
The ID/s of the Dedicated Host/s that the reservation will be associated with.
com.amazonaws.internal.SdkInternalList<T> purchase
The purchase information of the Dedicated Host Reservation and the Dedicated Hosts associated with it.
String totalUpfrontPrice
The potential total upfront price. This is billed immediately.
String totalHourlyPrice
The potential total hourly price of the reservation per hour.
String currencyCode
The currency in which the totalUpfrontPrice
and totalHourlyPrice
amounts are specified.
At this time, the only supported currency is USD
.
String instanceId
The ID of the Windows instance.
com.amazonaws.internal.SdkInternalList<T> reservedInstanceIds
The ID/s of the Convertible Reserved Instances you want to exchange.
com.amazonaws.internal.SdkInternalList<T> targetConfigurations
The configuration requirements of the Convertible Reserved Instances you want in exchange for your current Convertible Reserved Instances.
com.amazonaws.internal.SdkInternalList<T> reservedInstanceValueSet
The configuration of your Convertible Reserved Instances.
ReservationValue reservedInstanceValueRollup
com.amazonaws.internal.SdkInternalList<T> targetConfigurationValueSet
The values of the target Convertible Reserved Instances.
ReservationValue targetConfigurationValueRollup
String paymentDue
The total true upfront charge for the exchange.
String currencyCode
The currency of the transaction.
Date outputReservedInstancesWillExpireAt
The new end date of the reservation term.
Boolean isValidExchange
If true
, the exchange is valid. If false
, the exchange cannot be performed.
String validationFailureReason
Describes the reason why the exchange can not be completed.
Date timestamp
The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String eventType
The event type.
error
- Indicates an error with the Spot fleet request.
fleetRequestChange
- Indicates a change in the status or configuration of the Spot fleet request.
instanceChange
- Indicates that an instance was launched or terminated.
EventInformation eventInformation
Information about the event.
String hostId
The ID of the Dedicated Host.
String autoPlacement
Whether auto-placement is on or off.
String hostReservationId
The reservation ID of the Dedicated Host. This returns a null
response if the Dedicated Host doesn't
have an associated 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.
HostProperties hostProperties
The hardware specifications of the Dedicated Host.
String state
The Dedicated Host's state.
String availabilityZone
The Availability Zone of the Dedicated Host.
com.amazonaws.internal.SdkInternalList<T> instances
The IDs and instance type that are currently running on the Dedicated Host.
AvailableCapacity availableCapacity
The number of new instances that can be launched onto the Dedicated Host.
String offeringId
The ID of the offering.
String instanceFamily
The instance family of the offering.
String paymentOption
The available payment option.
String upfrontPrice
The upfront price of the offering. Does not apply to No Upfront offerings.
String hourlyPrice
The hourly price of the offering.
String currencyCode
The currency of the offering.
Integer duration
The duration of the offering (in seconds).
Integer sockets
The number of sockets on the Dedicated Host.
Integer cores
The number of cores on the Dedicated Host.
Integer totalVCpus
The number of vCPUs on the Dedicated Host.
String instanceType
The instance type size that the Dedicated Host supports (for example, m3.medium
).
String hostReservationId
The ID of the reservation that specifies the associated Dedicated Hosts.
com.amazonaws.internal.SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts associated with the reservation.
String offeringId
The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
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 paymentOption
The payment option selected for this reservation.
String hourlyPrice
The hourly price of the reservation.
String upfrontPrice
The upfront price of the reservation.
String currencyCode
The currency in which the upfrontPrice
and hourlyPrice
amounts are specified. At this
time, the only supported currency is USD
.
Integer count
The number of Dedicated Hosts the reservation is associated with.
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.
Date start
The date and time that the reservation started.
String state
The state of the reservation.
String resource
The type of resource.
Boolean useLongIds
Indicates whether longer IDs (17-character IDs) are enabled for the resource.
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 imageId
The ID of the AMI.
String imageLocation
The location of the AMI.
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.
String ownerId
The AWS account ID of the image owner.
String creationDate
The date and time the image was created.
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.
com.amazonaws.internal.SdkInternalList<T> productCodes
Any product codes associated with the AMI.
String architecture
The architecture of the image.
String imageType
The type of image.
String kernelId
The kernel associated with the image, if any. Only applicable for machine images.
String ramdiskId
The RAM disk associated with the image, if any. Only applicable for machine images.
String platform
The value is Windows
for Windows AMIs; otherwise blank.
String sriovNetSupport
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Boolean enaSupport
Specifies whether enhanced networking with ENA is enabled.
StateReason stateReason
The reason for the state change.
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 description
The description of the AMI that was provided during image creation.
String rootDeviceType
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
String rootDeviceName
The device name of the root device (for example, /dev/sda1
or /dev/xvda
).
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
Any block device mapping entries.
String virtualizationType
The type of virtualization of the AMI.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the image.
String hypervisor
The hypervisor type of the image.
String imageId
The ID of the AMI.
com.amazonaws.internal.SdkInternalList<T> launchPermissions
One or more launch permissions.
com.amazonaws.internal.SdkInternalList<T> productCodes
One or more product codes.
String kernelId
The kernel ID.
String ramdiskId
The RAM disk ID.
String description
A description for the AMI.
String sriovNetSupport
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
String description
The description of the disk image.
String format
The format of the disk image being imported.
Valid values: RAW
| VHD
| VMDK
| OVA
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 deviceName
The block device mapping for the disk.
String snapshotId
The ID of the EBS snapshot to be used for importing the snapshot.
String description
A description string for the import image task.
com.amazonaws.internal.SdkInternalList<T> diskContainers
Information about the disk containers.
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 hypervisor
The target hypervisor platform.
Valid values: xen
String architecture
The architecture of the virtual machine.
Valid values: i386
| x86_64
String platform
The operating system of the virtual machine.
Valid values: Windows
| Linux
ClientData clientData
The client-specific data.
String clientToken
The token to enable idempotency for VM import requests.
String roleName
The name of the role to use when not using the default role, 'vmimport'.
String importTaskId
The task ID of the import image task.
String architecture
The architecture of the virtual machine.
String licenseType
The license type of the virtual machine.
String platform
The operating system of the virtual machine.
String hypervisor
The target hypervisor of the import task.
String description
A description of the import task.
com.amazonaws.internal.SdkInternalList<T> snapshotDetails
Information about the snapshots.
String imageId
The ID of the Amazon Machine Image (AMI) created by the import task.
String progress
The progress of the task.
String statusMessage
A detailed status message of the import task.
String status
A brief status of the task.
String importTaskId
The ID of the import image task.
String architecture
The architecture of the virtual machine.
Valid values: i386
| x86_64
String licenseType
The license type of the virtual machine.
String platform
The description string for the import image task.
String hypervisor
The target hypervisor for the import task.
Valid values: xen
String description
A description of the import task.
com.amazonaws.internal.SdkInternalList<T> snapshotDetails
Information about the snapshots.
String imageId
The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
String progress
The percentage of progress of the import image task.
String statusMessage
A descriptive status message for the import image task.
String status
A brief status for the import image task.
String architecture
The architecture of the instance.
com.amazonaws.internal.SdkInternalList<T> groupNames
One or more security group names.
com.amazonaws.internal.SdkInternalList<T> groupIds
One or more security group IDs.
String additionalInfo
Reserved.
UserData userData
The user data to make available to the instance. 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 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.
Placement placement
The placement information for the instance.
Boolean monitoring
Indicates whether monitoring is enabled.
String subnetId
[EC2-VPC] The ID of the subnet in which to launch 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 privateIpAddress
[EC2-VPC] An available IP address from the IP address range of the subnet.
String description
A description for the instance being imported.
ImportInstanceLaunchSpecification launchSpecification
The launch specification.
com.amazonaws.internal.SdkInternalList<T> diskImages
The disk image.
String platform
The instance operating system.
ConversionTask conversionTask
Information about the conversion task.
com.amazonaws.internal.SdkInternalList<T> volumes
One or more volumes.
String instanceId
The ID of the instance.
String platform
The instance operating system.
String description
A description of the task.
Long bytesConverted
The number of bytes converted so far.
String availabilityZone
The Availability Zone where the resulting instance will reside.
DiskImageDescription image
The image.
DiskImageVolumeDescription volume
The volume.
String status
The status of the import of this particular disk image.
String statusMessage
The status information or errors related to the disk image.
String description
A description of the task.
String description
The description string for the import snapshot task.
SnapshotDiskContainer diskContainer
Information about the disk container.
ClientData clientData
The client-specific data.
String clientToken
Token to enable idempotency for VM import requests.
String roleName
The name of the role to use when not using the default role, 'vmimport'.
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 description
A description of the import snapshot task.
String availabilityZone
The Availability Zone for the resulting EBS volume.
DiskImageDetail image
The disk image.
String description
A description of the volume.
VolumeDetail volume
The volume size.
ConversionTask conversionTask
Information about the conversion task.
Long bytesConverted
The number of bytes converted so far.
String availabilityZone
The Availability Zone where the resulting volume will reside.
String description
The description you provided when starting the import volume task.
DiskImageDescription image
The image.
DiskImageVolumeDescription volume
The volume.
String instanceId
The ID of the instance.
String imageId
The ID of the AMI used to launch the instance.
InstanceState state
The current state of the instance.
String privateDnsName
The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. 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 publicDnsName
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 stateTransitionReason
The reason for the most recent state transition. This might be an empty string.
String keyName
The name of the key pair, if this instance was launched with an associated key pair.
Integer amiLaunchIndex
The AMI launch index, which can be used to find this instance in the launch group.
com.amazonaws.internal.SdkInternalList<T> productCodes
The product codes attached to this instance, if applicable.
String instanceType
The instance type.
Date launchTime
The time the instance was launched.
Placement placement
The location where the instance launched, if applicable.
String kernelId
The kernel associated with this instance, if applicable.
String ramdiskId
The RAM disk associated with this instance, if applicable.
String platform
The value is Windows
for Windows instances; otherwise blank.
Monitoring monitoring
The monitoring information for the instance.
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 privateIpAddress
The private IP address assigned to the instance.
String publicIpAddress
The public IP address assigned to the instance, if applicable.
StateReason stateReason
The reason for the most recent state transition.
String architecture
The architecture of the image.
String rootDeviceType
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
String rootDeviceName
The root device name (for example, /dev/sda1
or /dev/xvda
).
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
Any block device mapping entries for the instance.
String virtualizationType
The virtualization type of the instance.
String instanceLifecycle
Indicates whether this is a Spot instance or a Scheduled Instance.
String spotInstanceRequestId
If the request is a Spot instance request, the ID of the request.
String clientToken
The idempotency token you provided when you launched the instance, if applicable.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the instance.
com.amazonaws.internal.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 checking is enabled,
and false
means 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 hypervisor
The hypervisor type of the instance.
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
[EC2-VPC] One or more network interfaces for the instance.
IamInstanceProfile iamInstanceProfile
The IAM instance profile associated with the instance, if applicable.
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 I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
String sriovNetSupport
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Boolean enaSupport
Specifies whether enhanced networking with ENA is enabled.
String instanceId
The ID of the instance.
String instanceType
The instance type.
String kernelId
The kernel ID.
String ramdiskId
The RAM disk ID.
String userData
The user data.
Boolean disableApiTermination
If the value is true
, you can't terminate the instance through the Amazon EC2 console, CLI, or API;
otherwise, you can.
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 rootDeviceName
The name of the root device (for example, /dev/sda1
or /dev/xvda
).
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
The block device mapping of the instance.
com.amazonaws.internal.SdkInternalList<T> productCodes
A list of product codes.
Boolean ebsOptimized
Indicates whether the instance is optimized for EBS I/O.
String sriovNetSupport
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Boolean enaSupport
Indicates whether enhanced networking with ENA is enabled.
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.
com.amazonaws.internal.SdkInternalList<T> groups
The security groups associated with the instance.
String deviceName
The device name exposed to the instance (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 exposed to the instance (for example, /dev/sdh
or xvdh
).
EbsInstanceBlockDeviceSpecification ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String virtualName
The virtual device name.
String noDevice
suppress the specified device included in the block device mapping.
String instanceType
The instance type size supported by the Dedicated Host.
Integer availableCapacity
The number of instances that can still be launched onto the Dedicated Host.
Integer totalCapacity
The total number of instances that can be launched onto the Dedicated Host.
String instanceId
The ID of the instance.
Monitoring monitoring
The monitoring information.
String networkInterfaceId
The ID of the network interface.
String subnetId
The ID of the subnet.
String vpcId
The ID of the VPC.
String description
The description.
String ownerId
The ID of the AWS account that created the network interface.
String status
The status of the network interface.
String macAddress
The MAC address.
String privateIpAddress
The IP address of the network interface within the subnet.
String privateDnsName
The private DNS name.
Boolean sourceDestCheck
Indicates whether to validate network traffic to or from this network interface.
com.amazonaws.internal.SdkInternalList<T> groups
One or more security groups.
InstanceNetworkInterfaceAttachment attachment
The network interface attachment.
InstanceNetworkInterfaceAssociation association
The association information for an Elastic IP associated with the network interface.
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
The private IP addresses associated with the network interface.
String attachmentId
The ID of the network interface attachment.
Integer deviceIndex
The index of the device on the instance for the network interface attachment.
String status
The attachment state.
Date attachTime
The time stamp when the attachment initiated.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
String networkInterfaceId
The ID of the network interface.
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.
String subnetId
The ID of the subnet associated with the network string. Applies only if creating a 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.
String privateIpAddress
The private IP 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.
com.amazonaws.internal.SdkInternalList<T> groups
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
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.
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
One or more private IP addresses to assign to the network interface. Only one private IP 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 IP 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.
Boolean associatePublicIpAddress
Indicates whether to assign a public IP 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
.
String privateIpAddress
The private IP address of the network interface.
String privateDnsName
The private DNS name.
Boolean primary
Indicates whether this IP address is the primary private IP address of the network interface.
InstanceNetworkInterfaceAssociation association
The association information for an Elastic IP address for the network interface.
String instanceId
The ID of the instance.
InstanceState currentState
The current state of the instance.
InstanceState previousState
The previous state of the instance.
String instanceId
The ID of the instance.
String availabilityZone
The Availability Zone of the instance.
com.amazonaws.internal.SdkInternalList<T> events
Any scheduled events associated with the instance.
InstanceState instanceState
The intended state of the instance. DescribeInstanceStatus requires that an instance be in the
running
state.
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.
InstanceStatusSummary instanceStatus
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
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 notBefore
The earliest scheduled start time for the event.
Date notAfter
The latest scheduled end time for the event.
String status
The status.
com.amazonaws.internal.SdkInternalList<T> details
The system instance health or application instance health.
String internetGatewayId
The ID of the Internet gateway.
com.amazonaws.internal.SdkInternalList<T> attachments
Any VPCs attached to the Internet gateway.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the Internet gateway.
String ipProtocol
The IP protocol name (for tcp
, udp
, and icmp
) or number (see Protocol Numbers).
[EC2-VPC only] When you authorize or revoke security group rules, you can use -1
to specify all.
Integer fromPort
The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1
indicates all ICMP types.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1
indicates all
ICMP codes for the specified ICMP type.
com.amazonaws.internal.SdkInternalList<T> userIdGroupPairs
One or more security group and AWS account ID pairs.
com.amazonaws.internal.SdkInternalList<T> ipRanges
One or more IP ranges.
com.amazonaws.internal.SdkInternalList<T> prefixListIds
(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.
String keyName
The name of the key pair.
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.
com.amazonaws.internal.SdkInternalList<T> add
The AWS account ID to add to the list of launch permissions for the AMI.
com.amazonaws.internal.SdkInternalList<T> remove
The AWS account ID to remove from the list of launch permissions for the AMI.
String imageId
The ID of the AMI.
String keyName
The name of the key pair.
String userData
The user data to make available to the instances. 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 addressingType
Deprecated.
String instanceType
The instance type.
SpotPlacement placement
The placement information for the instance.
String kernelId
The ID of the kernel.
String ramdiskId
The ID of the RAM disk.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.
String subnetId
The ID of the subnet in which to launch the instance.
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
One or more network interfaces.
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
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
com.amazonaws.internal.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
com.amazonaws.internal.SdkInternalList<T> securityGroups
One or more security group names.
com.amazonaws.internal.SdkInternalList<T> hostIds
The host IDs of the Dedicated Hosts you want to modify.
String autoPlacement
Specify whether to enable or disable auto-placement.
com.amazonaws.internal.SdkInternalList<T> successful
The IDs of the Dedicated Hosts that were successfully modified.
com.amazonaws.internal.SdkInternalList<T> unsuccessful
The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
String resource
The type of resource: instance
| reservation
| snapshot
|
volume
Boolean useLongIds
Indicates whether the resource should use longer IDs (17-character IDs)
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 imageId
The ID of the AMI.
String attribute
The name of the attribute to modify.
String operationType
The operation type.
com.amazonaws.internal.SdkInternalList<T> userIds
One or more AWS account IDs. This is only valid when modifying the launchPermission
attribute.
com.amazonaws.internal.SdkInternalList<T> userGroups
One or more user groups. This is only valid when modifying the launchPermission
attribute.
com.amazonaws.internal.SdkInternalList<T> productCodes
One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when
modifying the productCodes
attribute.
String value
The value of the attribute being modified. This is only valid when modifying the description
attribute.
LaunchPermissionModifications launchPermission
A launch permission modification.
String description
A description for the AMI.
String instanceId
The ID of the instance.
String attribute
The name of the attribute.
String value
A new value for the attribute. Use only with the kernel
, ramdisk
, userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
attribute.
com.amazonaws.internal.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 sourceDestCheck
Specifies whether source/destination checking is enabled. A value of true
means that checking is
enabled, and false
means checking is disabled. This value must be false
for a NAT
instance to perform NAT.
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 paramater for Spot Instances.
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 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 instanceInitiatedShutdownBehavior
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
com.amazonaws.internal.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.
Boolean ebsOptimized
Specifies 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.
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.
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.
String instanceId
The ID of the instance that you are modifying.
String tenancy
The tenancy of the instance that you are modifying.
String affinity
The new affinity setting for the instance.
String hostId
The ID of the Dedicated Host that the instance will have affinity with.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String networkInterfaceId
The ID of the network interface.
String description
A description for 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.
com.amazonaws.internal.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.
NetworkInterfaceAttachmentChanges attachment
Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
String clientToken
A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesIds
The IDs of the Reserved Instances to modify.
com.amazonaws.internal.SdkInternalList<T> targetConfigurations
The configuration settings for the Reserved Instances to modify.
String reservedInstancesModificationId
The ID for the modification.
String snapshotId
The ID of the snapshot.
String attribute
The snapshot attribute to modify.
Only volume creation permissions may be modified at the customer level.
String operationType
The type of operation to perform to the attribute.
com.amazonaws.internal.SdkInternalList<T> userIds
The account ID to modify for the snapshot.
com.amazonaws.internal.SdkInternalList<T> groupNames
The group to modify for the snapshot.
CreateVolumePermissionModifications createVolumePermission
A JSON representation of the snapshot attribute modification.
String spotFleetRequestId
The ID of the Spot fleet request.
Integer targetCapacity
The size of the fleet.
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.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String vpcId
The ID of the VPC.
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" will 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.
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.
String vpcEndpointId
The ID of the endpoint.
Boolean resetPolicy
Specify true
to reset the policy document to the default policy. The default policy allows access to
the service.
String policyDocument
A policy document to attach to the endpoint. The policy must be in valid JSON format.
com.amazonaws.internal.SdkInternalList<T> addRouteTableIds
One or more route tables IDs to associate with the endpoint.
com.amazonaws.internal.SdkInternalList<T> removeRouteTableIds
One or more route table IDs to disassociate from the endpoint.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
PeeringConnectionOptionsRequest requesterPeeringConnectionOptions
The VPC peering connection options for the requester VPC.
PeeringConnectionOptionsRequest accepterPeeringConnectionOptions
The VPC peering connection options for the accepter VPC.
PeeringConnectionOptions requesterPeeringConnectionOptions
Information about the VPC peering connection options for the requester VPC.
PeeringConnectionOptions accepterPeeringConnectionOptions
Information about the VPC peering connection options for the accepter VPC.
String state
Indicates whether monitoring is enabled for the instance.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
com.amazonaws.internal.SdkInternalList<T> instanceMonitorings
Monitoring information for one or more instances.
String publicIp
The Elastic IP address.
String vpcId
The ID of the VPC in which the NAT gateway is located.
String subnetId
The ID of the subnet in which the NAT gateway is located.
String natGatewayId
The ID of the NAT gateway.
Date createTime
The date and time the NAT gateway was created.
Date deleteTime
The date and time the NAT gateway was deleted, if applicable.
com.amazonaws.internal.SdkInternalList<T> natGatewayAddresses
Information about the IP addresses and network interface associated with the NAT gateway.
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 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."
ProvisionedBandwidth provisionedBandwidth
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String publicIp
The Elastic IP address associated with the NAT gateway.
String allocationId
The allocation ID of the Elastic IP address that's associated with the NAT gateway.
String privateIp
The private IP address associated with the Elastic IP address.
String networkInterfaceId
The ID of the network interface associated with the NAT gateway.
String networkAclId
The ID of the network ACL.
String vpcId
The ID of the VPC for the network ACL.
Boolean isDefault
Indicates whether this is the default network ACL for the VPC.
com.amazonaws.internal.SdkInternalList<T> entries
One or more entries (rules) in the network ACL.
com.amazonaws.internal.SdkInternalList<T> associations
Any associations between the network ACL and one or more subnets
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the network ACL.
Integer ruleNumber
The rule number for the entry. ACL entries are processed in ascending order by rule number.
String protocol
The protocol. A value of -1
means all protocols.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Boolean egress
Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
String cidrBlock
The network range to allow or deny, in CIDR notation.
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP type and code.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to.
String networkInterfaceId
The ID of the network interface.
String subnetId
The ID of the subnet.
String vpcId
The ID of the VPC.
String availabilityZone
The Availability Zone.
String description
A description.
String ownerId
The AWS account ID of the owner of 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.
String status
The status of the network interface.
String macAddress
The MAC address.
String privateIpAddress
The IP address of the network interface within the subnet.
String privateDnsName
The private DNS name.
Boolean sourceDestCheck
Indicates whether traffic to or from the instance is validated.
com.amazonaws.internal.SdkInternalList<T> groups
Any security groups for the network interface.
NetworkInterfaceAttachment attachment
The network interface attachment.
NetworkInterfaceAssociation association
The association information for an Elastic IP associated with the network interface.
com.amazonaws.internal.SdkInternalList<T> tagSet
Any tags assigned to the network interface.
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
The private IP addresses associated with the network interface.
String interfaceType
The type of interface.
String publicIp
The address of the Elastic IP address bound to the network interface.
String publicDnsName
The public DNS name.
String ipOwnerId
The ID of the Elastic IP address owner.
String allocationId
The allocation ID.
String associationId
The association ID.
String attachmentId
The ID of the network interface attachment.
String instanceId
The ID of the instance.
String instanceOwnerId
The AWS account ID of the owner of the instance.
Integer deviceIndex
The device index of the network interface attachment on the instance.
String status
The attachment state.
Date attachTime
The timestamp indicating when the attachment initiated.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
String privateIpAddress
The private IP address.
String privateDnsName
The private DNS name.
Boolean primary
Indicates whether this IP address is the primary private IP address of the network interface.
NetworkInterfaceAssociation association
The association information for an Elastic IP address associated with the network interface.
Boolean allowEgressFromLocalClassicLinkToRemoteVpc
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via 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 via 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 via 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 via 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.
String availabilityZone
The Availability Zone of the instance.
String groupName
The name of the placement group the instance is in (for cluster compute instances).
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 hostId
The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.
String affinity
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
String prefixListId
The ID of the prefix.
String prefixListName
The name of the prefix.
com.amazonaws.internal.SdkInternalList<T> cidrs
The IP address range of the AWS service.
String prefixListId
The ID of the prefix.
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.
Double price
The fixed price for the term.
String currencyCode
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
USD
.
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.
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.
Double price
The fixed price for the term.
String currencyCode
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
USD
.
String gatewayId
The ID of the virtual private gateway (VGW).
String provisioned
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.
Date requestTime
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
Date provisionTime
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 hostReservationId
The ID of the reservation.
com.amazonaws.internal.SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts associated with the reservation.
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 hourlyPrice
The hourly price of the reservation per hour.
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.
String offeringId
The ID of the offering.
com.amazonaws.internal.SdkInternalList<T> hostIdSet
The ID/s of the Dedicated Host/s that the reservation will be associated with.
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 will fail. 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 currencyCode
The currency in which the totalUpfrontPrice
, LimitPrice
, and
totalHourlyPrice
amounts are specified. At this time, the only supported currency is
USD
.
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.
com.amazonaws.internal.SdkInternalList<T> purchase
Describes the details of the purchase.
String totalUpfrontPrice
The total amount that will be charged to your account when you purchase the reservation.
String totalHourlyPrice
The total hourly price of the reservation calculated per hour.
String currencyCode
The currency in which the totalUpfrontPrice
and totalHourlyPrice
amounts are specified.
At this time, the only supported currency is USD
.
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 reservedInstancesOfferingId
The ID of the Reserved Instance offering to purchase.
Integer instanceCount
The number of Reserved Instances 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.
com.amazonaws.internal.SdkInternalList<T> purchaseRequests
One or more purchase requests.
com.amazonaws.internal.SdkInternalList<T> scheduledInstanceSet
Information about the Scheduled Instances.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
String imageLocation
The full path to your AMI manifest in Amazon S3 storage.
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(_)
String description
A description for your AMI.
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.
String kernelId
The ID of the kernel.
String ramdiskId
The ID of the RAM disk.
String rootDeviceName
The name of the root device (for example, /dev/sda1
, or /dev/xvda
).
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
String virtualizationType
The type of virtualization.
Default: paravirtual
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.
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 imageId
The ID of the newly registered AMI.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
com.amazonaws.internal.SdkInternalList<T> hostIds
The IDs of the Dedicated Hosts you want to release.
com.amazonaws.internal.SdkInternalList<T> successful
The IDs of the Dedicated Hosts that were successfully released.
com.amazonaws.internal.SdkInternalList<T> unsuccessful
The IDs of the Dedicated Hosts that could not be released, including an error message.
String newAssociationId
The ID of the new association.
String networkAclId
The ID of the ACL.
Integer ruleNumber
The rule number of the entry to replace.
String protocol
The IP protocol. You can specify all
or -1
to mean all protocols.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Boolean egress
Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
String cidrBlock
The network range to allow or deny, in CIDR notation.
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.
String routeTableId
The ID of the route table.
String destinationCidrBlock
The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.
String gatewayId
The ID of an Internet gateway or virtual private gateway.
String instanceId
The ID of a NAT instance in your VPC.
String networkInterfaceId
The ID of a network interface.
String vpcPeeringConnectionId
The ID of a VPC peering connection.
String natGatewayId
The ID of a NAT gateway.
String newAssociationId
The ID of the new association.
com.amazonaws.internal.SdkInternalList<T> instances
One or more instances.
String status
The status of all instances listed.
Date startTime
The time at which the reported instance health state began.
Date endTime
The time at which the reported instance health state ended.
com.amazonaws.internal.SdkInternalList<T> reasonCodes
One or more reason codes that describes 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 which I believe are network
related.
performance-instance-store
: My instance is experiencing performance problems which I believe are
related to the instance stores.
performance-ebs-volume
: My instance is experiencing performance problems which I believe are related
to an EBS volume.
performance-other
: My instance is experiencing performance problems.
other
: [explain using the description parameter]
String description
Descriptive text about the health state of your instance.
SpotFleetRequestConfigData spotFleetRequestConfig
The configuration for the Spot fleet request.
String spotFleetRequestId
The ID of the Spot fleet request.
String spotPrice
The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
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.
Integer instanceCount
The maximum number of Spot instances to launch.
Default: 1
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.
Default: The request is effective indefinitely.
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 and time is reached.
Default: The request is effective indefinitely.
String launchGroup
The instance launch group. Launch groups are Spot instances that launch together and terminate together.
Default: Instances are launched and terminated individually
String availabilityZoneGroup
The user-specified name for a logical grouping of bids.
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 bids 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 bid is expired, or the bid falls below current market), 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.
Note that you can't specify an Availability Zone group or a launch group if you specify a duration.
LaunchSpecification launchSpecification
com.amazonaws.internal.SdkInternalList<T> spotInstanceRequests
One or more Spot instance requests.
String reservationId
The ID of the reservation.
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).
com.amazonaws.internal.SdkInternalList<T> groups
[EC2-Classic only] One or more security groups.
com.amazonaws.internal.SdkInternalList<T> instances
One or more instances.
com.amazonaws.internal.SdkInternalList<T> groupNames
One or more security group names.
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.
String hourlyPrice
The hourly rate of the reservation.
String reservedInstanceId
The ID of the Convertible Reserved Instance that you are exchanging.
ReservationValue reservationValue
The total value of the Convertible Reserved Instance that you are exchanging.
String reservedInstancesId
The ID of the Reserved Instance.
String instanceType
The instance type on which the Reserved Instance can be used.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
Date start
The date and time the Reserved Instance started.
Date end
The time when the Reserved Instance expires.
Long duration
The duration of the Reserved Instance, in seconds.
Float usagePrice
The usage price of the Reserved Instance, per hour.
Float fixedPrice
The purchase price of the Reserved Instance.
Integer instanceCount
The number of reservations purchased.
String productDescription
The Reserved Instance product platform description.
String state
The state of the Reserved Instance purchase.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the resource.
String instanceTenancy
The tenancy of the instance.
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 offeringType
The Reserved Instance offering type.
com.amazonaws.internal.SdkInternalList<T> recurringCharges
The recurring charge tag assigned to the resource.
String offeringClass
The offering class of the Reserved Instance.
String scope
The scope of the Reserved Instance.
String availabilityZone
The Availability Zone for the modified Reserved Instances.
String platform
The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
Integer instanceCount
The number of modified Reserved Instances.
String instanceType
The instance type for the modified Reserved Instances.
String scope
Whether the Reserved Instance is standard
or convertible
.
String reservedInstancesId
The ID of the Reserved Instance.
String reservedInstancesListingId
The ID of the Reserved Instance listing.
String reservedInstancesId
The ID of the Reserved Instance.
Date createDate
The time the listing was created.
Date updateDate
The last modified timestamp of the 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.
com.amazonaws.internal.SdkInternalList<T> instanceCounts
The number of instances in this state.
com.amazonaws.internal.SdkInternalList<T> priceSchedules
The price of the Reserved Instance listing.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the resource.
String clientToken
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
String reservedInstancesModificationId
A unique ID for the Reserved Instance modification.
com.amazonaws.internal.SdkInternalList<T> reservedInstancesIds
The IDs of one or more Reserved Instances.
com.amazonaws.internal.SdkInternalList<T> modificationResults
Contains target configurations along with their corresponding new Reserved Instance IDs.
Date createDate
The time when the modification request was created.
Date updateDate
The time when the modification request was last updated.
Date effectiveDate
The time for the modification to become effective.
String status
The status of the Reserved Instances modification request.
String statusMessage
The reason for the status.
String clientToken
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
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 reservedInstancesOfferingId
The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
String instanceType
The instance type on which the Reserved Instance can be used.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
Long duration
The duration of the Reserved Instance, in seconds.
Float usagePrice
The usage price of the Reserved Instance, per hour.
Float fixedPrice
The purchase price of the Reserved Instance.
String productDescription
The Reserved Instance product platform description.
String instanceTenancy
The tenancy of the instance.
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 offeringType
The Reserved Instance offering type.
com.amazonaws.internal.SdkInternalList<T> recurringCharges
The recurring charge tag assigned to the resource.
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
.
com.amazonaws.internal.SdkInternalList<T> pricingDetails
The pricing details of the Reserved Instance offering.
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 scope
Whether the Reserved Instance is applied to instances in a region or an Availability Zone.
String instanceId
The ID of the instance.
String attribute
The attribute to reset.
You can only reset the following attributes: kernel
| ramdisk
|
sourceDestCheck
. To change an instance attribute, use ModifyInstanceAttribute.
String publicIp
The Elastic IP address.
String groupId
The ID of the security group.
String sourceSecurityGroupName
The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.
String sourceSecurityGroupOwnerId
The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.
String ipProtocol
The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.
Integer fromPort
The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.
String cidrIp
The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.
com.amazonaws.internal.SdkInternalList<T> ipPermissions
A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
String groupName
[EC2-Classic, default VPC] The name of the security group.
String groupId
The ID of the security group. Required for a security group in a nondefault VPC.
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.
String ipProtocol
The IP protocol name (tcp
, udp
, icmp
) or number (see Protocol Numbers). Use
-1
to specify all.
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.
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 cidrIp
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
com.amazonaws.internal.SdkInternalList<T> ipPermissions
A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
String destinationCidrBlock
The CIDR block used for the destination match.
String destinationPrefixListId
The prefix of the AWS service.
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 networkInterfaceId
The ID of the network interface.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
String natGatewayId
The ID of a NAT gateway.
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 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 routeTableId
The ID of the route table.
String vpcId
The ID of the VPC.
com.amazonaws.internal.SdkInternalList<T> routes
The routes in the route table.
com.amazonaws.internal.SdkInternalList<T> associations
The associations between the route table and one or more subnets.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the route table.
com.amazonaws.internal.SdkInternalList<T> propagatingVgws
Any virtual private gateway (VGW) propagating routes.
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.
Boolean main
Indicates whether this is the main route table.
String imageId
The ID of the AMI, which you can get by calling DescribeImages.
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.
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.
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.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
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 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 instanceType
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
Placement placement
The placement for the instance.
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 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.
com.amazonaws.internal.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.
Boolean monitoring
The monitoring for the instance.
String subnetId
[EC2-VPC] The ID of the subnet to launch the instance into.
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. If you set this parameter to true
and then later want to be able to
terminate the instance, you must first change the value of the disableApiTermination
attribute to
false
using ModifyInstanceAttribute. Alternatively, if you set
InstanceInitiatedShutdownBehavior
to terminate
, you can terminate the instance by
running the shutdown command from the instance.
Default: false
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 privateIpAddress
[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.
Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary
is set to true
and
PrivateIpAddresses.n.PrivateIpAddress
is set to an IP address.
You cannot specify this option if you're launching more than one instance in the request.
Default: We select an IP address from the IP address range of the subnet.
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 additionalInfo
Reserved.
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
One or more network interfaces.
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
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
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
String scheduledInstanceId
The Scheduled Instance ID.
ScheduledInstancesLaunchSpecification launchSpecification
The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.
com.amazonaws.internal.SdkInternalList<T> instanceIdSet
The IDs of the newly launched instances.
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 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 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 scheduledInstanceId
The Scheduled Instance ID.
String instanceType
The instance type.
String platform
The platform (Linux/UNIX
or Windows
).
String networkPlatform
The network platform (EC2-Classic
or EC2-VPC
).
String availabilityZone
The Availability Zone.
Integer slotDurationInHours
The number of hours in the schedule.
ScheduledInstanceRecurrence recurrence
The schedule recurrence.
Date previousSlotEndTime
The time that the previous schedule ended or will end.
Date nextSlotStartTime
The time for the next schedule to start.
String hourlyPrice
The hourly price for a single instance.
Integer totalScheduledInstanceHours
The total number of hours for a single instance for the entire term.
Integer instanceCount
The number of instances.
Date termStartDate
The start date for the Scheduled Instance.
Date termEndDate
The end date for the Scheduled Instance.
Date createDate
The date when the Scheduled Instance was purchased.
String instanceType
The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
String platform
The platform (Linux/UNIX
or Windows
).
String networkPlatform
The network platform (EC2-Classic
or EC2-VPC
).
String availabilityZone
The Availability Zone.
String purchaseToken
The purchase token. This token expires in two hours.
Integer slotDurationInHours
The number of hours in the schedule.
ScheduledInstanceRecurrence recurrence
The schedule recurrence.
Date firstSlotStartTime
The time period for the first schedule to start.
String hourlyPrice
The hourly price for a single instance.
Integer totalScheduledInstanceHours
The total number of hours for a single instance for the entire term.
Integer availableInstanceCount
The number of available instances.
Integer minTermDurationInDays
The minimum term. The only possible value is 365 days.
Integer maxTermDurationInDays
The maximum term. The only possible value is 365 days.
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.
com.amazonaws.internal.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.
com.amazonaws.internal.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 exposed to the instance (for example, /dev/sdh
or xvdh
).
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.
ScheduledInstancesEbs ebs
Parameters used to set up EBS volumes automatically when the instance is launched.
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.
Boolean deleteOnTermination
Indicates whether the volume is deleted on instance termination.
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
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.
Boolean encrypted
Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.
String imageId
The ID of the Amazon Machine Image (AMI).
String keyName
The name of the key pair.
com.amazonaws.internal.SdkInternalList<T> securityGroupIds
The IDs of one or more security groups.
String userData
The base64-encoded MIME user data.
ScheduledInstancesPlacement placement
The placement information.
String kernelId
The ID of the kernel.
String instanceType
The instance type.
String ramdiskId
The ID of the RAM disk.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
ScheduledInstancesMonitoring monitoring
Enable or disable monitoring for the instances.
String subnetId
The ID of the subnet in which to launch the instances.
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
One or more network interfaces.
ScheduledInstancesIamInstanceProfile iamInstanceProfile
The IAM instance profile.
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
Boolean enabled
Indicates whether monitoring is enabled.
String networkInterfaceId
The ID of the network interface.
Integer deviceIndex
The index of the device for the network interface attachment.
String subnetId
The ID of the subnet.
String description
The description.
String privateIpAddress
The IP address of the network interface within the subnet.
com.amazonaws.internal.SdkInternalList<T> privateIpAddressConfigs
The private IP addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IP addresses.
Boolean associatePublicIpAddress
Indicates whether to assign a public IP address to instances launched 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
.
com.amazonaws.internal.SdkInternalList<T> groups
The IDs of one or more security groups.
Boolean deleteOnTermination
Indicates whether to delete the interface when the instance is terminated.
String ownerId
The AWS account ID of the owner of the security group.
String groupName
The name of the security group.
String groupId
The ID of the security group.
String description
A description of the security group.
com.amazonaws.internal.SdkInternalList<T> ipPermissions
One or more inbound rules associated with the security group.
com.amazonaws.internal.SdkInternalList<T> ipPermissionsEgress
[EC2-VPC] One or more outbound rules associated with the security group.
String vpcId
[EC2-VPC] The ID of the VPC for the security group.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the security group.
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 snapshotId
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
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.
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.
Date startTime
The time stamp when the snapshot was initiated.
String progress
The progress of the snapshot, as a percentage.
String ownerId
The AWS account ID of the EBS snapshot owner.
String description
The description for the snapshot.
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.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to 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 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.
Double diskImageSize
The size of the disk in the snapshot, in GiB.
String description
A description for the snapshot.
String format
The format of the disk image from which the snapshot is created.
String url
The URL used to access the disk image.
UserBucketDetails userBucket
The S3 bucket for the disk image.
String deviceName
The block device mapping for the snapshot.
String snapshotId
The snapshot ID of the disk being imported.
String progress
The percentage of progress for the task.
String statusMessage
A detailed status message for the snapshot creation.
String status
A brief status of the snapshot creation.
String description
The description of the disk image being imported.
String format
The format of the disk image being imported.
Valid values: RAW
| 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.
Double diskImageSize
The size of the disk in the snapshot, in GiB.
String description
The description of the snapshot.
String format
The format of the disk image from which the snapshot is created.
String url
The URL of the disk image from which the snapshot is created.
UserBucketDetails userBucket
The S3 bucket for the disk image.
String snapshotId
The snapshot ID of the disk being imported.
String progress
The percentage of completion for the import snapshot task.
String statusMessage
A detailed status message for the import snapshot task.
String status
A brief status for the import snapshot task.
String ownerId
The AWS account ID of the account.
String bucket
The Amazon S3 bucket where the Spot instance data feed is located.
String prefix
The prefix that is prepended to data feed files.
String state
The state of the Spot instance data feed subscription.
SpotInstanceStateFault fault
The fault codes for the Spot instance request, if any.
String imageId
The ID of the AMI.
String keyName
The name of the key pair.
com.amazonaws.internal.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 userData
The user data to make available to the instances. 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 addressingType
Deprecated.
String instanceType
The instance type.
SpotPlacement placement
The placement information.
String kernelId
The ID of the kernel.
String ramdiskId
The ID of the RAM disk.
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
SpotFleetMonitoring monitoring
Enable or disable monitoring for the instances.
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".
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
One or more network interfaces.
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
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
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.
String spotPrice
The bid price per unit hour for the specified instance type. If this value is not specified, the default is the
Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by
the value of WeightedCapacity
.
Boolean enabled
Enables monitoring for the instance.
Default: false
String spotFleetRequestId
The ID of the Spot fleet request.
String spotFleetRequestState
The state of the Spot fleet request.
SpotFleetRequestConfigData spotFleetRequestConfig
Information about the configuration of the Spot fleet request.
Date createTime
The creation date and time of the request.
String activityStatus
The progress of the Spot fleet request. If there is an error, the status is error
. After all bids
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.
String clientToken
A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
String spotPrice
The bid price per unit hour.
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.
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 enabled to fulfill the request.
Boolean terminateInstancesWithExpiration
Indicates whether running Spot instances should be terminated when the Spot fleet request expires.
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
.
com.amazonaws.internal.SdkInternalList<T> launchSpecifications
Information about the launch specifications for the Spot fleet request.
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 allocationStrategy
Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The
default is lowestPrice
.
Double fulfilledCapacity
The number of units fulfilled by this request compared to the set target capacity.
String type
The type of request. Indicates whether the fleet will only request
the target capacity or also
attempt to maintain
it. When you request
a certain target capacity, the fleet will only
place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it
submit bids in alternative Spot pools if capacity is not available. When you want to maintain
a
certain target capacity, fleet will place the required bids to meet this target capacity. It will also
automatically replenish any interrupted instances. Default: maintain
.
String spotInstanceRequestId
The ID of the Spot instance request.
String spotPrice
The maximum hourly price (bid) for the Spot instance launched to fulfill the request.
String type
The Spot instance request type.
String state
The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.
SpotInstanceStateFault fault
The fault codes for the Spot instance request, if any.
SpotInstanceStatus status
The status code and status message describing the Spot instance request.
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.
String launchGroup
The instance launch group. Launch groups are Spot instances that launch together and terminate together.
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.
LaunchSpecification launchSpecification
Additional information for launching instances.
String instanceId
The instance ID, if an instance has been launched to fulfill the Spot instance request.
Date createTime
The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String productDescription
The product description associated with the Spot instance.
Integer blockDurationMinutes
The duration for the Spot instance, in minutes.
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.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the resource.
String launchedAvailabilityZone
The Availability Zone in which the bid is launched.
String code
The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.
Date updateTime
The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String message
The description for the status code.
String instanceType
The instance type.
String productDescription
A general description of the AMI.
String spotPrice
The maximum price (bid) 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).
String availabilityZone
The Availability Zone.
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).
com.amazonaws.internal.SdkInternalList<T> ipRanges
One or more IP ranges. Not applicable for stale security group rules.
com.amazonaws.internal.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.
com.amazonaws.internal.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 groupId
The ID of the security group.
String groupName
The name of the security group.
String description
The description of the security group.
String vpcId
The ID of the VPC for the security group.
com.amazonaws.internal.SdkInternalList<T> staleIpPermissions
Information about the stale inbound rules in the security group.
com.amazonaws.internal.SdkInternalList<T> staleIpPermissionsEgress
Information about the stale outbound rules in the security group.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
String additionalInfo
Reserved.
com.amazonaws.internal.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.SpotInstanceTermination
: A Spot instance was terminated due to an increase in the market
price.
Server.InternalError
: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity
: There was insufficient instance capacity to satisfy the launch
request.
Client.InternalError
: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown
: The instance was shut down using the shutdown -h
command from the instance.
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 limits.
Client.InvalidSnapshot.NotFound
: The specified snapshot was not found.
com.amazonaws.internal.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
com.amazonaws.internal.SdkInternalList<T> stoppingInstances
Information about one or more stopped instances.
S3Storage s3
An Amazon S3 storage location.
String subnetId
The ID of the subnet.
String state
The current state of the subnet.
String vpcId
The ID of the VPC the subnet is in.
String cidrBlock
The CIDR block assigned to the subnet.
Integer availableIpAddressCount
The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.
String availabilityZone
The Availability Zone of 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 IP address.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the subnet.
String offeringId
The Convertible Reserved Instance offering ID. If this isn't included in the request, the response lists your current Convertible Reserved Instance/s and their value/s.
Integer instanceCount
The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
TargetConfiguration targetConfiguration
The configuration of the Convertible Reserved Instances that make up the exchange.
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.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
com.amazonaws.internal.SdkInternalList<T> terminatingInstances
Information about one or more terminated instances.
String networkInterfaceId
The ID of the network interface.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> instanceIds
One or more instance IDs.
com.amazonaws.internal.SdkInternalList<T> instanceMonitorings
Monitoring information for one or more instances.
UnsuccessfulItemError error
Information about the error.
String resourceId
The ID of the resource.
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 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.
[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.
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.
String groupId
The ID of the security group.
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.
String peeringStatus
The status of a VPC peering connection, if applicable.
String outsideIpAddress
The Internet-routable IP address of the virtual private gateway's outside interface.
String status
The status of the VPN tunnel.
Date lastStatusChange
The date and time of the last change in status.
String statusMessage
If an error occurs, a description of the error.
Integer acceptedRouteCount
The number of accepted routes.
String volumeId
The ID of the volume.
Integer size
The size of the volume, in GiBs.
String snapshotId
The snapshot from which the volume was created, if applicable.
String availabilityZone
The Availability Zone for the volume.
String state
The volume state.
Date createTime
The time stamp when volume creation was initiated.
com.amazonaws.internal.SdkInternalList<T> attachments
Information about the volume attachments.
com.amazonaws.internal.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.
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 on 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.
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.
String volumeId
The ID of the volume.
String instanceId
The ID of the instance.
String device
The device name.
String state
The attachment state of the volume.
Date attachTime
The time stamp when the attachment initiated.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Long size
The size of the volume, in GiB.
String status
The status of the volume.
com.amazonaws.internal.SdkInternalList<T> details
The details of the volume status.
String volumeId
The volume ID.
String availabilityZone
The Availability Zone of the volume.
VolumeStatusInfo volumeStatus
The volume status.
com.amazonaws.internal.SdkInternalList<T> events
A list of events associated with the volume.
com.amazonaws.internal.SdkInternalList<T> actions
The details of the operation.
String vpcId
The ID of the VPC.
String state
The current state of the VPC.
String cidrBlock
The 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).
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the VPC.
String instanceTenancy
The allowed tenancy of instances launched into the VPC.
Boolean isDefault
Indicates whether the VPC is the default VPC.
String vpcId
The ID of the VPC.
Boolean classicLinkEnabled
Indicates whether the VPC is enabled for ClassicLink.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the VPC.
String vpcEndpointId
The ID of the VPC endpoint.
String vpcId
The ID of the VPC to which the endpoint is associated.
String serviceName
The name of the AWS service to which the endpoint is associated.
String state
The state of the VPC endpoint.
String policyDocument
The policy document associated with the endpoint.
com.amazonaws.internal.SdkInternalList<T> routeTableIds
One or more route tables associated with the endpoint.
Date creationTimestamp
The date and time the VPC endpoint was created.
VpcPeeringConnectionVpcInfo accepterVpcInfo
Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering
connection, or when describing a VPC peering connection that's in the initiating-request
or
pending-acceptance
state.
Date expirationTime
The time that an unaccepted VPC peering connection will expire.
VpcPeeringConnectionVpcInfo requesterVpcInfo
Information about the requester VPC.
VpcPeeringConnectionStateReason status
The status of the VPC peering connection.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the resource.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
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.
Boolean allowDnsResolutionFromRemoteVpc
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
String cidrBlock
The CIDR block for the VPC.
String ownerId
The AWS account ID of the VPC owner.
String vpcId
The ID of the VPC.
VpcPeeringConnectionOptionsDescription peeringOptions
Information about the VPC peering connection options for the accepter or requester VPC.
String vpnConnectionId
The ID of the VPN connection.
String state
The current state of the VPN connection.
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 type
The type of VPN connection.
String customerGatewayId
The ID of the customer gateway at your end of the VPN connection.
String vpnGatewayId
The ID of the virtual private gateway at the AWS side of the VPN connection.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the VPN connection.
com.amazonaws.internal.SdkInternalList<T> vgwTelemetry
Information about the VPN tunnel.
VpnConnectionOptions options
The VPN connection options.
com.amazonaws.internal.SdkInternalList<T> routes
The static routes associated with the VPN connection.
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
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
String vpnGatewayId
The ID of the virtual private gateway.
String state
The current state of the virtual private gateway.
String type
The type of VPN connection the virtual private gateway supports.
String availabilityZone
The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
com.amazonaws.internal.SdkInternalList<T> vpcAttachments
Any VPCs attached to the virtual private gateway.
com.amazonaws.internal.SdkInternalList<T> tags
Any tags assigned to the virtual private gateway.
Copyright © 2016. All rights reserved.