SdkInternalList<T> reservedInstanceIds
The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
SdkInternalList<T> targetConfigurations
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
String exchangeId
The ID of the successful exchange.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String transitGatewayAttachmentId
The ID of the transit gateway attachment.
SdkInternalList<T> subnetIds
The IDs of the subnets to associate with the transit gateway multicast domain.
TransitGatewayMulticastDomainAssociations associations
String transitGatewayAttachmentId
The ID of the transit gateway attachment.
TransitGatewayPeeringAttachment transitGatewayPeeringAttachment
The transit gateway peering attachment.
String transitGatewayAttachmentId
The ID of the attachment.
TransitGatewayVpcAttachment transitGatewayVpcAttachment
The VPC attachment.
String serviceId
The ID of the VPC endpoint service.
SdkInternalList<T> vpcEndpointIds
The IDs of one or more interface VPC endpoints.
SdkInternalList<T> unsuccessful
Information about the interface endpoints that were not accepted, if applicable.
String vpcPeeringConnectionId
The ID of the VPC peering connection. You must specify this parameter in the request.
VpcPeeringConnection vpcPeeringConnection
Information about the VPC peering connection.
String attributeName
The name of the account attribute.
SdkInternalList<T> attributeValues
The values for the account attribute.
String attributeValue
The value of the attribute.
String instanceId
The ID of the instance.
String instanceType
The instance type.
String spotInstanceRequestId
The ID of the Spot Instance request.
String instanceHealth
The health status of the instance. If the status of either the instance status check or the system status check
is impaired
, the health status of the instance is unhealthy
. Otherwise, the health
status is healthy
.
String instanceId
The ID of the instance that the address is associated with (if any).
String publicIp
The Elastic IP address.
String allocationId
The ID representing the allocation of the address for use with EC2-VPC.
String associationId
The ID representing the association of the address with an instance in a VPC.
String domain
Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard
) or
instances in a VPC (vpc
).
String networkInterfaceId
The ID of the network interface.
String networkInterfaceOwnerId
The ID of the AWS account that owns the network interface.
String privateIpAddress
The private IP address associated with the Elastic IP address.
SdkInternalList<T> tags
Any tags assigned to the Elastic IP address.
String publicIpv4Pool
The ID of an address pool.
String networkBorderGroup
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
String customerOwnedIp
The customer-owned IP address.
String customerOwnedIpv4Pool
The ID of the customer-owned address pool.
String carrierIp
The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
String publicIp
The public IP address.
String allocationId
[EC2-VPC] The allocation ID.
String ptrRecord
The pointer (PTR) record for the IP address.
PtrUpdateStatus ptrRecordUpdate
The updated PTR record for the IP address.
String cidr
The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.
ByoipCidr byoipCidr
Information about the address range.
String domain
Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
Default: If the Region supports EC2-Classic, the default is standard
. Otherwise, the default is
vpc
.
String address
[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
String publicIpv4Pool
The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address
pool. To specify a specific address from the address pool, use the Address
parameter instead.
String networkBorderGroup
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will
receive an InvalidParameterCombination
error. For more information, see Error Codes.
String customerOwnedIpv4Pool
The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.
SdkInternalList<T> tagSpecifications
The tags to assign to the Elastic IP address.
String publicIp
The Elastic IP address.
String allocationId
[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
String publicIpv4Pool
The ID of an address pool.
String networkBorderGroup
The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
String domain
Indicates whether the Elastic IP address is for use with instances in a VPC (vpc
) or instances in
EC2-Classic (standard
).
String customerOwnedIp
The customer-owned IP address.
String customerOwnedIpv4Pool
The ID of the customer-owned address pool.
String carrierIp
The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
String autoPlacement
Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
String availabilityZone
The Availability Zone in which to allocate the Dedicated Host.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String instanceType
Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
String instanceFamily
Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
Integer quantity
The number of Dedicated Hosts to allocate to your account with these parameters.
SdkInternalList<T> tagSpecifications
The tags to apply to the Dedicated Host during creation.
String hostRecovery
Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.
Default: off
SdkInternalList<T> hostIds
The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
String cidr
The IPv4 address range, in CIDR notation.
Boolean egress
Indicates whether the rule is an outbound rule.
PortRange portRange
The range of ports.
String protocol
The protocol.
String ruleAction
Indicates whether to allow or deny traffic that matches the rule.
Integer ruleNumber
The rule number.
String address
The IP address.
String availabilityZone
The Availability Zone.
AnalysisComponent instance
Information about the instance.
Integer port
The port on which the target is listening.
SdkInternalList<T> destinationAddresses
The destination addresses.
SdkInternalList<T> destinationPortRanges
The destination port ranges.
String protocol
The protocol.
SdkInternalList<T> sourceAddresses
The source addresses.
SdkInternalList<T> sourcePortRanges
The source port ranges.
String destinationCidr
The destination IPv4 address, in CIDR notation.
String destinationPrefixListId
The prefix of the AWS service.
String egressOnlyInternetGatewayId
The ID of an egress-only internet gateway.
String gatewayId
The ID of the gateway, such as an internet gateway or virtual private gateway.
String instanceId
The ID of the instance, such as a NAT instance.
String natGatewayId
The ID of a NAT gateway.
String networkInterfaceId
The ID of a network interface.
String origin
Describes how the route was created. The following are possible values:
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 transitGatewayId
The ID of a transit gateway.
String vpcPeeringConnectionId
The ID of a VPC peering connection.
String cidr
The IPv4 address range, in CIDR notation.
String direction
The direction. The following are possible values:
egress
ingress
String securityGroupId
The security group ID.
PortRange portRange
The port range.
String prefixListId
The prefix list ID.
String protocol
The protocol name.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
String vpcId
The ID of the VPC in which the associated target network is located.
SdkInternalList<T> securityGroupIds
The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.
SdkInternalList<T> securityGroupIds
The IDs of the applied security groups.
String privateIpAddress
The private IP address assigned to the network interface.
Integer ipv6AddressCount
The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
SdkInternalList<T> ipv6Addresses
One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> assignedIpv6Addresses
The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that were assigned to the network interface before the request are not included.
String networkInterfaceId
The ID of the network interface.
Boolean allowReassignment
Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> privateIpAddresses
One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
Integer secondaryPrivateIpAddressCount
The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> assignedPrivateIpAddresses
The private IP addresses assigned to the network interface.
String allocationId
[EC2-VPC] The allocation ID. This is required for EC2-VPC.
String instanceId
The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.
String publicIp
[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.
Boolean allowReassociation
[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
String networkInterfaceId
[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
String privateIpAddress
[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
String associationId
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
String subnetId
The ID of the subnet to associate with the Client VPN endpoint.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String associationId
The unique ID of the target network association.
AssociationStatus status
The current state of the target network association.
String associatedRoleArn
The ARN of the associated IAM role.
String certificateS3BucketName
The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
String certificateS3ObjectKey
The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is
stored. The object key is formated as follows: role_arn
/certificate_arn
.
String encryptionKmsKeyId
The ID of the KMS customer master key (CMK) used to encrypt the private key.
String certificateS3BucketName
The name of the Amazon S3 bucket to which the certificate was uploaded.
String certificateS3ObjectKey
The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.
The object key is formatted as follows: role_arn
/certificate_arn
.
String encryptionKmsKeyId
The ID of the AWS KMS CMK used to encrypt the private key of the certificate.
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String instanceId
The ID of the instance.
IamInstanceProfileAssociation iamInstanceProfileAssociation
Information about the IAM instance profile association.
String associationId
The route table association ID. This ID is required for disassociating the route table.
RouteTableAssociationState associationState
The state of the association.
SubnetIpv6CidrBlockAssociation ipv6CidrBlockAssociation
Information about the IPv6 CIDR block association.
String subnetId
The ID of the subnet.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String transitGatewayAttachmentId
The ID of the transit gateway attachment to associate with the transit gateway multicast domain.
SdkInternalList<T> subnetIds
The IDs of the subnets to associate with the transit gateway multicast domain.
TransitGatewayMulticastDomainAssociations associations
Information about the transit gateway multicast domain associations.
TransitGatewayAssociation association
The ID of the association.
Boolean amazonProvidedIpv6CidrBlock
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
String cidrBlock
An IPv4 CIDR block to associate with the VPC.
String vpcId
The ID of the VPC.
String ipv6CidrBlockNetworkBorderGroup
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.
You must set AmazonProvidedIpv6CidrBlock
to true
to use this parameter.
You can have one IPv6 CIDR block association per network border group.
String ipv6Pool
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
String ipv6CidrBlock
An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool
in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
VpcIpv6CidrBlockAssociation ipv6CidrBlockAssociation
Information about the IPv6 CIDR block association.
VpcCidrBlockAssociation cidrBlockAssociation
Information about the IPv4 CIDR block association.
String vpcId
The ID of the VPC.
SdkInternalList<T> groups
The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
String instanceId
The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
String vpcId
The ID of a ClassicLink-enabled VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
Integer deviceIndex
The index of the device for the network interface attachment.
String instanceId
The ID of the instance.
String networkInterfaceId
The ID of the network interface.
Integer networkCardIndex
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
VolumeAttachment attachment
Describes volume attachment details.
VpcAttachment vpcAttachment
Information about the attachment.
String clientVpnEndpointId
The ID of the Client VPN endpoint with which the authorization rule is associated.
String description
A brief description of the authorization rule.
String groupId
The ID of the Active Directory group to which the authorization rule grants access.
Boolean accessAll
Indicates whether the authorization rule grants access to all clients.
String destinationCidr
The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
ClientVpnAuthorizationRuleStatus status
The current state of the authorization rule.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
String targetNetworkCidr
The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
String accessGroupId
The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
Required if AuthorizeAllGroups
is false
or not specified.
Boolean authorizeAllGroups
Indicates whether to grant access to all clients. Specify true
to grant all clients who successfully
establish a VPN connection access to the network. Must be set to true
if AccessGroupId
is not specified.
String description
A brief description of the authorization rule.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
ClientVpnAuthorizationRuleStatus status
The current state of the authorization rule.
String groupId
The ID of the security group.
SdkInternalList<T> ipPermissions
The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
String cidrIp
Not supported. Use a set of IP permissions to specify the CIDR.
Integer fromPort
Not supported. Use a set of IP permissions to specify the port.
String ipProtocol
Not supported. Use a set of IP permissions to specify the protocol name or number.
Integer toPort
Not supported. Use a set of IP permissions to specify the port.
String sourceSecurityGroupName
Not supported. Use a set of IP permissions to specify a destination security group.
String sourceSecurityGroupOwnerId
Not supported. Use a set of IP permissions to specify a destination security group.
String cidrIp
The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
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 types. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
String groupId
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
String groupName
[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
SdkInternalList<T> ipPermissions
The sets of IP permissions.
String ipProtocol
The IP protocol name (tcp
, udp
, icmp
) or number (see Protocol Numbers). To specify
icmpv6
, use a set of IP permissions.
[VPC only] Use -1
to specify all protocols. If you specify -1
or a protocol other than
tcp
, udp
, or icmp
, traffic on all ports is allowed, regardless of any
ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
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
[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use
-1
to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
String state
The state of the Availability Zone, Local Zone, or Wavelength Zone.
String optInStatus
For Availability Zones, this parameter always has the value of opt-in-not-required
.
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are
opted-in
, and not-opted-in
.
SdkInternalList<T> messages
Any messages about the Availability Zone, Local Zone, or Wavelength Zone.
String regionName
The name of the Region.
String zoneName
The name of the Availability Zone, Local Zone, or Wavelength Zone.
String zoneId
The ID of the Availability Zone, Local Zone, or Wavelength Zone.
String groupName
For Availability Zones, this parameter has the same value as the Region name.
For Local Zones, the name of the associated group, for example us-west-2-lax-1
.
For Wavelength Zones, the name of the associated group, for example us-east-1-wl1-bos-wlz-1
.
String networkBorderGroup
The name of the network border group.
String zoneType
The type of zone. The valid values are availability-zone
, local-zone
, and
wavelength-zone
.
String parentZoneName
The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
String parentZoneId
The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
String message
The message about the Availability Zone, Local Zone, or Wavelength Zone.
SdkInternalList<T> availableInstanceCapacity
The number of instances that can be launched onto the Dedicated Host depending on the host's available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.
Integer availableVCpus
The number of vCPUs available for launching instances onto the Dedicated Host.
String deviceName
The device name (for example, /dev/sdh
or xvdh
).
String virtualName
The virtual device name (ephemeral
N). Instance store volumes are numbered starting from 0. An
instance type with 2 available instance store volumes can specify mappings for ephemeral0
and
ephemeral1
. The number of available instance store volumes depends on the instance type. After you
connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
EbsBlockDevice ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String noDevice
To omit the device from the block device mapping, specify an empty string.
String instanceId
The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
Storage storage
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
BundleTask bundleTask
Information about the bundle task.
String bundleId
The ID of the bundle task.
BundleTaskError bundleTaskError
If the task fails, a description of the error.
String instanceId
The ID of the instance associated with this bundle task.
String progress
The level of task completion, as a percent (for example, 20%).
Date startTime
The time this task started.
String state
The state of the task.
Storage storage
The Amazon S3 storage locations.
Date updateTime
The time of the most recent update for the task.
String bundleId
The ID of the bundle task.
BundleTask bundleTask
Information about the bundle task.
String capacityReservationId
The ID of the Capacity Reservation to be cancelled.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String exportTaskId
The ID of the export task. This is the ID returned by CreateInstanceExportTask
.
String reservedInstancesListingId
The ID of the Reserved Instance listing.
SdkInternalList<T> reservedInstancesListings
The Reserved Instance listing.
CancelSpotFleetRequestsError error
The error.
String spotFleetRequestId
The ID of the Spot Fleet request.
SdkInternalList<T> spotFleetRequestIds
The IDs of the Spot Fleet requests.
Boolean terminateInstances
Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
SdkInternalList<T> successfulFleetRequests
Information about the Spot Fleet requests that are successfully canceled.
SdkInternalList<T> unsuccessfulFleetRequests
Information about the Spot Fleet requests that are not successfully canceled.
String currentSpotFleetRequestState
The current state of the Spot Fleet request.
String previousSpotFleetRequestState
The previous state of the Spot Fleet request.
String spotFleetRequestId
The ID of the Spot Fleet request.
SdkInternalList<T> spotInstanceRequestIds
One or more Spot Instance request IDs.
SdkInternalList<T> cancelledSpotInstanceRequests
One or more Spot Instance requests.
String capacityReservationId
The ID of the Capacity Reservation.
String ownerId
The ID of the AWS account that owns the Capacity Reservation.
String capacityReservationArn
The Amazon Resource Name (ARN) of the Capacity Reservation.
String availabilityZoneId
The Availability Zone ID of the Capacity Reservation.
String instanceType
The type of instance for which the Capacity Reservation reserves capacity.
String instancePlatform
The type of operating system for which the Capacity Reservation reserves capacity.
String availabilityZone
The Availability Zone in which the capacity is reserved.
String tenancy
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default
- The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated
- The Capacity Reservation is created on single-tenant hardware that is dedicated to a
single AWS account.
Integer totalInstanceCount
The total number of instances for which the Capacity Reservation reserves capacity.
Integer availableInstanceCount
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
Boolean ebsOptimized
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
Boolean ephemeralStorage
Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
String state
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active
- The Capacity Reservation is active and the capacity is available for your use.
expired
- The Capacity Reservation expired automatically at the date and time specified in your
request. The reserved capacity is no longer available for your use.
cancelled
- The Capacity Reservation was cancelled. The reserved capacity is no longer available for
your use.
pending
- The Capacity Reservation request was successful but the capacity provisioning is still
pending.
failed
- The Capacity Reservation request has failed. A request might fail due to invalid request
parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
Date startDate
The date and time at which the Capacity Reservation was started.
Date endDate
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
expired
when it reaches its end date and time.
String endDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited
- The Capacity Reservation remains active until you explicitly cancel it.
limited
- The Capacity Reservation expires automatically at a specified date and time.
String instanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open
- The Capacity Reservation accepts all instances that have matching attributes (instance type,
platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation
automatically without specifying any additional parameters.
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance
type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only
permitted instances can use the reserved capacity.
Date createDate
The date and time at which the Capacity Reservation was created.
SdkInternalList<T> tags
Any tags assigned to the Capacity Reservation.
String usageStrategy
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first
, the fleet uses unused Capacity Reservations to
fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity
Reservations, the On-Demand allocation strategy (lowest-price
or prioritized
) is
applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining
On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price
or prioritized
).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
String usageStrategy
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first
, the fleet uses unused Capacity Reservations to
fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity
Reservations, the On-Demand allocation strategy (lowest-price
or prioritized
) is
applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining
On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price
or prioritized
).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
String capacityReservationPreference
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open
Capacity Reservation that has matching
attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs as an On-Demand Instance.
CapacityReservationTarget capacityReservationTarget
Information about the target Capacity Reservation or Capacity Reservation group.
String capacityReservationPreference
Describes the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open
Capacity Reservation that has matching
attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs in On-Demand capacity.
CapacityReservationTargetResponse capacityReservationTarget
Information about the targeted Capacity Reservation or Capacity Reservation group.
String carrierGatewayId
The ID of the carrier gateway.
String vpcId
The ID of the VPC associated with the carrier gateway.
String state
The state of the carrier gateway.
String ownerId
The AWS account ID of the owner of the carrier gateway.
SdkInternalList<T> tags
The tags assigned to the carrier gateway.
String clientRootCertificateChain
The ARN of the client certificate.
String clientRootCertificateChainArn
The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).
String cidrBlock
The IPv4 CIDR block.
SdkInternalList<T> groups
A list of security groups.
String instanceId
The ID of the instance.
SdkInternalList<T> tags
Any tags assigned to the instance.
String vpcId
The ID of the VPC.
String name
The name of the load balancer.
SdkInternalList<T> classicLoadBalancers
One or more Classic Load Balancers.
Boolean enabled
Indicates whether client connect options are enabled.
String lambdaFunctionArn
The Amazon Resource Name (ARN) of the AWS Lambda function used for connection authorization.
ClientVpnEndpointAttributeStatus status
The status of any updates to the client connect options.
String type
The authentication type used.
DirectoryServiceAuthentication activeDirectory
Information about the Active Directory, if applicable.
CertificateAuthentication mutualAuthentication
Information about the authentication certificates, if applicable.
FederatedAuthentication federatedAuthentication
Information about the IAM SAML identity provider, if applicable.
String type
The type of client authentication to be used.
DirectoryServiceAuthenticationRequest activeDirectory
Information about the Active Directory to be used, if applicable. You must provide this information if
Type is directory-service-authentication
.
CertificateAuthenticationRequest mutualAuthentication
Information about the authentication certificates to be used, if applicable. You must provide this information if
Type is certificate-authentication
.
FederatedAuthenticationRequest federatedAuthentication
Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if
Type is federated-authentication
.
String clientVpnEndpointId
The ID of the Client VPN endpoint to which the client is connected.
String timestamp
The current date and time.
String connectionId
The ID of the client connection.
String username
The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.
String connectionEstablishedTime
The date and time the client connection was established.
String ingressBytes
The number of bytes sent by the client.
String egressBytes
The number of bytes received by the client.
String ingressPackets
The number of packets sent by the client.
String egressPackets
The number of packets received by the client.
String clientIp
The IP address of the client.
String commonName
The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.
ClientVpnConnectionStatus status
The current state of the client connection.
String connectionEndTime
The date and time the client connection was terminated.
SdkInternalList<T> postureComplianceStatuses
The statuses returned by the client connect handler for posture compliance, if applicable.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
String description
A brief description of the endpoint.
ClientVpnEndpointStatus status
The current state of the Client VPN endpoint.
String creationTime
The date and time the Client VPN endpoint was created.
String deletionTime
The date and time the Client VPN endpoint was deleted, if applicable.
String dnsName
The DNS name to be used by clients when connecting to the Client VPN endpoint.
String clientCidrBlock
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
SdkInternalList<T> dnsServers
Information about the DNS servers to be used for DNS resolution.
Boolean splitTunnel
Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.
String vpnProtocol
The protocol used by the VPN session.
String transportProtocol
The transport protocol used by the Client VPN endpoint.
Integer vpnPort
The port number for the Client VPN endpoint.
SdkInternalList<T> associatedTargetNetworks
Information about the associated target networks. A target network is a subnet in a VPC.
String serverCertificateArn
The ARN of the server certificate.
SdkInternalList<T> authenticationOptions
Information about the authentication method used by the Client VPN endpoint.
ConnectionLogResponseOptions connectionLogOptions
Information about the client connection logging options for the Client VPN endpoint.
SdkInternalList<T> tags
Any tags assigned to the Client VPN endpoint.
SdkInternalList<T> securityGroupIds
The IDs of the security groups for the target network.
String vpcId
The ID of the VPC.
String selfServicePortalUrl
The URL of the self-service portal.
ClientConnectResponseOptions clientConnectOptions
The options for managing connection authorization for new client connections.
String code
The state of the Client VPN endpoint. Possible states include:
pending-associate
- The Client VPN endpoint has been created but no target networks have been
associated. The Client VPN endpoint cannot accept connections.
available
- The Client VPN endpoint has been created and a target network has been associated. The
Client VPN endpoint can accept connections.
deleting
- The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept
connections.
deleted
- The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept
connections.
String message
A message about the status of the Client VPN endpoint.
String clientVpnEndpointId
The ID of the Client VPN endpoint with which the route is associated.
String destinationCidr
The IPv4 address range, in CIDR notation, of the route destination.
String targetSubnet
The ID of the subnet through which traffic is routed.
String type
The route type.
String origin
Indicates how the route was associated with the Client VPN endpoint. associate
indicates that the
route was automatically added when the target network was associated with the Client VPN endpoint.
add-route
indicates that the route was manually added using the CreateClientVpnRoute action.
ClientVpnRouteStatus status
The current state of the route.
String description
A brief description of the route.
String poolId
The ID of the address pool.
SdkInternalList<T> poolCidrs
The address ranges of the address pool.
String localGatewayRouteTableId
The ID of the local gateway route table.
SdkInternalList<T> tags
The tags.
String poolArn
The ARN of the address pool.
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.
Boolean enabled
Indicates whether connection logging is enabled.
String cloudwatchLogGroup
The name of the CloudWatch Logs log group. Required if connection logging is enabled.
String cloudwatchLogStream
The name of the CloudWatch Logs log stream to which the connection data is published.
Boolean enabled
Indicates whether client connection logging is enabled for the Client VPN endpoint.
String cloudwatchLogGroup
The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
String cloudwatchLogStream
The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
String connectionNotificationId
The ID of the notification.
String serviceId
The ID of the endpoint service.
String vpcEndpointId
The ID of the VPC endpoint.
String connectionNotificationType
The type of notification.
String connectionNotificationArn
The ARN of the SNS topic for the notification.
SdkInternalList<T> connectionEvents
The events for the notification. Valid values are Accept
, Connect
, Delete
,
and Reject
.
String connectionNotificationState
The state of the notification.
String conversionTaskId
The ID of the conversion task.
String expirationTime
The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
ImportInstanceTaskDetails importInstance
If the task is for importing an instance, this contains information about the import instance task.
ImportVolumeTaskDetails importVolume
If the task is for importing a volume, this contains information about the import volume task.
String state
The state of the conversion task.
String statusMessage
The status message related to the conversion task.
SdkInternalList<T> tags
Any tags assigned to the task.
String sourceFpgaImageId
The ID of the source AFI.
String description
The description for the new AFI.
String name
The name for the new AFI. The default is the name of the source AFI.
String sourceRegion
The Region that contains the source AFI.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String fpgaImageId
The ID of the new AFI.
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
String description
A description for the new AMI in the destination Region.
Boolean encrypted
Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an
unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS
is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId
.
For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
String kmsKeyId
The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you
specify a CMK, you must also set the encrypted state to true
.
You can specify a CMK using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified CMK must exist in the destination Region.
Amazon EBS does not support asymmetric CMKs.
String name
The name of the new AMI in the destination Region.
String sourceImageId
The ID of the AMI to copy.
String sourceRegion
The name of the Region that contains the AMI to copy.
String destinationOutpostArn
The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an AWS Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
String imageId
The ID of the new AMI.
String description
A description for the EBS snapshot.
String destinationOutpostArn
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an AWS Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying snapshots from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
String destinationRegion
The destination Region to use in the PresignedUrl
parameter of a snapshot copy operation. This
parameter is only valid for specifying the destination Region in a PresignedUrl
parameter, where it
is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com
). With the AWS CLI, this is specified using the --region
parameter or the default Region in your AWS configuration file.
Boolean encrypted
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
String kmsKeyId
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId
is
specified, the encrypted state must be true
.
You can specify the CMK using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
String presignedUrl
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl
should use the snapshot source endpoint, the CopySnapshot
action, and
include the SourceRegion
, SourceSnapshotId
, and DestinationRegion
parameters. The PresignedUrl
must be signed using AWS Signature Version 4. Because EBS snapshots are
stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests:
Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference.
An invalid or improperly signed PresignedUrl
will cause the copy operation to fail asynchronously,
and the snapshot will move to an error
state.
String sourceRegion
The ID of the Region that contains the snapshot to be copied.
String sourceSnapshotId
The ID of the EBS snapshot to copy.
SdkInternalList<T> tagSpecifications
The tags to apply to the new snapshot.
String snapshotId
The ID of the new snapshot.
SdkInternalList<T> tags
Any tags applied to the new snapshot.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
String instanceType
The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.
String instancePlatform
The type of operating system for which to reserve capacity.
String availabilityZone
The Availability Zone in which to create the Capacity Reservation.
String availabilityZoneId
The ID of the Availability Zone in which to create the Capacity Reservation.
String tenancy
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default
- The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated
- The Capacity Reservation is created on single-tenant hardware that is dedicated to a
single AWS account.
Integer instanceCount
The number of instances for which to reserve capacity.
Boolean ebsOptimized
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
Boolean ephemeralStorage
Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
Date endDate
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
expired
when it reaches its end date and time.
You must provide an EndDate
value if EndDateType
is limited
. Omit
EndDate
if EndDateType
is unlimited
.
If the EndDateType
is limited
, the Capacity Reservation is cancelled within an hour
from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed
to end between 13:30:55 and 14:30:55 on 5/31/2019.
String endDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide
an EndDate
if the EndDateType
is unlimited
.
limited
- The Capacity Reservation expires automatically at a specified date and time. You must
provide an EndDate
value if the EndDateType
value is limited
.
String instanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open
- The Capacity Reservation automatically matches all instances that have matching attributes
(instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity
Reservation automatically without specifying any additional parameters.
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance
type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only
permitted instances can use the reserved capacity.
Default: open
SdkInternalList<T> tagSpecifications
The tags to apply to the Capacity Reservation during launch.
CapacityReservation capacityReservation
Information about the Capacity Reservation.
String vpcId
The ID of the VPC to associate with the carrier gateway.
SdkInternalList<T> tagSpecifications
The tags to associate with the carrier gateway.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
CarrierGateway carrierGateway
Information about the carrier gateway.
String clientCidrBlock
The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.
String serverCertificateArn
The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.
SdkInternalList<T> authenticationOptions
Information about the authentication method to be used to authenticate clients.
ConnectionLogOptions connectionLogOptions
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
SdkInternalList<T> dnsServers
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
String transportProtocol
The transport protocol to be used by the VPN session.
Default value: udp
Integer vpnPort
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443
| 1194
Default Value: 443
String description
A brief description of the Client VPN endpoint.
Boolean splitTunnel
Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
SdkInternalList<T> tagSpecifications
The tags to apply to the Client VPN endpoint during creation.
SdkInternalList<T> securityGroupIds
The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
String vpcId
The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
String selfServicePortal
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
ClientConnectOptions clientConnectOptions
The options for managing connection authorization for new client connections.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
ClientVpnEndpointStatus status
The current state of the Client VPN endpoint.
String dnsName
The DNS name to be used by clients when establishing their VPN session.
String clientVpnEndpointId
The ID of the Client VPN endpoint to which to add the route.
String destinationCidrBlock
The IPv4 address range, in CIDR notation, of the route destination. For example:
To add a route for Internet access, enter 0.0.0.0/0
To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
To add a route for the local network, enter the client CIDR range
String targetVpcSubnetId
The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you're adding a route for the local network, specify local
.
String description
A brief description of the route.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
ClientVpnRouteStatus status
The current state of the route.
Integer bgpAsn
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
String publicIp
The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
String certificateArn
The Amazon Resource Name (ARN) for the customer gateway certificate.
String type
The type of VPN connection that this customer gateway supports (ipsec.1
).
SdkInternalList<T> tagSpecifications
The tags to apply to the customer gateway.
String deviceName
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
CustomerGateway customerGateway
Information about the customer gateway.
String availabilityZone
The Availability Zone in which to create the default subnet.
Subnet subnet
Information about the subnet.
Vpc vpc
Information about the VPC.
SdkInternalList<T> dhcpConfigurations
A DHCP configuration option.
SdkInternalList<T> tagSpecifications
The tags to assign to the DHCP option.
DhcpOptions dhcpOptions
A set of DHCP options.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String vpcId
The ID of the VPC for which to create the egress-only internet gateway.
SdkInternalList<T> tagSpecifications
The tags to assign to the egress-only internet gateway.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
EgressOnlyInternetGateway egressOnlyInternetGateway
Information about the egress-only internet gateway.
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
String lifecycle
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
String errorCode
The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.
String errorMessage
The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes.
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
String lifecycle
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
SdkInternalList<T> instanceIds
The IDs of the instances.
String instanceType
The instance type.
String platform
The value is Windows
for Windows instances. Otherwise, the value is blank.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
SpotOptionsRequest spotOptions
Describes the configuration of Spot Instances in an EC2 Fleet.
OnDemandOptionsRequest onDemandOptions
Describes the configuration of On-Demand Instances in an EC2 Fleet.
String excessCapacityTerminationPolicy
Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
SdkInternalList<T> launchTemplateConfigs
The configuration for the EC2 Fleet.
TargetCapacitySpecificationRequest targetCapacitySpecification
The number of units to request.
Boolean terminateInstancesWithExpiration
Indicates whether running instances should be terminated when the EC2 Fleet expires.
String type
The type of request. The default value is maintain
.
maintain
- The EC2 Fleet places an asynchronous request for your desired capacity, and continues to
maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request
- The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does
submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot
capacity if Spot Instances are interrupted.
instant
- The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns
errors for any instances that could not be launched.
For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.
Date validFrom
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
Date validUntil
The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
Boolean replaceUnhealthyInstances
Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type
maintain
. For more information, see EC2
Fleet health checks in the Amazon EC2 User Guide.
SdkInternalList<T> tagSpecifications
The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType
must be
fleet
, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch
template. For information about tagging after launch, see Tagging your
resources.
String fleetId
The ID of the EC2 Fleet.
SdkInternalList<T> errors
Information about the instances that could not be launched by the fleet. Valid only when Type is set to
instant
.
SdkInternalList<T> instances
Information about the instances that were launched by the fleet. Valid only when Type is set to
instant
.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String deliverLogsPermissionArn
The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
If you specify LogDestinationType
as s3
, do not specify
DeliverLogsPermissionArn
or LogGroupName
.
String logGroupName
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify LogDestinationType
as s3
, do not specify
DeliverLogsPermissionArn
or LogGroupName
.
SdkInternalList<T> resourceIds
The ID of the subnet, network interface, or VPC for which you want to create a flow log.
Constraints: Maximum of 1000 resources
String resourceType
The type of resource for which to create the flow log. For example, if you specified a VPC ID for the
ResourceId
property, specify VPC
for this property.
String trafficType
The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
String logDestinationType
Specifies the type of destination to which the flow log data is to be published. Flow log data can be published
to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify
cloud-watch-logs
. To publish flow log data to Amazon S3, specify s3
.
If you specify LogDestinationType
as s3
, do not specify
DeliverLogsPermissionArn
or LogGroupName
.
Default: cloud-watch-logs
String logDestination
Specifies the destination to which the flow log data is to be published. Flow log data can be published to a
CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value
specified for LogDestinationType
.
If LogDestinationType
is not specified or cloud-watch-logs
, specify the Amazon Resource
Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs
,
specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs
. Alternatively, use
LogGroupName
instead.
If LogDestinationType is s3
, specify the ARN of the Amazon S3 bucket. You can also specify a
subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format:
bucket_ARN/subfolder_name/
. For example, to specify a subfolder named my-logs
in a
bucket named my-bucket
, use the following ARN: arn:aws:s3:::my-bucket/my-logs/
. You
cannot use AWSLogs
as a subfolder name. This is a reserved term.
String logFormat
The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.
Specify the fields using the ${field-id}
format, separated by spaces. For the AWS CLI, use single
quotation marks (' ') to surround the parameter value.
SdkInternalList<T> tagSpecifications
The tags to apply to the flow logs.
Integer maxAggregationInterval
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
SdkInternalList<T> flowLogIds
The IDs of the flow logs.
SdkInternalList<T> unsuccessful
Information about the flow logs that could not be created successfully.
StorageLocation inputStorageLocation
The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
StorageLocation logsStorageLocation
The location in Amazon S3 for the output logs.
String description
A description for the AFI.
String name
A name for the AFI.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
SdkInternalList<T> tagSpecifications
The tags to apply to the FPGA image during creation.
SdkInternalList<T> blockDeviceMappings
The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
String description
A description for the new image.
String instanceId
The ID of the instance.
String name
A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
Boolean noReboot
By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the
No Reboot
option is set, Amazon EC2 doesn't shut down the instance before creating the image. When
this option is used, file system integrity on the created image can't be guaranteed.
SdkInternalList<T> tagSpecifications
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType
must be image
.
To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the
instance, the value for ResourceType
must be snapshot
. The same tag is applied to all
of the snapshots that are created.
If you specify other values for ResourceType
, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
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 characters.
ExportToS3TaskSpecification exportToS3Task
The format and location for an export instance task.
String instanceId
The ID of the instance.
String targetEnvironment
The target virtualization environment.
SdkInternalList<T> tagSpecifications
The tags to apply to the export instance task during creation.
ExportTask exportTask
Information about the export instance task.
SdkInternalList<T> tagSpecifications
The tags to assign to the internet gateway.
InternetGateway internetGateway
Information about the internet gateway.
String keyName
A unique name for the key pair.
Constraints: Up to 255 ASCII characters
SdkInternalList<T> tagSpecifications
The tags to apply to the new key pair.
KeyPair keyPair
Describes a key pair.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
String launchTemplateName
A name for the launch template.
String versionDescription
A description for the first version of the launch template.
RequestLaunchTemplateData launchTemplateData
The information for the launch template.
SdkInternalList<T> tagSpecifications
The tags to apply to the launch template during creation.
LaunchTemplate launchTemplate
Information about the launch template.
ValidationWarning warning
If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
String sourceVersion
The version number of the launch template version on which to base the new version. The new version inherits the
same launch parameters as the source version, except for parameters that you specify in
LaunchTemplateData
. Snapshots applied to the block device mapping are ignored when creating a new
version unless they are explicitly included.
String versionDescription
A description for the version of the launch template.
RequestLaunchTemplateData launchTemplateData
The information for the launch template.
LaunchTemplateVersion launchTemplateVersion
Information about the launch template version.
ValidationWarning warning
If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
String destinationCidrBlock
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
String localGatewayRouteTableId
The ID of the local gateway route table.
String localGatewayVirtualInterfaceGroupId
The ID of the virtual interface group.
LocalGatewayRoute route
Information about the route.
String localGatewayRouteTableId
The ID of the local gateway route table.
String vpcId
The ID of the VPC.
SdkInternalList<T> tagSpecifications
The tags to assign to the local gateway route table VPC association.
LocalGatewayRouteTableVpcAssociation localGatewayRouteTableVpcAssociation
Information about the association.
String prefixListName
A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws
.
SdkInternalList<T> entries
One or more entries for the prefix list.
Integer maxEntries
The maximum number of entries for the prefix list.
SdkInternalList<T> tagSpecifications
The tags to apply to the prefix list during creation.
String addressFamily
The IP address type.
Valid Values: IPv4
| IPv6
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Up to 255 UTF-8 characters in length.
ManagedPrefixList prefixList
Information about the prefix list.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
Constraint: Maximum 64 ASCII characters.
String subnetId
The subnet in which to create the NAT gateway.
SdkInternalList<T> tagSpecifications
The tags to assign to 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 to ensure the idempotency of the request. Only returned if a client token was provided in the request.
NatGateway natGateway
Information about the NAT gateway.
String cidrBlock
The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24
). We modify the
specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18
, we modify it
to 100.68.0.0/18
.
Boolean egress
Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
String ipv6CidrBlock
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64
).
String networkAclId
The ID of the network ACL.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
String protocol
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Integer ruleNumber
The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
String vpcId
The ID of the VPC.
SdkInternalList<T> tagSpecifications
The tags to assign to the network ACL.
NetworkAcl networkAcl
Information about the network ACL.
String sourceIp
The IP address of the AWS resource that is the source of the path.
String destinationIp
The IP address of the AWS resource that is the destination of the path.
String source
The AWS resource that is the source of the path.
String destination
The AWS resource that is the destination of the path.
String protocol
The protocol.
Integer destinationPort
The destination port.
SdkInternalList<T> tagSpecifications
The tags to add to the path.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
NetworkInsightsPath networkInsightsPath
Information about the path.
NetworkInterfacePermission interfacePermission
Information about the permission for the network interface.
String description
A description for the network interface.
SdkInternalList<T> groups
The IDs of one or more security groups.
Integer ipv6AddressCount
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6
addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet
has the AssignIpv6AddressOnCreation
attribute set to true
, you can specify
0
to override this setting.
SdkInternalList<T> ipv6Addresses
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
String privateIpAddress
The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2
selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP
addresses specified in privateIpAddresses
as primary (only one IP address can be designated as
primary).
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of
secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't
specify this option and specify more than one private IP address using privateIpAddresses
.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
String interfaceType
Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa
. For
more information, see Elastic Fabric
Adapter in the Amazon Elastic Compute Cloud User Guide.
String subnetId
The ID of the subnet to associate with the network interface.
SdkInternalList<T> tagSpecifications
The tags to apply to the new network interface.
NetworkInterface networkInterface
Information about the network interface.
String groupName
A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
String strategy
The placement strategy.
Integer partitionCount
The number of partitions. Valid only when Strategy is set to partition
.
SdkInternalList<T> tagSpecifications
The tags to apply to the new placement group.
PlacementGroup placementGroup
String clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
Integer instanceCount
The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
SdkInternalList<T> priceSchedules
A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
String reservedInstancesId
The ID of the active Standard Reserved Instance.
SdkInternalList<T> reservedInstancesListings
Information about the Standard Reserved Instance listing.
String destinationCidrBlock
The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific
match. We modify the specified CIDR block to its canonical form; for example, if you specify
100.68.0.18/18
, we modify it to 100.68.0.0/18
.
String destinationIpv6CidrBlock
The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
String destinationPrefixListId
The ID of a prefix list used for the destination match.
String vpcEndpointId
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
String egressOnlyInternetGatewayId
[IPv6 traffic only] The ID of an egress-only internet gateway.
String gatewayId
The ID of an internet gateway or virtual private gateway attached to your VPC.
String instanceId
The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
String natGatewayId
[IPv4 traffic only] The ID of a NAT gateway.
String transitGatewayId
The ID of a transit gateway.
String localGatewayId
The ID of the local gateway.
String carrierGatewayId
The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
String networkInterfaceId
The ID of a network interface.
String routeTableId
The ID of the route table for the route.
String vpcPeeringConnectionId
The ID of a VPC peering connection.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcId
The ID of the VPC.
SdkInternalList<T> tagSpecifications
The tags to assign to the route table.
RouteTable routeTable
Information about the route table.
String description
A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String groupName
The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg-
.
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String vpcId
[EC2-VPC] The ID of the VPC. Required for EC2-VPC.
SdkInternalList<T> tagSpecifications
The tags to assign to the security group.
String groupId
The ID of the security group.
SdkInternalList<T> tags
The tags assigned to the security group.
String description
A description for the snapshot.
String outpostArn
The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.
To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.
To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.
To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.
For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.
String volumeId
The ID of the EBS volume.
SdkInternalList<T> tagSpecifications
The tags to apply to the snapshot during creation.
Snapshot snapshot
Describes a snapshot.
String description
A description propagated to every snapshot specified by the instance.
InstanceSpecification instanceSpecification
The instance to specify which volumes should be included in the snapshots.
String outpostArn
The Amazon Resource Name (ARN) of the AWS Outpost on which to create the local snapshots.
To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.
For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.
SdkInternalList<T> tagSpecifications
Tags to apply to every snapshot specified by the instance.
String copyTagsFromSource
Copies the tags from the specified volume to corresponding snapshot.
SdkInternalList<T> snapshots
List of snapshots.
String bucket
The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.
String prefix
The prefix for the data feed file names.
SpotDatafeedSubscription spotDatafeedSubscription
The Spot Instance data feed subscription.
SdkInternalList<T> tagSpecifications
The tags to assign to the subnet.
String availabilityZone
The Availability Zone or Local Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example
us-west-2-lax-1a
. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
String availabilityZoneId
The AZ ID or the Local Zone ID of the subnet.
String ipv6CidrBlock
The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.
String vpcId
The ID of the VPC.
String cidrBlock
The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24
. We modify the
specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18
, we modify it
to 100.68.0.0/18
.
Subnet subnet
Information about the subnet.
SdkInternalList<T> resources
The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
SdkInternalList<T> tags
The tags. The value
parameter is required, but if you don't want the tag to have a value, specify
the parameter with no value, and we set the value to an empty string.
String description
The description of the Traffic Mirror filter.
SdkInternalList<T> tagSpecifications
The tags to assign to a Traffic Mirror filter.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
TrafficMirrorFilter trafficMirrorFilter
Information about the Traffic Mirror filter.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String trafficMirrorFilterId
The ID of the filter that this rule is associated with.
String trafficDirection
The type of traffic (ingress
| egress
).
Integer ruleNumber
The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
String ruleAction
The action to take (accept
| reject
) on the filtered traffic.
TrafficMirrorPortRangeRequest destinationPortRange
The destination port range.
TrafficMirrorPortRangeRequest sourcePortRange
The source port range.
Integer protocol
The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
String destinationCidrBlock
The destination CIDR block to assign to the Traffic Mirror rule.
String sourceCidrBlock
The source CIDR block to assign to the Traffic Mirror rule.
String description
The description of the Traffic Mirror rule.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
TrafficMirrorFilterRule trafficMirrorFilterRule
The Traffic Mirror rule.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String networkInterfaceId
The ID of the source network interface.
String trafficMirrorTargetId
The ID of the Traffic Mirror target.
String trafficMirrorFilterId
The ID of the Traffic Mirror filter.
Integer packetLength
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength
parameter to specify the number
of bytes in each packet to mirror.
Integer sessionNumber
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
Integer virtualNetworkId
The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId
,
an account-wide unique id is chosen at random.
String description
The description of the Traffic Mirror session.
SdkInternalList<T> tagSpecifications
The tags to assign to a Traffic Mirror session.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
TrafficMirrorSession trafficMirrorSession
Information about the Traffic Mirror session.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String networkInterfaceId
The network interface ID that is associated with the target.
String networkLoadBalancerArn
The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
String description
The description of the Traffic Mirror target.
SdkInternalList<T> tagSpecifications
The tags to assign to the Traffic Mirror target.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
TrafficMirrorTarget trafficMirrorTarget
Information about the Traffic Mirror target.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
String transitGatewayAttachmentId
The ID of the Connect attachment.
String transitGatewayAddress
The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
String peerAddress
The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
TransitGatewayConnectRequestBgpOptions bgpOptions
The BGP options for the Connect peer.
SdkInternalList<T> insideCidrBlocks
The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from
the 169.254.0.0/16
range. The first address from the range must be configured on the appliance as
the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8
range.
SdkInternalList<T> tagSpecifications
The tags to apply to the Connect peer.
TransitGatewayConnectPeer transitGatewayConnectPeer
Information about the Connect peer.
String transportTransitGatewayAttachmentId
The ID of the transit gateway attachment. You can specify a VPC attachment or a AWS Direct Connect attachment.
CreateTransitGatewayConnectRequestOptions options
The Connect attachment options.
SdkInternalList<T> tagSpecifications
The tags to apply to the Connect attachment.
String protocol
The tunnel protocol.
TransitGatewayConnect transitGatewayConnect
Information about the Connect attachment.
String transitGatewayId
The ID of the transit gateway.
CreateTransitGatewayMulticastDomainRequestOptions options
The options for the transit gateway multicast domain.
SdkInternalList<T> tagSpecifications
The tags for the transit gateway multicast domain.
String igmpv2Support
Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
String staticSourcesSupport
Specify whether to enable support for statically configuring multicast group sources for a domain.
String autoAcceptSharedAssociations
Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
TransitGatewayMulticastDomain transitGatewayMulticastDomain
Information about the transit gateway multicast domain.
String transitGatewayId
The ID of the transit gateway.
String peerTransitGatewayId
The ID of the peer transit gateway with which to create the peering attachment.
String peerAccountId
The AWS account ID of the owner of the peer transit gateway.
String peerRegion
The Region where the peer transit gateway is located.
SdkInternalList<T> tagSpecifications
The tags to apply to the transit gateway peering attachment.
TransitGatewayPeeringAttachment transitGatewayPeeringAttachment
The transit gateway peering attachment.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
String prefixListId
The ID of the prefix list that is used for destination matches.
String transitGatewayAttachmentId
The ID of the attachment to which traffic is routed.
Boolean blackhole
Indicates whether to drop traffic that matches this route.
TransitGatewayPrefixListReference transitGatewayPrefixListReference
Information about the prefix list reference.
String description
A description of the transit gateway.
TransitGatewayRequestOptions options
The transit gateway options.
SdkInternalList<T> tagSpecifications
The tags to apply to the transit gateway.
TransitGateway transitGateway
Information about the transit gateway.
String destinationCidrBlock
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
String transitGatewayAttachmentId
The ID of the attachment.
Boolean blackhole
Indicates whether to drop traffic that matches this route.
TransitGatewayRoute route
Information about the route.
String transitGatewayId
The ID of the transit gateway.
SdkInternalList<T> tagSpecifications
The tags to apply to the transit gateway route table.
TransitGatewayRouteTable transitGatewayRouteTable
Information about the transit gateway route table.
String transitGatewayId
The ID of the transit gateway.
String vpcId
The ID of the VPC.
SdkInternalList<T> subnetIds
The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.
CreateTransitGatewayVpcAttachmentRequestOptions options
The VPC attachment options.
SdkInternalList<T> tagSpecifications
The tags to apply to the VPC attachment.
String dnsSupport
Enable or disable DNS support. The default is enable
.
String ipv6Support
Enable or disable IPv6 support. The default is disable
.
String applianceModeSupport
Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses
the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is
disable
.
TransitGatewayVpcAttachment transitGatewayVpcAttachment
Information about the VPC attachment.
SdkInternalList<T> add
Adds the specified AWS account ID or group to the list.
SdkInternalList<T> remove
Removes the specified AWS account ID or group from the list.
String availabilityZone
The Availability Zone in which to create the volume.
Boolean encrypted
Indicates whether the volume should be encrypted. The effect of setting the encryption state to true
depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether
encryption by default is enabled. For more information, see Encryption by
default in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
Integer iops
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes,
this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits
for bursting.
The following are the supported values for each volume type:
gp3
: 3,000-16,000 IOPS
io1
: 100-64,000 IOPS
io2
: 100-64,000 IOPS
For io1
and io2
volumes, we guarantee 64,000 IOPS only for Instances
built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS. This parameter is not supported for gp2
, st1
, sc1
,
or standard
volumes.
String kmsKeyId
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId
is
specified, the encrypted state must be true
.
You can specify the CMK using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
Integer size
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2
and gp3
: 1-16,384
io1
and io2
: 4-16,384
st1
and sc1
: 125-16,384
standard
: 1-1,024
String snapshotId
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
String volumeType
The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2
| gp3
Provisioned IOPS SSD: io1
| io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
SdkInternalList<T> tagSpecifications
The tags to apply to the volume during creation.
Boolean multiAttachEnabled
Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up
to 16 Instances
built on the Nitro System in the same Availability Zone. This parameter is supported with io1
and io2
volumes only. For more information, see Amazon EBS Multi-Attach in
the Amazon Elastic Compute Cloud User Guide.
Integer throughput
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
Volume volume
Describes a volume.
String serviceId
The ID of the endpoint service.
String vpcEndpointId
The ID of the endpoint.
String connectionNotificationArn
The ARN of the SNS topic for the notifications.
SdkInternalList<T> connectionEvents
One or more endpoint events for which to receive notifications. Valid values are Accept
,
Connect
, Delete
, and Reject
.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
ConnectionNotification connectionNotification
Information about the notification.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String vpcEndpointType
The type of endpoint.
Default: Gateway
String vpcId
The ID of the VPC in which the endpoint will be used.
String serviceName
The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.
String policyDocument
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
SdkInternalList<T> routeTableIds
(Gateway endpoint) One or more route table IDs.
SdkInternalList<T> subnetIds
(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.
SdkInternalList<T> securityGroupIds
(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
Boolean privateDnsEnabled
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private
hosted zone contains a record set for the default public DNS name for the service for the Region (for example,
kinesis.us-east-1.amazonaws.com
), which resolves to the private IP addresses of the endpoint network
interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead
of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true
:
enableDnsHostnames
and enableDnsSupport
. Use ModifyVpcAttribute to set the VPC
attributes.
Default: true
SdkInternalList<T> tagSpecifications
The tags to associate with the endpoint.
VpcEndpoint vpcEndpoint
Information about the endpoint.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Boolean acceptanceRequired
Indicates whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.
String privateDnsName
(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
SdkInternalList<T> networkLoadBalancerArns
The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
SdkInternalList<T> gatewayLoadBalancerArns
The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
SdkInternalList<T> tagSpecifications
The tags to associate with the service.
ServiceConfiguration serviceConfiguration
Information about the service configuration.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String peerOwnerId
The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
String peerVpcId
The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
String vpcId
The ID of the requester VPC. You must specify this parameter in the request.
String peerRegion
The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
SdkInternalList<T> tagSpecifications
The tags to assign to the peering connection.
VpcPeeringConnection vpcPeeringConnection
Information about the VPC peering connection.
String cidrBlock
The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16
. We modify the
specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18
, we modify it
to 100.68.0.0/18
.
Boolean amazonProvidedIpv6CidrBlock
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
String ipv6Pool
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
String ipv6CidrBlock
The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool
in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
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
String ipv6CidrBlockNetworkBorderGroup
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock
to true
to use this parameter.
SdkInternalList<T> tagSpecifications
The tags to assign to the VPC.
Vpc vpc
Information about the VPC.
String customerGatewayId
The ID of the customer gateway.
String type
The type of VPN connection (ipsec.1
).
String vpnGatewayId
The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
String transitGatewayId
The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
VpnConnectionOptionsSpecification options
The options for the VPN connection.
SdkInternalList<T> tagSpecifications
The tags to apply to the VPN connection.
VpnConnection vpnConnection
Information about the VPN connection.
String availabilityZone
The Availability Zone for the virtual private gateway.
String type
The type of VPN connection this virtual private gateway supports.
SdkInternalList<T> tagSpecifications
The tags to apply to the virtual private gateway.
Long amazonSideAsn
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
VpnGateway vpnGateway
Information about the virtual private gateway.
String cpuCredits
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard
and
unlimited
.
String cpuCredits
The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard
and
unlimited
.
String bgpAsn
The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
String customerGatewayId
The ID of the customer gateway.
String ipAddress
The Internet-routable IP address of the customer gateway's outside interface.
String certificateArn
The Amazon Resource Name (ARN) for the customer gateway certificate.
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 deviceName
The name of customer gateway device.
SdkInternalList<T> tags
Any tags assigned to the customer gateway.
String carrierGatewayId
The ID of the carrier gateway.
CarrierGateway carrierGateway
Information about the carrier gateway.
String clientVpnEndpointId
The ID of the Client VPN to be deleted.
ClientVpnEndpointStatus status
The current state of the Client VPN endpoint.
String clientVpnEndpointId
The ID of the Client VPN endpoint from which the route is to be deleted.
String targetVpcSubnetId
The ID of the target subnet used by the route.
String destinationCidrBlock
The IPv4 address range, in CIDR notation, of the route to be deleted.
ClientVpnRouteStatus status
The current state of the route.
String customerGatewayId
The ID of the customer gateway.
String dhcpOptionsId
The ID of the DHCP options set.
String egressOnlyInternetGatewayId
The ID of the egress-only internet gateway.
Boolean returnCode
Returns true
if the request succeeds; otherwise, it returns an error.
DeleteFleetError error
The error.
String fleetId
The ID of the EC2 Fleet.
SdkInternalList<T> fleetIds
The IDs of the EC2 Fleets.
Boolean terminateInstances
Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances
.
Supported only for fleets of type maintain
and request
.
For instant
fleets, you cannot specify NoTerminateInstances
. A deleted
instant
fleet with running instances is not supported.
SdkInternalList<T> successfulFleetDeletions
Information about the EC2 Fleets that are successfully deleted.
SdkInternalList<T> unsuccessfulFleetDeletions
Information about the EC2 Fleets that are not successfully deleted.
SdkInternalList<T> flowLogIds
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
SdkInternalList<T> unsuccessful
Information about the flow logs that could not be deleted successfully.
String fpgaImageId
The ID of the AFI.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String internetGatewayId
The ID of the internet gateway.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
LaunchTemplate launchTemplate
Information about the launch template.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
SdkInternalList<T> versions
The version numbers of one or more launch template versions to delete.
String launchTemplateId
The ID of the launch template.
String launchTemplateName
The name of the launch template.
Long versionNumber
The version number of the launch template.
ResponseError responseError
Information about the error.
SdkInternalList<T> successfullyDeletedLaunchTemplateVersions
Information about the launch template versions that were successfully deleted.
SdkInternalList<T> unsuccessfullyDeletedLaunchTemplateVersions
Information about the launch template versions that could not be deleted.
LocalGatewayRoute route
Information about the route.
String localGatewayRouteTableVpcAssociationId
The ID of the association.
LocalGatewayRouteTableVpcAssociation localGatewayRouteTableVpcAssociation
Information about the association.
String prefixListId
The ID of the prefix list.
ManagedPrefixList prefixList
Information about the prefix list.
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 networkInsightsAnalysisId
The ID of the network insights analysis.
String networkInsightsAnalysisId
The ID of the network insights analysis.
String networkInsightsPathId
The ID of the path.
String networkInsightsPathId
The ID of the path.
Boolean returnValue
Returns true
if the request succeeds, otherwise returns an error.
String networkInterfaceId
The ID of the network interface.
String groupName
The name of the placement group.
SdkInternalList<T> reservedInstancesIds
The IDs of the Reserved Instances.
SdkInternalList<T> successfulQueuedPurchaseDeletions
Information about the queued purchases that were successfully deleted.
SdkInternalList<T> failedQueuedPurchaseDeletions
Information about the queued purchases that could not be deleted.
String destinationCidrBlock
The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
String destinationIpv6CidrBlock
The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
String destinationPrefixListId
The ID of the prefix list for the route.
String routeTableId
The ID of the route table.
String routeTableId
The ID of the route table.
String snapshotId
The ID of the EBS snapshot.
String subnetId
The ID of the subnet.
SdkInternalList<T> resources
The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
SdkInternalList<T> tags
The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete
AWS-generated tags (tags that have the aws:
prefix).
String trafficMirrorFilterId
The ID of the Traffic Mirror filter.
String trafficMirrorFilterId
The ID of the Traffic Mirror filter.
String trafficMirrorFilterRuleId
The ID of the Traffic Mirror rule.
String trafficMirrorFilterRuleId
The ID of the deleted Traffic Mirror rule.
String trafficMirrorSessionId
The ID of the Traffic Mirror session.
String trafficMirrorSessionId
The ID of the deleted Traffic Mirror session.
String trafficMirrorTargetId
The ID of the Traffic Mirror target.
String trafficMirrorTargetId
The ID of the deleted Traffic Mirror target.
String transitGatewayConnectPeerId
The ID of the Connect peer.
TransitGatewayConnectPeer transitGatewayConnectPeer
Information about the deleted Connect peer.
String transitGatewayAttachmentId
The ID of the Connect attachment.
TransitGatewayConnect transitGatewayConnect
Information about the deleted Connect attachment.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
TransitGatewayMulticastDomain transitGatewayMulticastDomain
Information about the deleted transit gateway multicast domain.
String transitGatewayAttachmentId
The ID of the transit gateway peering attachment.
TransitGatewayPeeringAttachment transitGatewayPeeringAttachment
The transit gateway peering attachment.
TransitGatewayPrefixListReference transitGatewayPrefixListReference
Information about the deleted prefix list reference.
String transitGatewayId
The ID of the transit gateway.
TransitGateway transitGateway
Information about the deleted transit gateway.
TransitGatewayRoute route
Information about the route.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
TransitGatewayRouteTable transitGatewayRouteTable
Information about the deleted transit gateway route table.
String transitGatewayAttachmentId
The ID of the attachment.
TransitGatewayVpcAttachment transitGatewayVpcAttachment
Information about the deleted VPC attachment.
String volumeId
The ID of the volume.
SdkInternalList<T> connectionNotificationIds
One or more notification IDs.
SdkInternalList<T> unsuccessful
Information about the notifications that could not be deleted successfully.
SdkInternalList<T> serviceIds
The IDs of one or more services.
SdkInternalList<T> unsuccessful
Information about the service configurations that were not deleted, if applicable.
SdkInternalList<T> vpcEndpointIds
One or more VPC endpoint IDs.
SdkInternalList<T> unsuccessful
Information about the VPC endpoints that were not successfully deleted.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcId
The ID of the VPC.
String vpnConnectionId
The ID of the VPN connection.
String vpnGatewayId
The ID of the virtual private gateway.
String cidr
The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
ByoipCidr byoipCidr
Information about the address range.
String imageId
The ID of the AMI.
DeregisterInstanceTagAttributeRequest instanceTagAttribute
Information about the tag keys to deregister.
InstanceTagNotificationAttribute instanceTagAttribute
The resulting set of tag keys.
Boolean includeAllTagsOfInstance
Indicates whether to deregister all tag keys in the current Region. Specify false
to deregister all
tag keys.
SdkInternalList<T> instanceTagKeys
Information about the tag keys to deregister.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
SdkInternalList<T> networkInterfaceIds
The IDs of the group members' network interfaces.
TransitGatewayMulticastDeregisteredGroupMembers deregisteredMulticastGroupMembers
Information about the deregistered members.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
SdkInternalList<T> networkInterfaceIds
The IDs of the group sources' network interfaces.
TransitGatewayMulticastDeregisteredGroupSources deregisteredMulticastGroupSources
Information about the deregistered group sources.
SdkInternalList<T> attributeNames
The account attribute names.
SdkInternalList<T> accountAttributes
Information about the account attributes.
SdkInternalList<T> allocationIds
[EC2-VPC] The allocation IDs.
String attribute
The attribute of the IP address.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> addresses
Information about the IP addresses.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters. 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-border-group
- A unique set of Availability Zones, Local Zones, or Wavelength Zones from
where AWS advertises IP addresses.
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, or the carrier IP address.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> publicIps
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
SdkInternalList<T> allocationIds
[EC2-VPC] Information about the allocation IDs.
SdkInternalList<T> addresses
Information about the Elastic IP addresses.
Boolean useLongIdsAggregated
Indicates whether all resource types in the Region are configured to use longer IDs. This value is only
true
if all users are configured to use longer IDs for all resources types in the Region.
SdkInternalList<T> statuses
Information about each resource's ID format.
SdkInternalList<T> filters
The filters.
group-name
- For Availability Zones, use the Region name. For Local Zones, use the name of the group
associated with the Local Zone (for example, us-west-2-lax-1
) For Wavelength Zones, use the name of
the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1
).
message
- The Zone message.
opt-in-status
- The opt-in status (opted-in
, and not-opted-in
|
opt-in-not-required
).
parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control
plane operations, such as API calls.
parent-zoneName
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control
plane operations, such as API calls.
region-name
- The name of the Region for the Zone (for example, us-east-1
).
state
- The state of the Availability Zone, the Local Zone, or the Wavelength Zone (
available
| information
| impaired
| unavailable
).
zone-id
- The ID of the Availability Zone (for example, use1-az1
), the Local Zone (for
example, usw2-lax1-az1
), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1
).
zone-type
- The type of zone, for example, local-zone
.
zone-name
- The name of the Availability Zone (for example, us-east-1a
), the Local Zone
(for example, us-west-2-lax-1a
), or the Wavelength Zone (for example,
us-east-1-wl1-bos-wlz-1
).
zone-type
- The type of zone, for example, local-zone
.
SdkInternalList<T> zoneNames
The names of the Availability Zones, Local Zones, and Wavelength Zones.
SdkInternalList<T> zoneIds
The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
Boolean allAvailabilityZones
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
SdkInternalList<T> availabilityZones
Information about the Availability Zones, Local Zones, and Wavelength Zones.
SdkInternalList<T> bundleIds
The bundle task IDs.
Default: Describes all your bundle tasks.
SdkInternalList<T> filters
The filters.
bundle-id
- The ID of the bundle task.
error-code
- If the task failed, the error code returned.
error-message
- If the task failed, the error message returned.
instance-id
- The ID of the instance.
progress
- The level of task completion, as a percentage (for example, 20%).
s3-bucket
- The Amazon S3 bucket to store the AMI.
s3-prefix
- The beginning of the AMI name.
start-time
- The time the task started (for example, 2013-09-15T17:15:20.000Z).
state
- The state of the task (pending
| waiting-for-shutdown
|
bundling
| storing
| cancelling
| complete
|
failed
).
update-time
- The time of the most recent update for the task.
SdkInternalList<T> bundleTasks
Information about the bundle tasks.
SdkInternalList<T> byoipCidrs
Information about your address ranges.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> capacityReservationIds
The ID of the Capacity Reservation.
String nextToken
The token to use 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 receive an error.
SdkInternalList<T> filters
One or more filters.
instance-type
- The type of instance for which the Capacity Reservation reserves capacity.
owner-id
- The ID of the AWS account that owns the Capacity Reservation.
availability-zone-id
- The Availability Zone ID of the Capacity Reservation.
instance-platform
- The type of operating system for which the Capacity Reservation reserves
capacity.
availability-zone
- The Availability Zone ID of the Capacity Reservation.
tenancy
- Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of
the following tenancy settings:
default
- The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated
- The Capacity Reservation is created on single-tenant hardware that is dedicated to a
single AWS account.
state
- The current state of the Capacity Reservation. A Capacity Reservation can be in one of the
following states:
active
- The Capacity Reservation is active and the capacity is available for your use.
expired
- The Capacity Reservation expired automatically at the date and time specified in your
request. The reserved capacity is no longer available for your use.
cancelled
- The Capacity Reservation was cancelled. The reserved capacity is no longer available for
your use.
pending
- The Capacity Reservation request was successful but the capacity provisioning is still
pending.
failed
- The Capacity Reservation request has failed. A request might fail due to invalid request
parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
end-date
- The date and time at which the Capacity Reservation expires. When a Capacity Reservation
expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity
Reservation's state changes to expired when it reaches its end date and time.
end-date-type
- Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can
have one of the following end types:
unlimited
- The Capacity Reservation remains active until you explicitly cancel it.
limited
- The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria
- Indicates the type of instance launches that the Capacity Reservation
accepts. The options include:
open
- The Capacity Reservation accepts all instances that have matching attributes (instance type,
platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation
automatically without specifying any additional parameters.
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance
type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only
permitted instances can use the reserved capacity.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> capacityReservations
Information about the Capacity Reservations.
SdkInternalList<T> carrierGatewayIds
One or more carrier gateway IDs.
SdkInternalList<T> filters
One or more filters.
carrier-gateway-id
- The ID of the carrier gateway.
state
- The state of the carrier gateway (pending
| failed
|
available
| deleting
| deleted
).
owner-id
- The AWS account ID of the owner of the carrier gateway.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC associated with the carrier gateway.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> carrierGateways
Information about the carrier gateway.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
group-id
- The ID of a VPC security group that's associated with the instance.
instance-id
- The ID of the instance.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC to which the instance is linked.
vpc-id
- The ID of the VPC that the instance is linked to.
SdkInternalList<T> instanceIds
One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
Constraint: If the value is greater than 1000, we return only 1000 items.
String nextToken
The token for the next page of results.
SdkInternalList<T> instances
Information about one or more linked EC2-Classic instances.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> filters
One or more filters. Filter names and values are case-sensitive.
description
- The description of the authorization rule.
destination-cidr
- The CIDR of the network to which the authorization rule applies.
group-id
- The ID of the Active Directory group to which the authorization rule grants access.
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 nextToken value.
SdkInternalList<T> authorizationRules
Information about the authorization rules.
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 clientVpnEndpointId
The ID of the Client VPN endpoint.
SdkInternalList<T> filters
One or more filters. Filter names and values are case-sensitive.
connection-id
- The ID of the connection.
username
- For Active Directory client authentication, the user name of the client who established
the client connection.
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 nextToken value.
SdkInternalList<T> connections
Information about the active and terminated client connections.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> clientVpnEndpointIds
The ID of the Client VPN endpoint.
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 nextToken value.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> filters
One or more filters. Filter names and values are case-sensitive.
endpoint-id
- The ID of the Client VPN endpoint.
transport-protocol
- The transport protocol (tcp
| udp
).
SdkInternalList<T> clientVpnEndpoints
Information about the Client VPN endpoints.
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 clientVpnEndpointId
The ID of the Client VPN endpoint.
SdkInternalList<T> filters
One or more filters. Filter names and values are case-sensitive.
destination-cidr
- The CIDR of the route destination.
origin
- How the route was associated with the Client VPN endpoint (associate
|
add-route
).
target-subnet
- The ID of the subnet through which traffic is routed.
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 nextToken value.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> routes
Information about the Client VPN endpoint routes.
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 clientVpnEndpointId
The ID of the Client VPN endpoint.
SdkInternalList<T> associationIds
The IDs of the target network associations.
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 nextToken value.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> filters
One or more filters. Filter names and values are case-sensitive.
association-id
- The ID of the association.
target-network-id
- The ID of the subnet specified as the target network.
vpc-id
- The ID of the VPC in which the target network is located.
SdkInternalList<T> clientVpnTargetNetworks
Information about the associated target networks.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> poolIds
The IDs of the address pools.
SdkInternalList<T> filters
The filters. The following are the possible values:
coip-pool.pool-id
coip-pool.local-gateway-route-table-id
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> coipPools
Information about the address pools.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> conversionTaskIds
The conversion task IDs.
SdkInternalList<T> conversionTasks
Information about the conversion tasks.
SdkInternalList<T> customerGatewayIds
One or more customer gateway IDs.
Default: Describes all your customer gateways.
SdkInternalList<T> filters
One or more filters.
bgp-asn
- The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id
- The ID of the customer gateway.
ip-address
- The IP address of the customer gateway's Internet-routable external interface.
state
- The state of the customer gateway (pending
| available
|
deleting
| deleted
).
type
- The type of customer gateway. Currently, the only supported type is ipsec.1
.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> customerGateways
Information about one or more customer gateways.
SdkInternalList<T> dhcpOptionsIds
The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
SdkInternalList<T> filters
One or more filters.
dhcp-options-id
- The ID of a DHCP options set.
key
- The key for one of the options (for example, domain-name
).
value
- The value for one of the options.
owner-id
- The ID of the AWS account that owns the DHCP options set.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> dhcpOptions
Information about one or more DHCP options sets.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> egressOnlyInternetGatewayIds
One or more egress-only internet gateway IDs.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> filters
One or more filters.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> egressOnlyInternetGateways
Information about the egress-only internet gateways.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> elasticGpuIds
The Elastic Graphics accelerator IDs.
SdkInternalList<T> filters
The filters.
availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
IMPAIRED
).
elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
elastic-gpu-type
- The type of Elastic Graphics accelerator; for example, eg1.medium
.
instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. This value can be between 5 and 1000.
String nextToken
The token to request the next page of results.
SdkInternalList<T> elasticGpuSet
Information about the Elastic Graphics accelerators.
Integer maxResults
The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
Filter tasks using the task-state
filter and one of the following values: active
,
completed
, deleting
, or deleted
.
SdkInternalList<T> exportImageTaskIds
The IDs of the export image tasks.
Integer maxResults
The maximum number of results to return in a single call.
String nextToken
A token that indicates the next page of results.
SdkInternalList<T> exportImageTasks
Information about the export image tasks.
String nextToken
The token to use to get the next page of results. This value is null
when there are no more results
to return.
SdkInternalList<T> exportTaskIds
The export task IDs.
SdkInternalList<T> filters
the filters for the export tasks.
SdkInternalList<T> exportTasks
Information about the export tasks.
SdkInternalList<T> filters
The filters. The possible values are:
availability-zone
: The Availability Zone of the snapshot.
owner-id
: The ID of the AWS account that enabled fast snapshot restore on the snapshot.
snapshot-id
: The ID of the snapshot.
state
: The state of fast snapshot restores for the snapshot (enabling
|
optimizing
| enabled
| disabling
| disabled
).
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> fastSnapshotRestores
Information about the state of fast snapshot restores.
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 snapshotId
The ID of the snapshot.
String availabilityZone
The Availability Zone.
String state
The state of fast snapshot restores.
String stateTransitionReason
The reason for the state transition. The possible values are as follows:
Client.UserInitiated
- The state successfully transitioned to enabling
or
disabling
.
Client.UserInitiated - Lifecycle state transition
- The state successfully transitioned to
optimizing
, enabled
, or disabled
.
String ownerId
The ID of the AWS account that enabled fast snapshot restores on the snapshot.
String ownerAlias
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
Date enablingTime
The time at which fast snapshot restores entered the enabling
state.
Date optimizingTime
The time at which fast snapshot restores entered the optimizing
state.
Date enabledTime
The time at which fast snapshot restores entered the enabled
state.
Date disablingTime
The time at which fast snapshot restores entered the disabling
state.
Date disabledTime
The time at which fast snapshot restores entered the disabled
state.
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
String lifecycle
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
String errorCode
The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.
String errorMessage
The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes.
String eventType
The type of events to describe. By default, all events are described.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
String fleetId
The ID of the EC2 Fleet.
Date startTime
The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SdkInternalList<T> historyRecords
Information about the events in the history of the EC2 Fleet.
Date lastEvaluatedTime
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken
indicates that there are more results, this value is not present.
String nextToken
The token for the next set of results.
String fleetId
The ID of the EC Fleet.
Date startTime
The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
String fleetId
The ID of the EC2 Fleet.
SdkInternalList<T> filters
The filters.
instance-type
- The instance type.
SdkInternalList<T> activeInstances
The running instances. This list is refreshed periodically and might be out of date.
String nextToken
The token for the next set of results.
String fleetId
The ID of the EC2 Fleet.
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
String lifecycle
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
SdkInternalList<T> instanceIds
The IDs of the instances.
String instanceType
The instance type.
String platform
The value is Windows
for Windows instances. Otherwise, the value is blank.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
SdkInternalList<T> fleetIds
The ID of the EC2 Fleets.
SdkInternalList<T> filters
The filters.
activity-status
- The progress of the EC2 Fleet ( error
|
pending-fulfillment
| pending-termination
| fulfilled
).
excess-capacity-termination-policy
- Indicates whether to terminate running instances if the target
capacity is decreased below the current EC2 Fleet size (true
| false
).
fleet-state
- The state of the EC2 Fleet (submitted
| active
|
deleted
| failed
| deleted-running
| deleted-terminating
|
modifying
).
replace-unhealthy-instances
- Indicates whether EC2 Fleet should replace unhealthy instances (
true
| false
).
type
- The type of request (instant
| request
| maintain
).
String nextToken
The token for the next set of results.
SdkInternalList<T> fleets
Information about the EC2 Fleets.
SdkInternalList<T> filter
One or more filters.
deliver-log-status
- The status of the logs delivery (SUCCESS
| FAILED
).
log-destination-type
- The type of destination to which the flow log publishes data. Possible
destination types include cloud-watch-logs
and s3
.
flow-log-id
- The ID of the flow log.
log-group-name
- The name of the log group.
resource-id
- The ID of the VPC, subnet, or network interface.
traffic-type
- The type of traffic (ACCEPT
| REJECT
| ALL
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> flowLogIds
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> flowLogs
Information about the flow logs.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
FpgaImageAttribute fpgaImageAttribute
Information about the attribute.
SdkInternalList<T> fpgaImageIds
The AFI IDs.
SdkInternalList<T> owners
Filters the AFI by owner. Specify an AWS account ID, self
(owner is the sender of the request), or
an AWS owner alias (valid values are amazon
| aws-marketplace
).
SdkInternalList<T> filters
The filters.
create-time
- The creation time of the AFI.
fpga-image-id
- The FPGA image identifier (AFI ID).
fpga-image-global-id
- The global FPGA image identifier (AGFI ID).
name
- The name of the AFI.
owner-id
- The AWS account ID of the AFI owner.
product-code
- The product code.
shell-version
- The version of the AWS Shell that was used to create the bitstream.
state
- The state of the AFI (pending
| failed
| available
|
unavailable
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
update-time
- The time of the most recent update.
String nextToken
The token to retrieve the next page of results.
Integer maxResults
The maximum number of results to return in a single call.
SdkInternalList<T> fpgaImages
Information about the FPGA images.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filter
The filters.
instance-family
- The instance family of the offering (for example, m4
).
payment-option
- The payment option (NoUpfront
| PartialUpfront
|
AllUpfront
).
Integer maxDuration
This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by
sending another request with the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
Integer minDuration
This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
String nextToken
The token to use to retrieve the next page of results.
String offeringId
The ID of the reservation offering.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> offeringSet
Information about the offerings.
SdkInternalList<T> filter
The filters.
instance-family
- The instance family (for example, m4
).
payment-option
- The payment option (NoUpfront
| PartialUpfront
|
AllUpfront
).
state
- The state of the reservation (payment-pending
| payment-failed
|
active
| retired
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> hostReservationIdSet
The host reservation IDs.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by
sending another request with the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
String nextToken
The token to use to retrieve the next page of results.
SdkInternalList<T> hostReservationSet
Details about the reservation's configuration.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filter
The filters.
auto-placement
- Whether auto-placement is enabled or disabled (on
| off
).
availability-zone
- The Availability Zone of the host.
client-token
- The idempotency token that you provided when you allocated the host.
host-reservation-id
- The ID of the reservation assigned to this host.
instance-type
- The instance type size that the Dedicated Host is configured to support.
state
- The allocation state of the Dedicated Host (available
|
under-assessment
| permanent-failure
| released
|
released-permanent-failure
).
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> hostIds
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by
sending another request with the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
String nextToken
The token to use to retrieve the next page of results.
SdkInternalList<T> hosts
Information about the Dedicated Hosts.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> associationIds
The IAM instance profile associations.
SdkInternalList<T> filters
The filters.
instance-id
- The ID of the instance.
state
- The state of the association (associating
| associated
|
disassociating
).
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value.
String nextToken
The token to request the next page of results.
SdkInternalList<T> iamInstanceProfileAssociations
Information about the IAM instance profile associations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String principalArn
The ARN of the principal, which can be an IAM role, IAM user, or the root user.
String resource
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
instance
| internet-gateway
| network-acl
|
network-acl-association
| network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
|
route-table-association
| security-group
| snapshot
| subnet
| subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
SdkInternalList<T> statuses
Information about the ID format for the resources.
String resource
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
instance
| internet-gateway
| network-acl
|
network-acl-association
| network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
|
route-table-association
| security-group
| snapshot
| subnet
| subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
SdkInternalList<T> statuses
Information about the ID format for the resource.
String attribute
The AMI attribute.
Note: The blockDeviceMapping
attribute is deprecated. Using this attribute returns the
Client.AuthFailure
error. To get information about the block device mappings for an AMI, use the
DescribeImages action.
String imageId
The ID of the AMI.
ImageAttribute imageAttribute
Describes an image attribute.
SdkInternalList<T> executableUsers
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self
(the
sender of the request), or all
(public AMIs).
SdkInternalList<T> filters
The filters.
architecture
- The image architecture (i386
| x86_64
| arm64
).
block-device-mapping.delete-on-termination
- A Boolean value that indicates whether the Amazon EBS
volume is deleted on instance termination.
block-device-mapping.device-name
- The device name specified in the block device mapping (for
example, /dev/sdh
or xvdh
).
block-device-mapping.snapshot-id
- The ID of the snapshot used for the EBS volume.
block-device-mapping.volume-size
- The volume size of the EBS volume, in GiB.
block-device-mapping.volume-type
- The volume type of the EBS volume (gp2
|
io1
| io2
| st1
| sc1
| standard
).
block-device-mapping.encrypted
- A Boolean that indicates whether the EBS volume is encrypted.
description
- The description of the image (provided during image creation).
ena-support
- A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor
- The hypervisor type (ovm
| xen
).
image-id
- The ID of the image.
image-type
- The image type (machine
| kernel
| ramdisk
).
is-public
- A Boolean that indicates whether the image is public.
kernel-id
- The kernel ID.
manifest-location
- The location of the image manifest.
name
- The name of the AMI (provided during image creation).
owner-alias
- The owner alias (amazon
| aws-marketplace
). The valid
aliases are defined in an Amazon-maintained list. This is not the AWS account alias that can be set using the IAM
console. We recommend that you use the Owner request parameter instead of this filter.
owner-id
- The AWS account ID of the owner. We recommend that you use the Owner request
parameter instead of this filter.
platform
- The platform. To only list Windows-based AMIs, use windows
.
product-code
- The product code.
product-code.type
- The type of the product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
root-device-name
- The device name of the root device volume (for example, /dev/sda1
).
root-device-type
- The type of the root device volume (ebs
|
instance-store
).
state
- The state of the image (available
| pending
| failed
).
state-reason-code
- The reason code for the state change.
state-reason-message
- The message for the state change.
sriov-net-support
- A value of simple
indicates that enhanced networking with the Intel
82599 VF interface is enabled.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
virtualization-type
- The virtualization type (paravirtual
| hvm
).
SdkInternalList<T> imageIds
The image IDs.
Default: Describes all images available to you.
SdkInternalList<T> owners
Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs,
self
, amazon
, and aws-marketplace
. If you omit this parameter, the results
include all images for which you have launch permissions, regardless of ownership.
SdkInternalList<T> images
Information about the images.
SdkInternalList<T> filters
Filter tasks using the task-state
filter and one of the following values: active
,
completed
, deleting
, or deleted
.
SdkInternalList<T> importTaskIds
The IDs of the import image tasks.
Integer maxResults
The maximum number of results to return in a single call.
String nextToken
A token that indicates the next page of results.
SdkInternalList<T> importImageTasks
A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.
String nextToken
The token to use to get the next page of results. This value is null
when there are no more results
to return.
SdkInternalList<T> filters
The filters.
SdkInternalList<T> importTaskIds
A list of import snapshot task IDs.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value.
String nextToken
A token that indicates the next page of results.
SdkInternalList<T> importSnapshotTasks
A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
String nextToken
The token to use to get the next page of results. This value is null
when there are no more results
to return.
InstanceAttribute instanceAttribute
Describes an instance attribute.
SdkInternalList<T> filters
The filters.
instance-id
- The ID of the instance.
SdkInternalList<T> instanceIds
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> instanceCreditSpecifications
Information about the credit option for CPU usage of an instance.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
InstanceTagNotificationAttribute instanceTagAttribute
Information about the registered tag keys.
SdkInternalList<T> filters
The filters.
affinity
- The affinity setting for an instance running on a Dedicated Host (default
|
host
).
architecture
- The instance architecture (i386
| x86_64
|
arm64
).
availability-zone
- The Availability Zone of the instance.
block-device-mapping.attach-time
- The attach time for an EBS volume mapped to the instance, for
example, 2010-09-15T17:15:20.000Z
.
block-device-mapping.delete-on-termination
- A Boolean that indicates whether the EBS volume is
deleted on instance termination.
block-device-mapping.device-name
- The device name specified in the block device mapping (for
example, /dev/sdh
or xvdh
).
block-device-mapping.status
- The status for the EBS volume (attaching
|
attached
| detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the EBS volume.
client-token
- The idempotency token you provided when you launched the instance.
dns-name
- The public DNS name of the instance.
group-id
- The ID of the security group for the instance. EC2-Classic only.
group-name
- The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured
- A Boolean that indicates whether the instance is enabled for
hibernation. A value of true
means that the instance is enabled for hibernation.
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
). The value
xen
is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn
- The instance profile associated with the instance. Specified as an ARN.
image-id
- The ID of the image used to launch the instance.
instance-id
- The ID of the instance.
instance-lifecycle
- Indicates whether this is a Spot Instance or a Scheduled Instance (
spot
| scheduled
).
instance-state-code
- The state of the instance, as a 16-bit unsigned integer. The high byte is used
for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values
are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
|
shutting-down
| terminated
| stopping
| stopped
).
instance-type
- The type of instance (for example, t2.micro
).
instance.group-id
- The ID of the security group for the instance.
instance.group-name
- The name of the security group for the instance.
ip-address
- The public IPv4 address of the instance.
kernel-id
- The kernel ID.
key-name
- The name of the key pair used when the instance was launched.
launch-index
- When launching multiple instances, this is the index for the instance in the launch
group (for example, 0, 1, 2, and so on).
launch-time
- The time when the instance was launched.
metadata-options.http-tokens
- The metadata request authorization state (optional
|
required
)
metadata-options.http-put-response-hop-limit
- The http metadata request put response hop limit
(integer, possible values 1
to 64
)
metadata-options.http-endpoint
- Enable or disable metadata access on http endpoint (
enabled
| disabled
)
monitoring-state
- Indicates whether detailed monitoring is enabled (disabled
|
enabled
).
network-interface.addresses.private-ip-address
- The private IPv4 address associated with the
network interface.
network-interface.addresses.primary
- Specifies whether the IPv4 address of the network interface is
the primary private IPv4 address.
network-interface.addresses.association.public-ip
- The ID of the association of an Elastic IP
address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id
- The owner ID of the private IPv4 address
associated with the network interface.
network-interface.association.public-ip
- The address of the Elastic IP address (IPv4) bound to the
network interface.
network-interface.association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated
with the network interface.
network-interface.association.allocation-id
- The allocation ID returned when you allocated the
Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id
- The association ID returned when the network
interface was associated with an IPv4 address.
network-interface.attachment.attachment-id
- The ID of the interface attachment.
network-interface.attachment.instance-id
- The ID of the instance to which the network interface is
attached.
network-interface.attachment.instance-owner-id
- The owner ID of the instance to which the network
interface is attached.
network-interface.attachment.device-index
- The device index to which the network interface is
attached.
network-interface.attachment.status
- The status of the attachment (attaching
|
attached
| detaching
| detached
).
network-interface.attachment.attach-time
- The time that the network interface was attached to an
instance.
network-interface.attachment.delete-on-termination
- Specifies whether the attachment is deleted
when an instance is terminated.
network-interface.availability-zone
- The Availability Zone for the network interface.
network-interface.description
- The description of the network interface.
network-interface.group-id
- The ID of a security group associated with the network interface.
network-interface.group-name
- The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address
- The IPv6 address associated with the network
interface.
network-interface.mac-address
- The MAC address of the network interface.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.owner-id
- The ID of the owner of the network interface.
network-interface.private-dns-name
- The private DNS name of the network interface.
network-interface.requester-id
- The requester ID for the network interface.
network-interface.requester-managed
- Indicates whether the network interface is being managed by
AWS.
network-interface.status
- The status of the network interface (available
) |
in-use
).
network-interface.source-dest-check
- Whether the network interface performs source/destination
checking. A value of true
means that checking is enabled, and false
means that checking
is disabled. The value must be false
for the network interface to perform network address
translation (NAT) in your VPC.
network-interface.subnet-id
- The ID of the subnet for the network interface.
network-interface.vpc-id
- The ID of the VPC for the network interface.
owner-id
- The AWS account ID of the instance owner.
placement-group-name
- The name of the placement group for the instance.
placement-partition-number
- The partition in which the instance is located.
platform
- The platform. To list only Windows instances, use windows
.
private-dns-name
- The private IPv4 DNS name of the instance.
private-ip-address
- The private IPv4 address of the instance.
product-code
- The product code associated with the AMI used to launch the instance.
product-code.type
- The type of product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the instance (for example, shows
"User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that launched the instance on your behalf (for example, AWS
Management Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation. A reservation ID is created any time you
launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be
associated with more than one instance if you launch multiple instances using the same launch request. For
example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same
launch request, you also get one reservation ID.
root-device-name
- The device name of the root device volume (for example, /dev/sda1
).
root-device-type
- The type of the root device volume (ebs
|
instance-store
).
source-dest-check
- Indicates whether the instance performs source/destination checking. A value of
true
means that checking is enabled, and false
means that checking is disabled. The
value must be false
for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot Instance request.
state-reason-code
- The reason code for the state change.
state-reason-message
- A message that describes the state change.
subnet-id
- The ID of the subnet for the instance.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have
a tag with a specific key, regardless of the tag value.
tenancy
- The tenancy of an instance (dedicated
| default
|
host
).
virtualization-type
- The virtualization type of the instance (paravirtual
|
hvm
).
vpc-id
- The ID of the VPC that the instance is running in.
SdkInternalList<T> instanceIds
The instance IDs.
Default: Describes all your instances.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.
String nextToken
The token to request the next page of results.
SdkInternalList<T> reservations
Information about the reservations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
The 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.instance-event-id
- The ID of the event whose date and time you are modifying.
event.not-after
- The latest end time for the scheduled event (for example,
2014-09-15T17:15:20.000Z
).
event.not-before
- The earliest start time for the scheduled event (for example,
2014-09-15T17:15:20.000Z
).
event.not-before-deadline
- The deadline for starting the event (for example,
2014-09-15T17:15:20.000Z
).
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte
is used for internal purposes and should be ignored. The low byte is set based on the state represented. The
valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
|
shutting-down
| terminated
| stopping
| stopped
).
instance-status.reachability
- Filters on instance status where the name is
reachability
(passed
| failed
| initializing
|
insufficient-data
).
instance-status.status
- The status of the instance (ok
| impaired
|
initializing
| insufficient-data
| not-applicable
).
system-status.reachability
- Filters on system status where the name is reachability
(
passed
| failed
| initializing
| insufficient-data
).
system-status.status
- The system status of the instance (ok
| impaired
|
initializing
| insufficient-data
| not-applicable
).
SdkInternalList<T> instanceIds
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this
parameter and the instance IDs parameter in the same call.
String nextToken
The token to retrieve the next page of results.
Boolean includeAllInstances
When true
, includes the health status for all instances. When false
, includes the
health status for running instances only.
Default: false
SdkInternalList<T> instanceStatuses
Information about the status of the 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.
String locationType
The location type.
SdkInternalList<T> filters
One or more filters. Filter names and values are case-sensitive.
location
- This depends on the location type. For example, if the location type is
region
(default), the location is the Region code (for example, us-east-2
.)
instance-type
- The instance type. For example, c5.2xlarge
.
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 next token value.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> instanceTypeOfferings
The instance types offered.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> instanceTypes
The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
SdkInternalList<T> filters
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported
- Indicates whether auto recovery is supported (true
|
false
).
bare-metal
- Indicates whether it is a bare metal instance type (true
|
false
).
burstable-performance-supported
- Indicates whether it is a burstable performance instance type (
true
| false
).
current-generation
- Indicates whether this instance type is the latest generation instance type of
an instance family (true
| false
).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps
- The baseline bandwidth performance for an
EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops
- The baseline input/output storage operations per second
for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps
- The baseline throughput performance for an
EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps
- The maximum bandwidth performance for an
EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops
- The maximum input/output storage operations per second
for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps
- The maximum throughput performance for an
EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support
- Indicates whether the instance type is EBS-optimized (
supported
| unsupported
| default
).
ebs-info.encryption-support
- Indicates whether EBS encryption is supported (supported
| unsupported
).
ebs-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for EBS
volumes (required
| supported
| unsupported
).
free-tier-eligible
- Indicates whether the instance type is eligible to use in the free tier (
true
| false
).
hibernation-supported
- Indicates whether On-Demand hibernation is supported (true
|
false
).
hypervisor
- The hypervisor (nitro
| xen
).
instance-storage-info.disk.count
- The number of local disks.
instance-storage-info.disk.size-in-gb
- The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type
- The storage technology for the local instance storage disks (
hdd
| ssd
).
instance-storage-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is
supported for instance store (required
| supported
) | unsupported
).
instance-storage-info.total-size-in-gb
- The total amount of storage available from all local
instance storage, in GB.
instance-storage-supported
- Indicates whether the instance type has local instance storage (
true
| false
).
instance-type
- The instance type (for example c5.2xlarge
or c5*).
memory-info.size-in-mib
- The memory size.
network-info.efa-supported
- Indicates whether the instance type supports Elastic Fabric Adapter
(EFA) (true
| false
).
network-info.ena-support
- Indicates whether Elastic Network Adapter (ENA) is supported or required
(required
| supported
| unsupported
).
network-info.ipv4-addresses-per-interface
- The maximum number of private IPv4 addresses per network
interface.
network-info.ipv6-addresses-per-interface
- The maximum number of private IPv6 addresses per network
interface.
network-info.ipv6-supported
- Indicates whether the instance type supports IPv6 (true
|
false
).
network-info.maximum-network-interfaces
- The maximum number of network interfaces per instance.
network-info.network-performance
- The network performance (for example, "25 Gigabit").
processor-info.supported-architecture
- The CPU architecture (arm64
| i386
| x86_64
).
processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in GHz.
supported-root-device-type
- The root device type (ebs
| instance-store
).
supported-usage-class
- The usage class (on-demand
| spot
).
supported-virtualization-type
- The virtualization type (hvm
| paravirtual
).
vcpu-info.default-cores
- The default number of cores for the instance type.
vcpu-info.default-threads-per-core
- The default number of threads per core for the instance type.
vcpu-info.default-vcpus
- The default number of vCPUs for the instance type.
vcpu-info.valid-cores
- The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core
- The number of threads per core that can be configured for the
instance type. For example, "1" or "1,2".
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 next token value.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> instanceTypes
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
attachment.state
- The current state of the attachment between the gateway and the VPC (
available
). Present only if a VPC is attached.
attachment.vpc-id
- The ID of an attached VPC.
internet-gateway-id
- The ID of the Internet gateway.
owner-id
- The ID of the AWS account that owns the internet gateway.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> internetGatewayIds
One or more internet gateway IDs.
Default: Describes all your internet gateways.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> internetGateways
Information about one or more internet gateways.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> poolIds
The IDs of the IPv6 address pools.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> filters
One or more filters.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> ipv6Pools
Information about the IPv6 address pools.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
The filters.
key-pair-id
- The ID of the key pair.
fingerprint
- The fingerprint of the key pair.
key-name
- The name of the key pair.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
SdkInternalList<T> keyNames
The key pair names.
Default: Describes all your key pairs.
SdkInternalList<T> keyPairIds
The IDs of the key pairs.
SdkInternalList<T> keyPairs
Information about the key pairs.
SdkInternalList<T> launchTemplateIds
One or more launch template IDs.
SdkInternalList<T> launchTemplateNames
One or more launch template names.
SdkInternalList<T> filters
One or more filters.
create-time
- The time the launch template was created.
launch-template-name
- The name of the launch template.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. This value can be between 1 and 200.
SdkInternalList<T> launchTemplates
Information about the launch templates.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String launchTemplateId
The ID of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.
String launchTemplateName
The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.
SdkInternalList<T> versions
One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest
,
$Default
, and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is
$Latest
. To describe all launch templates in your account that are defined as the default version,
the valid value is $Default
. You can specify $Latest
and $Default
in the
same call. You cannot specify numbers.
String minVersion
The version number after which to describe launch template versions.
String maxVersion
The version number up to which to describe launch template versions.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. This value can be between 1 and 200.
SdkInternalList<T> filters
One or more filters.
create-time
- The time the launch template version was created.
ebs-optimized
- A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
iam-instance-profile
- The ARN of the IAM instance profile.
image-id
- The ID of the AMI.
instance-type
- The instance type.
is-default-version
- A boolean that indicates whether the launch template version is the default
version.
kernel-id
- The kernel ID.
ram-disk-id
- The RAM disk ID.
SdkInternalList<T> launchTemplateVersions
Information about the launch template versions.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> localGatewayRouteTableIds
The IDs of the local gateway route tables.
SdkInternalList<T> filters
One or more filters.
local-gateway-id
- The ID of a local gateway.
local-gateway-route-table-id
- The ID of a local gateway route table.
outpost-arn
- The Amazon Resource Name (ARN) of the Outpost.
state
- The state of the local gateway route table.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> localGatewayRouteTables
Information about the local gateway route tables.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> localGatewayRouteTableVirtualInterfaceGroupAssociationIds
The IDs of the associations.
SdkInternalList<T> filters
One or more filters.
local-gateway-id
- The ID of a local gateway.
local-gateway-route-table-id
- The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id
- The ID of the association.
local-gateway-route-table-virtual-interface-group-id
- The ID of the virtual interface group.
state
- The state of the association.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> localGatewayRouteTableVirtualInterfaceGroupAssociations
Information about the associations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> localGatewayRouteTableVpcAssociationIds
The IDs of the associations.
SdkInternalList<T> filters
One or more filters.
local-gateway-id
- The ID of a local gateway.
local-gateway-route-table-id
- The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id
- The ID of the association.
state
- The state of the association.
vpc-id
- The ID of the VPC.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> localGatewayRouteTableVpcAssociations
Information about the associations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> localGatewayIds
One or more filters.
local-gateway-id
- The ID of a local gateway.
local-gateway-route-table-id
- The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id
- The ID of the association.
local-gateway-route-table-virtual-interface-group-id
- The ID of the virtual interface group.
outpost-arn
- The Amazon Resource Name (ARN) of the Outpost.
state
- The state of the association.
SdkInternalList<T> filters
One or more filters.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> localGateways
Information about the local gateways.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> localGatewayVirtualInterfaceGroupIds
The IDs of the virtual interface groups.
SdkInternalList<T> filters
One or more filters.
local-gateway-id
- The ID of a local gateway.
local-gateway-virtual-interface-id
- The ID of the virtual interface.
local-gateway-virtual-interface-group-id
- The ID of the virtual interface group.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> localGatewayVirtualInterfaceGroups
The virtual interface groups.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> localGatewayVirtualInterfaceIds
The IDs of the virtual interfaces.
SdkInternalList<T> filters
One or more filters.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> localGatewayVirtualInterfaces
Information about the virtual interfaces.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
owner-id
- The ID of the prefix list owner.
prefix-list-id
- The ID of the prefix list.
prefix-list-name
- The name of the prefix list.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> prefixListIds
One or more prefix list IDs.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> prefixLists
Information about the prefix lists.
SdkInternalList<T> filters
One or more filters.
moving-status
- The status of the Elastic IP address (MovingToVpc
|
RestoringToClassic
).
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. This value can be
between 5 and 1000; if MaxResults
is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
String nextToken
The token for the next page of results.
SdkInternalList<T> publicIps
One or more Elastic IP addresses.
SdkInternalList<T> movingAddressStatuses
The status for each Elastic IP address.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filter
One or more filters.
nat-gateway-id
- The ID of the NAT gateway.
state
- The state of the NAT gateway (pending
| failed
|
available
| deleting
| deleted
).
subnet-id
- The ID of the subnet in which the NAT gateway resides.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC in which the NAT gateway resides.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> natGatewayIds
One or more NAT gateway IDs.
String nextToken
The token for the next page of results.
SdkInternalList<T> natGateways
Information about the NAT gateways.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
association.association-id
- The ID of an association ID for the ACL.
association.network-acl-id
- The ID of the network ACL involved in the association.
association.subnet-id
- The ID of the subnet involved in the association.
default
- Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr
- The IPv4 CIDR range specified in the entry.
entry.icmp.code
- The ICMP code specified in the entry, if any.
entry.icmp.type
- The ICMP type specified in the entry, if any.
entry.ipv6-cidr
- The IPv6 CIDR range specified in the entry.
entry.port-range.from
- The start of the port range specified in the entry.
entry.port-range.to
- The end of the port range specified in the entry.
entry.protocol
- The protocol specified in the entry (tcp
| udp
|
icmp
or a protocol number).
entry.rule-action
- Allows or denies the matching traffic (allow
| deny
).
entry.rule-number
- The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id
- The ID of the network ACL.
owner-id
- The ID of the AWS account that owns the network ACL.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC for the network ACL.
SdkInternalList<T> networkAclIds
One or more network ACL IDs.
Default: Describes all your network ACLs.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> networkAcls
Information about one or more network ACLs.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> networkInsightsAnalysisIds
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
String networkInsightsPathId
The ID of the path. You must specify either a path ID or analysis IDs.
Date analysisStartTime
The time when the network insights analyses started.
Date analysisEndTime
The time when the network insights analyses ended.
SdkInternalList<T> filters
The filters. The following are possible values:
PathFound - A Boolean value that indicates whether a feasible path is found.
Status - The status of the analysis (running | succeeded | failed).
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> networkInsightsAnalyses
Information about the network insights analyses.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> networkInsightsPathIds
The IDs of the paths.
SdkInternalList<T> filters
The filters. The following are possible values:
Destination - The ID of the resource.
DestinationPort - The destination port.
Name - The path name.
Protocol - The protocol.
Source - The ID of the resource.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> networkInsightsPaths
Information about the paths.
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.
NetworkInterfaceAttachment attachment
The attachment (if any) of the network interface.
String description
The description of the network interface.
SdkInternalList<T> groups
The security groups associated with the network interface.
String networkInterfaceId
The ID of the network interface.
Boolean sourceDestCheck
Indicates whether source/destination checking is enabled.
SdkInternalList<T> networkInterfacePermissionIds
One or more network interface permission IDs.
SdkInternalList<T> filters
One or more filters.
network-interface-permission.network-interface-permission-id
- The ID of the permission.
network-interface-permission.network-interface-id
- The ID of the network interface.
network-interface-permission.aws-account-id
- The AWS account ID.
network-interface-permission.aws-service
- The AWS service.
network-interface-permission.permission
- The type of permission (INSTANCE-ATTACH
|
EIP-ASSOCIATE
).
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call
with the returned NextToken
value. If this parameter is not specified, up to 50 results are returned
by default.
SdkInternalList<T> networkInterfacePermissions
The network interface permissions.
String nextToken
The token to use to retrieve the next page of results.
SdkInternalList<T> filters
One or more filters.
addresses.private-ip-address
- The private IPv4 addresses associated with the network interface.
addresses.primary
- Whether the private IPv4 address is the primary IP address associated with the
network interface.
addresses.association.public-ip
- The association ID returned when the network interface was
associated with the Elastic IP address (IPv4).
addresses.association.owner-id
- The owner ID of the addresses associated with the network
interface.
association.association-id
- The association ID returned when the network interface was associated
with an IPv4 address.
association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address
(IPv4) for your network interface.
association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated with the network
interface.
association.public-ip
- The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name
- The public DNS name for the network interface (IPv4).
attachment.attachment-id
- The ID of the interface attachment.
attachment.attach-time
- The time that the network interface was attached to an instance.
attachment.delete-on-termination
- Indicates whether the attachment is deleted when an instance is
terminated.
attachment.device-index
- The device index to which the network interface is attached.
attachment.instance-id
- The ID of the instance to which the network interface is attached.
attachment.instance-owner-id
- The owner ID of the instance to which the network interface is
attached.
attachment.status
- The status of the attachment (attaching
| attached
|
detaching
| detached
).
availability-zone
- The Availability Zone of the network interface.
description
- The description of the network interface.
group-id
- The ID of a security group associated with the network interface.
group-name
- The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address
- An IPv6 address associated with the network interface.
mac-address
- The MAC address of the network interface.
network-interface-id
- The ID of the network interface.
owner-id
- The AWS account ID of the network interface owner.
private-ip-address
- The private IPv4 address or addresses of the network interface.
private-dns-name
- The private DNS name of the network interface (IPv4).
requester-id
- The alias or AWS account ID of the principal or service that created the network
interface.
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-dest-check
- Indicates whether the network interface performs source/destination checking. A
value of true
means checking is enabled, and false
means checking is disabled. The
value must be false
for the network interface to perform network address translation (NAT) in your
VPC.
status
- The status of the network interface. If the network interface is not attached to an
instance, the status is available
; if a network interface is attached to an instance the status is
in-use
.
subnet-id
- The ID of the subnet for the network interface.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC for the network interface.
SdkInternalList<T> networkInterfaceIds
One or more network interface IDs.
Default: Describes all your network interfaces.
String nextToken
The token to retrieve the next page of results.
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.
SdkInternalList<T> networkInterfaces
Information about one or more network interfaces.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
The filters.
group-name
- The name of the placement group.
state
- The state of the placement group (pending
| available
|
deleting
| deleted
).
strategy
- The strategy of the placement group (cluster
| spread
|
partition
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> groupNames
The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
SdkInternalList<T> groupIds
The IDs of the placement groups.
SdkInternalList<T> placementGroups
Information about the placement groups.
SdkInternalList<T> filters
One or more filters.
prefix-list-id
: The ID of a prefix list.
prefix-list-name
: The name of a prefix list.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> prefixListIds
One or more prefix list IDs.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> prefixLists
All available prefix lists.
SdkInternalList<T> resources
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
instance
| internet-gateway
| network-acl
|
network-acl-association
| network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
|
route-table-association
| security-group
| snapshot
| subnet
| subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
String nextToken
The token to request the next page of results.
SdkInternalList<T> principals
Information about the ID format settings for the ARN.
String nextToken
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
SdkInternalList<T> poolIds
The IDs of the address pools.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> filters
One or more filters.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> publicIpv4Pools
Information about the address pools.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
The filters.
endpoint
- The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com
).
opt-in-status
- The opt-in status of the Region (opt-in-not-required
|
opted-in
| not-opted-in
).
region-name
- The name of the Region (for example, us-east-1
).
SdkInternalList<T> regionNames
The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
Boolean allRegions
Indicates whether to display all Regions, including Regions that are disabled for your account.
SdkInternalList<T> regions
Information about the Regions.
SdkInternalList<T> filters
One or more filters.
reserved-instances-id
- The ID of the Reserved Instances.
reserved-instances-listing-id
- The ID of the Reserved Instances listing.
status
- The status of the Reserved Instance listing (pending
| active
|
cancelled
| closed
).
status-message
- The reason for the status.
String reservedInstancesId
One or more Reserved Instance IDs.
String reservedInstancesListingId
One or more Reserved Instance listing IDs.
SdkInternalList<T> reservedInstancesListings
Information about the Reserved Instance listing.
SdkInternalList<T> filters
One or more filters.
client-token
- The idempotency token for the modification request.
create-date
- The time when the modification request was created.
effective-date
- The time when the modification becomes effective.
modification-result.reserved-instances-id
- The ID for the Reserved Instances created as part of the
modification request. This ID is only available when the status of the modification is fulfilled
.
modification-result.target-configuration.availability-zone
- The Availability Zone for the new
Reserved Instances.
modification-result.target-configuration.instance-count
- The number of new Reserved Instances.
modification-result.target-configuration.instance-type
- The instance type of the new Reserved
Instances.
modification-result.target-configuration.platform
- The network platform of the new Reserved
Instances (EC2-Classic
| EC2-VPC
).
reserved-instances-id
- The ID of the Reserved Instances modified.
reserved-instances-modification-id
- The ID of the modification request.
status
- The status of the Reserved Instances modification request (processing
|
fulfilled
| failed
).
status-message
- The reason for the status.
update-date
- The time when the modification request was last updated.
SdkInternalList<T> reservedInstancesModificationIds
IDs for the submitted modification request.
String nextToken
The token to retrieve the next page of results.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> reservedInstancesModifications
The Reserved Instance modification information.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (for example, one year or three years), in seconds
(31536000
| 94608000
).
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
instance-type
- The instance type that is covered by the reservation.
marketplace
- Set to true
to show only Reserved Instance Marketplace offerings. When
this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance
Marketplace are listed.
product-description
- The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the product platform description will only be displayed to EC2-Classic account
holders and are for use with Amazon VPC. (Linux/UNIX
| Linux/UNIX (Amazon VPC)
|
SUSE Linux
| SUSE Linux (Amazon VPC)
| Red Hat Enterprise Linux
|
Red Hat Enterprise Linux (Amazon VPC)
| Windows
| Windows (Amazon VPC)
|
Windows with SQL Server Standard
| Windows with SQL Server Standard (Amazon VPC)
|
Windows with SQL Server Web
| Windows with SQL Server Web (Amazon VPC)
|
Windows with SQL Server Enterprise
| Windows with SQL Server Enterprise (Amazon VPC)
)
reserved-instances-offering-id
- The Reserved Instances offering ID.
scope
- The scope of the Reserved Instance (Availability Zone
or Region
).
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
Boolean includeMarketplace
Include Reserved Instance Marketplace offerings in the response.
String instanceType
The instance type that the reservation will cover (for example, m1.small
). For more information, see
Instance types in the
Amazon EC2 User Guide.
Long maxDuration
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
Integer maxInstanceCount
The maximum number of instances to filter when searching for offerings.
Default: 20
Long minDuration
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
String offeringClass
The offering class of the Reserved Instance. Can be standard
or convertible
.
String productDescription
The Reserved Instance product platform description. Instances that include (Amazon VPC)
in the
description are for use with Amazon VPC.
SdkInternalList<T> reservedInstancesOfferingIds
One or more Reserved Instances offering IDs.
String instanceTenancy
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
dedicated
is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated
Instances).
Important: The host
value cannot be used with this parameter. Use the default
or
dedicated
values only.
Default: default
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. The maximum is
100.
Default: 100
String nextToken
The token to retrieve the next page of results.
String offeringType
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
have access to the Medium Utilization
Reserved Instance offering type.
SdkInternalList<T> reservedInstancesOfferings
A list of Reserved Instances offerings.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone where the Reserved Instance can be used.
duration
- The duration of the Reserved Instance (one year or three years), in seconds (
31536000
| 94608000
).
end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).
instance-type
- The instance type that is covered by the reservation.
scope
- The scope of the Reserved Instance (Region
or Availability Zone
).
product-description
- The Reserved Instance product platform description. Instances that include
(Amazon VPC)
in the product platform description will only be displayed to EC2-Classic account
holders and are for use with Amazon VPC (Linux/UNIX
| Linux/UNIX (Amazon VPC)
|
SUSE Linux
| SUSE Linux (Amazon VPC)
| Red Hat Enterprise Linux
|
Red Hat Enterprise Linux (Amazon VPC)
| Windows
| Windows (Amazon VPC)
|
Windows with SQL Server Standard
| Windows with SQL Server Standard (Amazon VPC)
|
Windows with SQL Server Web
| Windows with SQL Server Web (Amazon VPC)
|
Windows with SQL Server Enterprise
| Windows with SQL Server Enterprise (Amazon VPC)
).
reserved-instances-id
- The ID of the Reserved Instance.
start
- The time at which the Reserved Instance purchase request was placed (for example,
2014-08-07T11:54:42.000Z).
state
- The state of the Reserved Instance (payment-pending
| active
|
payment-failed
| retired
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
String offeringClass
Describes whether the Reserved Instance is Standard or Convertible.
SdkInternalList<T> reservedInstancesIds
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
String offeringType
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
have access to the Medium Utilization
Reserved Instance offering type.
SdkInternalList<T> reservedInstances
A list of Reserved Instances.
SdkInternalList<T> filters
One or more filters.
association.route-table-association-id
- The ID of an association ID for the route table.
association.route-table-id
- The ID of the route table involved in the association.
association.subnet-id
- The ID of the subnet involved in the association.
association.main
- Indicates whether the route table is the main route table for the VPC (
true
| false
). Route tables that do not have an association ID are not returned in the
response.
owner-id
- The ID of the AWS account that owns the route table.
route-table-id
- The ID of the route table.
route.destination-cidr-block
- The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block
- The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id
- The ID (prefix) of the AWS service specified in a route in the
table.
route.egress-only-internet-gateway-id
- The ID of an egress-only Internet gateway specified in a
route in the route table.
route.gateway-id
- The ID of a gateway specified in a route in the table.
route.instance-id
- The ID of an instance specified in a route in the table.
route.nat-gateway-id
- The ID of a NAT gateway.
route.transit-gateway-id
- The ID of a transit gateway.
route.origin
- Describes how the route was created. CreateRouteTable
indicates that the
route was automatically created when the route table was created; CreateRoute
indicates that the
route was manually added to the route table; EnableVgwRoutePropagation
indicates that the route was
propagated by route propagation.
route.state
- The state of a route in the route table (active
| blackhole
). The blackhole state indicates that the route's target isn't available (for example, the specified gateway
isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id
- The ID of a VPC peering connection specified in a route in the
table.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC for the route table.
SdkInternalList<T> routeTableIds
One or more route table IDs.
Default: Describes all your route tables.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> routeTables
Information about one or more route tables.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
The filters.
availability-zone
- The Availability Zone (for example, us-west-2a
).
instance-type
- The instance type (for example, c4.large
).
network-platform
- The network platform (EC2-Classic
or EC2-VPC
).
platform
- The platform (Linux/UNIX
or Windows
).
SlotDateTimeRangeRequest firstSlotStartTimeRange
The time period for the first schedule to start.
Integer maxResults
The maximum number of results to return in a single call. This value can be between 5 and 300. The default value
is 300. To retrieve the remaining results, make another call with the returned NextToken
value.
Integer maxSlotDurationInHours
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours
and
less than 1,720.
Integer minSlotDurationInHours
The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
String nextToken
The token for the next set of results.
ScheduledInstanceRecurrenceRequest recurrence
The schedule recurrence.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
SdkInternalList<T> scheduledInstanceAvailabilitySet
Information about the available Scheduled Instances.
SdkInternalList<T> filters
The filters.
availability-zone
- The Availability Zone (for example, us-west-2a
).
instance-type
- The instance type (for example, c4.large
).
network-platform
- The network platform (EC2-Classic
or EC2-VPC
).
platform
- The platform (Linux/UNIX
or Windows
).
Integer maxResults
The maximum number of results to return in a single call. This value can be between 5 and 300. The default value
is 100. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
SdkInternalList<T> scheduledInstanceIds
The Scheduled Instance IDs.
SlotStartTimeRangeRequest slotStartTimeRange
The time period for the first schedule to start.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
SdkInternalList<T> scheduledInstanceSet
Information about the Scheduled Instances.
SdkInternalList<T> groupId
The IDs of the security groups in your account.
SdkInternalList<T> securityGroupReferenceSet
Information about the VPCs with the referencing security groups.
SdkInternalList<T> filters
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description
- The description of the security group.
egress.ip-permission.cidr
- An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port
- For an outbound rule, the start of port range for the TCP and UDP
protocols, or an ICMP type number.
egress.ip-permission.group-id
- The ID of a security group that has been referenced in an outbound
security group rule.
egress.ip-permission.group-name
- The name of a security group that is referenced in an outbound
security group rule.
egress.ip-permission.ipv6-cidr
- An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id
- The ID of a prefix list to which a security group rule allows
outbound access.
egress.ip-permission.protocol
- The IP protocol for an outbound security group rule (
tcp
| udp
| icmp
, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port
- For an outbound rule, the end of port range for the TCP and UDP
protocols, or an ICMP code.
egress.ip-permission.user-id
- The ID of an AWS account that has been referenced in an outbound
security group rule.
group-id
- The ID of the security group.
group-name
- The name of the security group.
ip-permission.cidr
- An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port
- For an inbound rule, the start of port range for the TCP and UDP
protocols, or an ICMP type number.
ip-permission.group-id
- The ID of a security group that has been referenced in an inbound security
group rule.
ip-permission.group-name
- The name of a security group that is referenced in an inbound security
group rule.
ip-permission.ipv6-cidr
- An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id
- The ID of a prefix list from which a security group rule allows
inbound access.
ip-permission.protocol
- The IP protocol for an inbound security group rule (tcp
|
udp
| icmp
, a protocol number, or -1 for all protocols).
ip-permission.to-port
- For an inbound rule, the end of port range for the TCP and UDP protocols, or
an ICMP code.
ip-permission.user-id
- The ID of an AWS account that has been referenced in an inbound security
group rule.
owner-id
- The AWS account ID of the owner of the security group.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC specified when the security group was created.
SdkInternalList<T> groupIds
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all your security groups.
SdkInternalList<T> groupNames
[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group
name or the security group ID. For security groups in a nondefault VPC, use the group-name
filter to
describe security groups by name.
Default: Describes all your security groups.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another request
with the returned NextToken
value. This value can be between 5 and 1000. If this parameter is not
specified, then all results are returned.
SdkInternalList<T> securityGroups
Information about the security groups.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> createVolumePermissions
The users and groups that have the permissions for creating volumes from the snapshot.
SdkInternalList<T> productCodes
The product codes.
String snapshotId
The ID of the EBS snapshot.
SdkInternalList<T> filters
The filters.
description
- A description of the snapshot.
encrypted
- Indicates whether the snapshot is encrypted (true
| false
)
owner-alias
- The owner alias, from an Amazon-maintained list (amazon
). This is not the
user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter
instead of this filter.
owner-id
- The AWS account ID of the owner. We recommend that you use the related parameter instead
of this filter.
progress
- The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id
- The snapshot ID.
start-time
- The time stamp when the snapshot was initiated.
status
- The status of the snapshot (pending
| completed
|
error
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
volume-id
- The ID of the volume the snapshot is for.
volume-size
- The size of the volume, in GiB.
Integer maxResults
The maximum number of snapshot results returned by DescribeSnapshots
in paginated output. When this
parameter is used, DescribeSnapshots
only returns MaxResults
results in a single page
along with a NextToken
response element. The remaining results of the initial request can be seen by
sending another DescribeSnapshots
request with the returned NextToken
value. This value
can be between 5 and 1,000; if MaxResults
is given a value larger than 1,000, only 1,000 results are
returned. If this parameter is not used, then DescribeSnapshots
returns all results. You cannot
specify this parameter and the snapshot IDs parameter in the same request.
String nextToken
The NextToken
value returned from a previous paginated DescribeSnapshots
request where
MaxResults
was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.
SdkInternalList<T> ownerIds
Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs,
self
, and amazon
.
SdkInternalList<T> restorableByUserIds
The IDs of the AWS accounts that can create volumes from the snapshot.
SdkInternalList<T> snapshotIds
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
SdkInternalList<T> snapshots
Information about the snapshots.
String nextToken
The NextToken
value to include in a future DescribeSnapshots
request. When the results
of a DescribeSnapshots
request exceed MaxResults
, this value can be used to retrieve
the next page of results. This value is null
when there are no more results to return.
SpotDatafeedSubscription spotDatafeedSubscription
The Spot Instance data feed subscription.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
String spotFleetRequestId
The ID of the Spot Fleet request.
SdkInternalList<T> activeInstances
The running instances. This list is refreshed periodically and might be out of date.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
String spotFleetRequestId
The ID of the Spot Fleet request.
String eventType
The type of events to describe. By default, all events are described.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
String spotFleetRequestId
The ID of the Spot Fleet request.
Date startTime
The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SdkInternalList<T> historyRecords
Information about the events in the history of the Spot Fleet request.
Date lastEvaluatedTime
The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken
indicates that there are more results, this value is not present.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
String spotFleetRequestId
The ID of the Spot Fleet request.
Date startTime
The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
SdkInternalList<T> spotFleetRequestIds
The IDs of the Spot Fleet requests.
String nextToken
The token required to retrieve the next set of results. This value is null
when there are no more
results to return.
SdkInternalList<T> spotFleetRequestConfigs
Information about the configuration of your Spot Fleet.
SdkInternalList<T> filters
One or more filters.
availability-zone-group
- The Availability Zone group.
create-time
- The time stamp when the Spot Instance request was created.
fault-code
- The fault code related to the request.
fault-message
- The fault message related to the request.
instance-id
- The ID of the instance that fulfilled the request.
launch-group
- The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination
- Indicates whether the EBS volume is deleted on
instance termination.
launch.block-device-mapping.device-name
- The device name for the volume in the block device mapping
(for example, /dev/sdh
or xvdh
).
launch.block-device-mapping.snapshot-id
- The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size
- The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type
- The type of EBS volume: gp2
for General
Purpose SSD, io1
or io2
for Provisioned IOPS SSD, st1
for Throughput
Optimized HDD, sc1
for Cold HDD, or standard
for Magnetic.
launch.group-id
- The ID of the security group for the instance.
launch.group-name
- The name of the security group for the instance.
launch.image-id
- The ID of the AMI.
launch.instance-type
- The type of instance (for example, m3.medium
).
launch.kernel-id
- The kernel ID.
launch.key-name
- The name of the key pair the instance launched with.
launch.monitoring-enabled
- Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id
- The RAM disk ID.
launched-availability-zone
- The Availability Zone in which the request is launched.
network-interface.addresses.primary
- Indicates whether the IP address is the primary private IP
address.
network-interface.delete-on-termination
- Indicates whether the network interface is deleted when
the instance is terminated.
network-interface.description
- A description of the network interface.
network-interface.device-index
- The index of the device for the network interface attachment on the
instance.
network-interface.group-id
- The ID of the security group associated with the network interface.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.private-ip-address
- The primary private IP address of the network interface.
network-interface.subnet-id
- The ID of the subnet for the instance.
product-description
- The product description associated with the instance (Linux/UNIX
| Windows
).
spot-instance-request-id
- The Spot Instance request ID.
spot-price
- The maximum hourly price for any Spot Instance launched to fulfill the request.
state
- The state of the Spot Instance request (open
| active
|
closed
| cancelled
| failed
). Spot request status information can help you
track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the
Amazon EC2 User Guide for Linux Instances.
status-code
- The short code describing the most recent evaluation of your Spot Instance request.
status-message
- The message explaining the status of the Spot Instance request.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
type
- The type of Spot Instance request (one-time
| persistent
).
valid-from
- The start date of the request.
valid-until
- The end date of the request.
SdkInternalList<T> spotInstanceRequestIds
One or more Spot Instance request IDs.
String nextToken
The token to request the next set of results. This value is null
when there are no more results to
return.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the
remaining results, make another call with the returned NextToken
value.
SdkInternalList<T> spotInstanceRequests
One or more Spot Instance requests.
String nextToken
The token to use to retrieve the next set of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone for 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
|
Red Hat Enterprise Linux
| SUSE Linux
| Windows
|
Linux/UNIX (Amazon VPC)
| Red Hat Enterprise Linux (Amazon VPC)
|
SUSE Linux (Amazon VPC)
| Windows (Amazon VPC)
).
spot-price
- The Spot price. The value must match exactly (or use wildcards; greater than or less
than comparison is not supported).
timestamp
- The time stamp of the Spot price history, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or
less than comparison is not supported.
String availabilityZone
Filters the results by the specified Availability Zone.
Date endTime
The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SdkInternalList<T> instanceTypes
Filters the results by the specified instance types.
Integer maxResults
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value
is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
String nextToken
The token for the next set of results.
SdkInternalList<T> productDescriptions
Filters the results by the specified basic product descriptions.
Date startTime
The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String nextToken
The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.
SdkInternalList<T> spotPriceHistory
The historical Spot prices.
Integer maxResults
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
String nextToken
The token for the next set of items to return. (You received this token from a prior call.)
String vpcId
The ID of the VPC.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
SdkInternalList<T> staleSecurityGroupSet
Information about the stale security groups.
SdkInternalList<T> filters
One or more filters.
availability-zone
- The Availability Zone for the subnet. You can also use
availabilityZone
as the filter name.
availability-zone-id
- The ID of the Availability Zone for the subnet. You can also use
availabilityZoneId
as the filter name.
available-ip-address-count
- The number of IPv4 addresses in the subnet that are available.
cidr-block
- The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the
subnet's CIDR block for information to be returned for the subnet. You can also use cidr
or
cidrBlock
as the filter names.
default-for-az
- Indicates whether this is the default subnet for the Availability Zone. You can
also use defaultForAz
as the filter name.
ipv6-cidr-block-association.ipv6-cidr-block
- An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id
- An association ID for an IPv6 CIDR block associated
with the subnet.
ipv6-cidr-block-association.state
- The state of an IPv6 CIDR block associated with the subnet.
owner-id
- The ID of the AWS account that owns the subnet.
state
- The state of the subnet (pending
| available
).
subnet-arn
- The Amazon Resource Name (ARN) of the subnet.
subnet-id
- The ID of the subnet.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC for the subnet.
SdkInternalList<T> subnetIds
One or more subnet IDs.
Default: Describes all your subnets.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> subnets
Information about one or more subnets.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
The filters.
key
- The tag key.
resource-id
- The ID of the resource.
resource-type
- The resource type (customer-gateway
| dedicated-host
|
dhcp-options
| elastic-ip
| fleet
| fpga-image
|
host-reservation
| image
| instance
| internet-gateway
|
key-pair
| launch-template
| natgateway
| network-acl
|
network-interface
| placement-group
| reserved-instances
|
route-table
| security-group
| snapshot
|
spot-instances-request
| subnet
| volume
| vpc
|
vpc-endpoint
| vpc-endpoint-service
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
).
tag
:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the
filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value
- The tag value.
Integer maxResults
The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the
remaining results, make another call with the returned NextToken
value.
String nextToken
The token to retrieve the next page of results.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> tags
The tags.
SdkInternalList<T> trafficMirrorFilterIds
The ID of the Traffic Mirror filter.
SdkInternalList<T> filters
One or more filters. The possible values are:
description
: The Traffic Mirror filter description.
traffic-mirror-filter-id
: The ID of the Traffic Mirror filter.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> trafficMirrorFilters
Information about one or more Traffic Mirror filters.
String nextToken
The token to use to retrieve the next page of results. The value is null
when there are no more
results to return.
SdkInternalList<T> trafficMirrorSessionIds
The ID of the Traffic Mirror session.
SdkInternalList<T> filters
One or more filters. The possible values are:
description
: The Traffic Mirror session description.
network-interface-id
: The ID of the Traffic Mirror session network interface.
owner-id
: The ID of the account that owns the Traffic Mirror session.
packet-length
: The assigned number of packets to mirror.
session-number
: The assigned session number.
traffic-mirror-filter-id
: The ID of the Traffic Mirror filter.
traffic-mirror-session-id
: The ID of the Traffic Mirror session.
traffic-mirror-target-id
: The ID of the Traffic Mirror target.
virtual-network-id
: The virtual network ID of the Traffic Mirror session.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> trafficMirrorSessions
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
String nextToken
The token to use to retrieve the next page of results. The value is null
when there are no more
results to return.
SdkInternalList<T> trafficMirrorTargetIds
The ID of the Traffic Mirror targets.
SdkInternalList<T> filters
One or more filters. The possible values are:
description
: The Traffic Mirror target description.
network-interface-id
: The ID of the Traffic Mirror session network interface.
network-load-balancer-arn
: The Amazon Resource Name (ARN) of the Network Load Balancer that is
associated with the session.
owner-id
: The ID of the account that owns the Traffic Mirror session.
traffic-mirror-target-id
: The ID of the Traffic Mirror target.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> trafficMirrorTargets
Information about one or more Traffic Mirror targets.
String nextToken
The token to use to retrieve the next page of results. The value is null
when there are no more
results to return.
SdkInternalList<T> transitGatewayAttachmentIds
The IDs of the attachments.
SdkInternalList<T> filters
One or more filters. The possible values are:
association.state
- The state of the association (associating
| associated
| disassociating
).
association.transit-gateway-route-table-id
- The ID of the route table for the transit gateway.
resource-id
- The ID of the resource.
resource-owner-id
- The ID of the AWS account that owns the resource.
resource-type
- The resource type. Valid values are vpc
| vpn
|
direct-connect-gateway
| peering
| connect
.
state
- The state of the attachment. Valid values are available
| deleted
| deleting
| failed
| failing
| initiatingRequest
|
modifying
| pendingAcceptance
| pending
| rollingBack
|
rejected
| rejecting
.
transit-gateway-attachment-id
- The ID of the attachment.
transit-gateway-id
- The ID of the transit gateway.
transit-gateway-owner-id
- The ID of the AWS account that owns the transit gateway.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayAttachments
Information about the attachments.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> transitGatewayConnectPeerIds
The IDs of the Connect peers.
SdkInternalList<T> filters
One or more filters. The possible values are:
state
- The state of the Connect peer (pending
| available
|
deleting
| deleted
).
transit-gateway-attachment-id
- The ID of the attachment.
transit-gateway-connect-peer-id
- The ID of the Connect peer.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayConnectPeers
Information about the Connect peers.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> transitGatewayAttachmentIds
The IDs of the attachments.
SdkInternalList<T> filters
One or more filters. The possible values are:
options.protocol
- The tunnel protocol (gre
).
state
- The state of the attachment (initiating
| initiatingRequest
|
pendingAcceptance
| rollingBack
| pending
| available
|
modifying
| deleting
| deleted
| failed
|
rejected
| rejecting
| failing
).
transit-gateway-attachment-id
- The ID of the Connect attachment.
transit-gateway-id
- The ID of the transit gateway.
transport-transit-gateway-attachment-id
- The ID of the transit gateway attachment from which the
Connect attachment was created.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayConnects
Information about the Connect attachments.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> transitGatewayMulticastDomainIds
The ID of the transit gateway multicast domain.
SdkInternalList<T> filters
One or more filters. The possible values are:
state
- The state of the transit gateway multicast domain. Valid values are pending
|
available
| deleting
| deleted
.
transit-gateway-id
- The ID of the transit gateway.
transit-gateway-multicast-domain-id
- The ID of the transit gateway multicast domain.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayMulticastDomains
Information about the transit gateway multicast domains.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> transitGatewayAttachmentIds
One or more IDs of the transit gateway peering attachments.
SdkInternalList<T> filters
One or more filters. The possible values are:
transit-gateway-attachment-id
- The ID of the transit gateway attachment.
local-owner-id
- The ID of your AWS account.
remote-owner-id
- The ID of the AWS account in the remote Region that owns the transit gateway.
state
- The state of the peering attachment. Valid values are available
|
deleted
| deleting
| failed
| failing
|
initiatingRequest
| modifying
| pendingAcceptance
| pending
|
rollingBack
| rejected
| rejecting
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have
a tag with a specific key, regardless of the tag value.
transit-gateway-id
- The ID of the transit gateway.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayPeeringAttachments
The transit gateway peering attachments.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> transitGatewayRouteTableIds
The IDs of the transit gateway route tables.
SdkInternalList<T> filters
One or more filters. The possible values are:
default-association-route-table
- Indicates whether this is the default association route table for
the transit gateway (true
| false
).
default-propagation-route-table
- Indicates whether this is the default propagation route table for
the transit gateway (true
| false
).
state
- The state of the route table (available
| deleting
|
deleted
| pending
).
transit-gateway-id
- The ID of the transit gateway.
transit-gateway-route-table-id
- The ID of the transit gateway route table.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayRouteTables
Information about the transit gateway route tables.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> transitGatewayIds
The IDs of the transit gateways.
SdkInternalList<T> filters
One or more filters. The possible values are:
options.propagation-default-route-table-id
- The ID of the default propagation route table.
options.amazon-side-asn
- The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id
- The ID of the default association route table.
options.auto-accept-shared-attachments
- Indicates whether there is automatic acceptance of
attachment requests (enable
| disable
).
options.default-route-table-association
- Indicates whether resource attachments are automatically
associated with the default association route table (enable
| disable
).
options.default-route-table-propagation
- Indicates whether resource attachments automatically
propagate routes to the default propagation route table (enable
| disable
).
options.dns-support
- Indicates whether DNS support is enabled (enable
|
disable
).
options.vpn-ecmp-support
- Indicates whether Equal Cost Multipath Protocol support is enabled (
enable
| disable
).
owner-id
- The ID of the AWS account that owns the transit gateway.
state
- The state of the transit gateway (available
| deleted
|
deleting
| modifying
| pending
).
transit-gateway-id
- The ID of the transit gateway.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGateways
Information about the transit gateways.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> transitGatewayAttachmentIds
The IDs of the attachments.
SdkInternalList<T> filters
One or more filters. The possible values are:
state
- The state of the attachment. Valid values are available
| deleted
| deleting
| failed
| failing
| initiatingRequest
|
modifying
| pendingAcceptance
| pending
| rollingBack
|
rejected
| rejecting
.
transit-gateway-attachment-id
- The ID of the attachment.
transit-gateway-id
- The ID of the transit gateway.
vpc-id
- The ID of the VPC.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayVpcAttachments
Information about the VPC attachments.
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.
Boolean autoEnableIO
The state of autoEnableIO
attribute.
SdkInternalList<T> productCodes
A list of product codes.
String volumeId
The ID of the volume.
SdkInternalList<T> volumeIds
The IDs of the volumes.
SdkInternalList<T> filters
The filters.
modification-state
- The current modification state (modifying | optimizing | completed | failed).
original-iops
- The original IOPS rate of the volume.
original-size
- The original size of the volume, in GiB.
original-volume-type
- The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 |
st1).
originalMultiAttachEnabled
- Indicates whether Multi-Attach support was enabled (true | false).
start-time
- The modification start time.
target-iops
- The target IOPS rate of the volume.
target-size
- The target size of the volume, in GiB.
target-volume-type
- The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
targetMultiAttachEnabled
- Indicates whether Multi-Attach support is to be enabled (true | false).
volume-id
- The ID of the volume.
String nextToken
The nextToken
value returned by a previous paginated request.
Integer maxResults
The maximum number of results (up to a limit of 500) to be returned in a paginated request.
SdkInternalList<T> volumesModifications
Information about the volume modifications.
String nextToken
Token for pagination, null if there are no more results
SdkInternalList<T> filters
The filters.
attachment.attach-time
- The time stamp when the attachment initiated.
attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
attachment.device
- The device name specified in the block device mapping (for example,
/dev/sda1
).
attachment.instance-id
- The ID of the instance the volume is attached to.
attachment.status
- The attachment state (attaching
| attached
|
detaching
).
availability-zone
- The Availability Zone in which the volume was created.
create-time
- The time stamp when the volume was created.
encrypted
- Indicates whether the volume is encrypted (true
| false
)
multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (true
|
false
)
fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for fast
snapshot restore (true
| false
).
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was created.
status
- The state of the volume (creating
| available
|
in-use
| deleting
| deleted
| error
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
volume-id
- The volume ID.
volume-type
- The Amazon EBS volume type (gp2
| gp3
| io1
|
io2
| st1
| sc1
| standard
)
SdkInternalList<T> volumeIds
The volume IDs.
Integer maxResults
The maximum number of volume results returned by DescribeVolumes
in paginated output. When this
parameter is used, DescribeVolumes
only returns MaxResults
results in a single page
along with a NextToken
response element. The remaining results of the initial request can be seen by
sending another DescribeVolumes
request with the returned NextToken
value. This value
can be between 5 and 500; if MaxResults
is given a value larger than 500, only 500 results are
returned. If this parameter is not used, then DescribeVolumes
returns all results. You cannot
specify this parameter and the volume IDs parameter in the same request.
String nextToken
The NextToken
value returned from a previous paginated DescribeVolumes
request where
MaxResults
was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.
SdkInternalList<T> volumes
Information about the volumes.
String nextToken
The NextToken
value to include in a future DescribeVolumes
request. When the results of
a DescribeVolumes
request exceed MaxResults
, this value can be used to retrieve the
next page of results. This value is null
when there are no more results to return.
SdkInternalList<T> filters
The filters.
action.code
- The action code for the event (for example, enable-volume-io
).
action.description
- A description of the action.
action.event-id
- The event ID associated with the action.
availability-zone
- The Availability Zone of the instance.
event.description
- A description of the event.
event.event-id
- The event ID.
event.event-type
- The event type (for io-enabled
: passed
|
failed
; for io-performance
: io-performance:degraded
|
io-performance:severely-degraded
| io-performance:stalled
).
event.not-after
- The latest end time for the event.
event.not-before
- The earliest start time for the event.
volume-status.details-name
- The cause for volume-status.status
(
io-enabled
| io-performance
).
volume-status.details-status
- The status of volume-status.details-name
(for
io-enabled
: passed
| failed
; for io-performance
:
normal
| degraded
| severely-degraded
| stalled
).
volume-status.status
- The status of the volume (ok
| impaired
|
warning
| insufficient-data
).
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 1,000; if
MaxResults
is given a value larger than 1,000, only 1,000 results are returned. If this parameter is
not used, then DescribeVolumeStatus
returns all results. You cannot specify this parameter and the
volume IDs parameter in the same request.
String nextToken
The NextToken
value to include in a future DescribeVolumeStatus
request. When the
results of the request exceed MaxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
SdkInternalList<T> volumeIds
The IDs of the volumes.
Default: Describes all your volumes.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> volumeStatuses
Information about the status of the volumes.
String vpcId
The ID of the VPC.
Boolean enableDnsHostnames
Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true
,
instances in the VPC get DNS hostnames; otherwise, they do not.
Boolean enableDnsSupport
Indicates whether DNS resolution is enabled for the VPC. If this attribute is true
, the Amazon DNS
server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> vpcIds
One or more VPC IDs.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> vpcs
Information about the ClassicLink DNS support status of the VPCs.
SdkInternalList<T> filters
One or more filters.
is-classic-link-enabled
- Whether the VPC is enabled for ClassicLink (true
|
false
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
SdkInternalList<T> vpcIds
One or more VPCs for which you want to describe the ClassicLink status.
SdkInternalList<T> vpcs
The ClassicLink status of one or more VPCs.
String connectionNotificationId
The ID of the notification.
SdkInternalList<T> filters
One or more filters.
connection-notification-arn
- The ARN of the SNS topic for the notification.
connection-notification-id
- The ID of the notification.
connection-notification-state
- The state of the notification (Enabled
|
Disabled
).
connection-notification-type
- The type of notification (Topic
).
service-id
- The ID of the endpoint service.
vpc-endpoint-id
- The ID of the VPC endpoint.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another request
with the returned NextToken
value.
String nextToken
The token to request the next page of results.
SdkInternalList<T> connectionNotificationSet
One or more notifications.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
service-id
- The ID of the service.
vpc-endpoint-owner
- The AWS account number of the owner of the endpoint.
vpc-endpoint-state
- The state of the endpoint (pendingAcceptance
|
pending
| available
| deleting
| deleted
|
rejected
| failed
).
vpc-endpoint-id
- The ID of the endpoint.
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. This value can be
between 5 and 1,000; if MaxResults
is given a value larger than 1,000, only 1,000 results are
returned.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> vpcEndpointConnections
Information about one or more VPC endpoint connections.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> serviceIds
The IDs of one or more services.
SdkInternalList<T> filters
One or more filters.
service-name
- The name of the service.
service-id
- The ID of the service.
service-state
- The state of the service (Pending
| Available
|
Deleting
| Deleted
| Failed
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
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 1,000; if MaxResults
is given a value larger than 1,000, only 1,000 results are
returned.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> serviceConfigurations
Information about one or more services.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String serviceId
The ID of the service.
SdkInternalList<T> filters
One or more filters.
principal
- The ARN of the principal.
principal-type
- The principal type (All
| Service
|
OrganizationUnit
| Account
| User
| Role
).
Integer maxResults
The maximum number of results to return for the request in a single page. The remaining results of the initial
request can be seen by sending another request with the returned NextToken
value. This value can be
between 5 and 1,000; if MaxResults
is given a value larger than 1,000, only 1,000 results are
returned.
String nextToken
The token to retrieve the next page of results.
SdkInternalList<T> allowedPrincipals
Information about one or more allowed principals.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> serviceNames
One or more service names.
SdkInternalList<T> filters
One or more filters.
service-name
- The name of the service.
service-type
- The type of service (Interface
| Gateway
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
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 1,000, we return only 1,000 items.
String nextToken
The token for the next set of items to return. (You received this token from a prior call.)
SdkInternalList<T> serviceNames
A list of supported services.
SdkInternalList<T> serviceDetails
Information about the service.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
SdkInternalList<T> vpcEndpointIds
One or more endpoint IDs.
SdkInternalList<T> filters
One or more filters.
service-name
- The name of the service.
vpc-id
- The ID of the VPC in which the endpoint resides.
vpc-endpoint-id
- The ID of the endpoint.
vpc-endpoint-state
- The state of the endpoint (pendingAcceptance
|
pending
| available
| deleting
| deleted
|
rejected
| failed
).
vpc-endpoint-type
- The type of VPC endpoint (Interface
| Gateway
|
GatewayLoadBalancer
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
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 1,000, we return only 1,000 items.
String nextToken
The token for the next set of items to return. (You received this token from a prior call.)
SdkInternalList<T> vpcEndpoints
Information about the endpoints.
String nextToken
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
SdkInternalList<T> filters
One or more filters.
accepter-vpc-info.cidr-block
- The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id
- The AWS account ID of the owner of the accepter VPC.
accepter-vpc-info.vpc-id
- The ID of the accepter VPC.
expiration-time
- The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block
- The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id
- The AWS account ID of the owner of the requester VPC.
requester-vpc-info.vpc-id
- The ID of the requester VPC.
status-code
- The status of the VPC peering connection (pending-acceptance
|
failed
| expired
| provisioning
| active
|
deleting
| deleted
| rejected
).
status-message
- A message that provides more information about the status of the VPC peering
connection, if applicable.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id
- The ID of the VPC peering connection.
SdkInternalList<T> vpcPeeringConnectionIds
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> vpcPeeringConnections
Information about the VPC peering connections.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
cidr
- The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the
VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits
(for example, /28
).
cidr-block-association.cidr-block
- An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id
- The association ID for an IPv4 CIDR block associated with
the VPC.
cidr-block-association.state
- The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id
- The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block
- An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool
- The ID of the IPv6 address pool from which the IPv6 CIDR
block is allocated.
ipv6-cidr-block-association.association-id
- The association ID for an IPv6 CIDR block associated
with the VPC.
ipv6-cidr-block-association.state
- The state of an IPv6 CIDR block associated with the VPC.
isDefault
- Indicates whether the VPC is the default VPC.
owner-id
- The ID of the AWS account that owns the VPC.
state
- The state of the VPC (pending
| available
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC.
SdkInternalList<T> vpcIds
One or more VPC IDs.
Default: Describes all your VPCs.
String nextToken
The token for the next page of results.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
SdkInternalList<T> vpcs
Information about one or more VPCs.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> filters
One or more filters.
customer-gateway-configuration
- The configuration information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway associated with the VPN connection.
state
- The state of the VPN connection (pending
| available
|
deleting
| deleted
).
option.static-routes-only
- Indicates whether the connection has static routes only. Used for
devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR block. This corresponds to the subnet used in a
customer data center.
bgp-asn
- The BGP Autonomous System Number (ASN) associated with a BGP device.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
type
- The type of VPN connection. Currently the only supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id
- The ID of a transit gateway associated with the VPN connection.
SdkInternalList<T> vpnConnectionIds
One or more VPN connection IDs.
Default: Describes your VPN connections.
SdkInternalList<T> vpnConnections
Information about one or more VPN connections.
SdkInternalList<T> filters
One or more filters.
amazon-side-asn
- The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state
- The current state of the attachment between the gateway and the VPC (
attaching
| attached
| detaching
| detached
).
attachment.vpc-id
- The ID of an attached VPC.
availability-zone
- The Availability Zone for the virtual private gateway (if applicable).
state
- The state of the virtual private gateway (pending
| available
|
deleting
| deleted
).
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
a tag with a specific key, regardless of the tag value.
type
- The type of virtual private gateway. Currently the only supported type is
ipsec.1
.
vpn-gateway-id
- The ID of the virtual private gateway.
SdkInternalList<T> vpnGatewayIds
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
SdkInternalList<T> vpnGateways
Information about one or more virtual private gateways.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String attachmentId
The ID of the attachment.
Boolean force
Specifies whether to force a detachment.
Use the Force
parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force
parameter to detach a network interface, you might not be able to attach a
different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start 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.
String instanceId
The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
String volumeId
The ID of the volume.
VolumeAttachment attachment
Describes volume attachment details.
String key
The name of a DHCP option.
SdkInternalList<T> values
One or more values for the DHCP option.
SdkInternalList<T> dhcpConfigurations
One or more DHCP options in the set.
String dhcpOptionsId
The ID of the set of DHCP options.
String ownerId
The ID of the AWS account that owns the DHCP options set.
SdkInternalList<T> tags
Any tags assigned to the DHCP options set.
String directoryId
The ID of the Active Directory used for authentication.
String directoryId
The ID of the Active Directory to be used for authentication.
Boolean ebsEncryptionByDefault
The updated status of encryption by default.
String snapshotId
The ID of the snapshot.
SdkInternalList<T> fastSnapshotRestoreStateErrors
The errors.
SdkInternalList<T> availabilityZones
One or more Availability Zones. For example, us-east-2a
.
SdkInternalList<T> sourceSnapshotIds
The IDs of one or more snapshots. For example, snap-1234567890abcdef0
.
SdkInternalList<T> successful
Information about the snapshots for which fast snapshot restores were successfully disabled.
SdkInternalList<T> unsuccessful
Information about the snapshots for which fast snapshot restores could not be disabled.
String availabilityZone
The Availability Zone.
DisableFastSnapshotRestoreStateError error
The error.
String snapshotId
The ID of the snapshot.
String availabilityZone
The Availability Zone.
String state
The state of fast snapshot restores for the snapshot.
String stateTransitionReason
The reason for the state transition. The possible values are as follows:
Client.UserInitiated
- The state successfully transitioned to enabling
or
disabling
.
Client.UserInitiated - Lifecycle state transition
- The state successfully transitioned to
optimizing
, enabled
, or disabled
.
String ownerId
The ID of the AWS account that enabled fast snapshot restores on the snapshot.
String ownerAlias
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
Date enablingTime
The time at which fast snapshot restores entered the enabling
state.
Date optimizingTime
The time at which fast snapshot restores entered the optimizing
state.
Date enabledTime
The time at which fast snapshot restores entered the enabled
state.
Date disablingTime
The time at which fast snapshot restores entered the disabling
state.
Date disabledTime
The time at which fast snapshot restores entered the disabled
state.
TransitGatewayPropagation propagation
Information about route propagation.
String vpcId
The ID of the VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcId
The ID of the VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String associationId
The ID of the target network association.
AssociationStatus status
The current state of the target network association.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String associationId
The ID of the IAM instance profile association.
IamInstanceProfileAssociation iamInstanceProfileAssociation
Information about the IAM instance profile association.
String associationId
The association ID representing the current association between the route table and subnet or gateway.
String associationId
The association ID for the CIDR block.
SubnetIpv6CidrBlockAssociation ipv6CidrBlockAssociation
Information about the IPv6 CIDR block association.
String subnetId
The ID of the subnet.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String transitGatewayAttachmentId
The ID of the attachment.
SdkInternalList<T> subnetIds
The IDs of the subnets;
TransitGatewayMulticastDomainAssociations associations
Information about the association.
TransitGatewayAssociation association
Information about the association.
String associationId
The association ID for the CIDR block.
VpcIpv6CidrBlockAssociation ipv6CidrBlockAssociation
Information about the IPv6 CIDR block association.
VpcCidrBlockAssociation cidrBlockAssociation
Information about the IPv4 CIDR block association.
String vpcId
The ID of the VPC.
String description
A description of the disk image.
DiskImageDetail image
Information about the disk image.
VolumeDetail volume
Information about the volume.
String checksum
The checksum computed for the disk image.
String format
The disk image format.
String importManifestUrl
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
Long size
The size of the disk image, in GiB.
Long bytes
The size of the disk image, in GiB.
String format
The disk image format.
String importManifestUrl
A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
SdkInternalList<T> customDnsServers
The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.
Boolean enabled
Indicates whether DNS servers should be used. Specify False
to delete the existing DNS servers.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
Integer iops
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes,
this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits
for bursting.
The following are the supported values for each volume type:
gp3
: 3,000-16,000 IOPS
io1
: 100-64,000 IOPS
io2
: 100-64,000 IOPS
For io1
and io2
volumes, we guarantee 64,000 IOPS only for Instances
built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS. This parameter is not supported for gp2
, st1
, sc1
,
or standard
volumes.
String snapshotId
The ID of the snapshot.
Integer volumeSize
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2
and gp3
:1-16,384
io1
and io2
: 4-16,384
st1
and sc1
: 125-16,384
standard
: 1-1,024
String volumeType
The volume type. For more information, see Amazon EBS volume types in the
Amazon EC2 User Guide. If the volume type is io1
or io2
, you must specify the
IOPS that the volume supports.
String kmsKeyId
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet, and
RequestSpotInstances.
Integer throughput
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
String outpostArn
The ARN of the Outpost on which the snapshot is stored.
Boolean encrypted
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
The effect of setting the encryption state to true
depends on the volume origin (new or from a
snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more
information, see Amazon EBS
encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by .
String ebsOptimizedSupport
Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide.
String encryptionSupport
Indicates whether Amazon EBS encryption is supported.
EbsOptimizedInfo ebsOptimizedInfo
Describes the optimized EBS performance for the instance type.
String nvmeSupport
Indicates whether non-volatile memory express (NVMe) is supported.
Integer baselineBandwidthInMbps
The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
Double baselineThroughputInMBps
The baseline throughput performance for an EBS-optimized instance type, in MB/s.
Integer baselineIops
The baseline input/output storage operations per seconds for an EBS-optimized instance type.
Integer maximumBandwidthInMbps
The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
Double maximumThroughputInMBps
The maximum throughput performance for an EBS-optimized instance type, in MB/s.
Integer maximumIops
The maximum input/output storage operations per second for an EBS-optimized instance type.
SdkInternalList<T> attachments
Information about the attachment of the egress-only internet gateway.
String egressOnlyInternetGatewayId
The ID of the egress-only internet gateway.
SdkInternalList<T> tags
The tags assigned to the egress-only internet gateway.
String elasticGpuId
The ID of the Elastic Graphics accelerator.
String elasticGpuAssociationId
The ID of the association.
String elasticGpuAssociationState
The state of the association between the instance and the Elastic Graphics accelerator.
String elasticGpuAssociationTime
The time the Elastic Graphics accelerator was associated with the instance.
String status
The health status.
String elasticGpuId
The ID of the Elastic Graphics accelerator.
String availabilityZone
The Availability Zone in the which the Elastic Graphics accelerator resides.
String elasticGpuType
The type of Elastic Graphics accelerator.
ElasticGpuHealth elasticGpuHealth
The status of the Elastic Graphics accelerator.
String elasticGpuState
The state of the Elastic Graphics accelerator.
String instanceId
The ID of the instance to which the Elastic Graphics accelerator is attached.
SdkInternalList<T> tags
The tags assigned to the Elastic Graphics accelerator.
String type
The type of Elastic Graphics accelerator. For more information about the values to specify for Type
,
see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic
Compute Cloud User Guide for Windows Instances.
String type
The elastic GPU type.
String elasticInferenceAcceleratorArn
The Amazon Resource Name (ARN) of the elastic inference accelerator.
String elasticInferenceAcceleratorAssociationId
The ID of the association.
String elasticInferenceAcceleratorAssociationState
The state of the elastic inference accelerator.
Date elasticInferenceAcceleratorAssociationTime
The time at which the elastic inference accelerator is associated with an instance.
Boolean ebsEncryptionByDefault
The updated status of encryption by default.
String snapshotId
The ID of the snapshot.
SdkInternalList<T> fastSnapshotRestoreStateErrors
The errors.
SdkInternalList<T> availabilityZones
One or more Availability Zones. For example, us-east-2a
.
SdkInternalList<T> sourceSnapshotIds
The IDs of one or more snapshots. For example, snap-1234567890abcdef0
. You can specify a snapshot
that was shared with you from another AWS account.
SdkInternalList<T> successful
Information about the snapshots for which fast snapshot restores were successfully enabled.
SdkInternalList<T> unsuccessful
Information about the snapshots for which fast snapshot restores could not be enabled.
String availabilityZone
The Availability Zone.
EnableFastSnapshotRestoreStateError error
The error.
String snapshotId
The ID of the snapshot.
String availabilityZone
The Availability Zone.
String state
The state of fast snapshot restores.
String stateTransitionReason
The reason for the state transition. The possible values are as follows:
Client.UserInitiated
- The state successfully transitioned to enabling
or
disabling
.
Client.UserInitiated - Lifecycle state transition
- The state successfully transitioned to
optimizing
, enabled
, or disabled
.
String ownerId
The ID of the AWS account that enabled fast snapshot restores on the snapshot.
String ownerAlias
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
Date enablingTime
The time at which fast snapshot restores entered the enabling
state.
Date optimizingTime
The time at which fast snapshot restores entered the optimizing
state.
Date enabledTime
The time at which fast snapshot restores entered the enabled
state.
Date disablingTime
The time at which fast snapshot restores entered the disabling
state.
Date disabledTime
The time at which fast snapshot restores entered the disabled
state.
TransitGatewayPropagation propagation
Information about route propagation.
String gatewayId
The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.
String routeTableId
The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
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.
Boolean enabled
If this parameter is set to true
, the instance is enabled for AWS Nitro Enclaves; otherwise, it is
not enabled for AWS Nitro Enclaves.
Boolean enabled
To enable the instance for AWS Nitro Enclaves, set this parameter to true
.
String eventDescription
The description of the event.
String eventSubType
The event.
The following are the error
events:
iamFleetRoleInvalid
- The EC2 Fleet or Spot Fleet did not have the required permissions either to
launch or terminate an instance.
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 EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to
maintain the target number of running Spot Instances.
cancelled
- The EC2 Fleet or Spot Fleet request is canceled and has no running Spot Instances. The
EC2 Fleet or Spot Fleet will be deleted two days after its instances were terminated.
cancelled_running
- The EC2 Fleet or Spot Fleet request is canceled and does not launch additional
Spot Instances. Existing Spot Instances continue to run until they are interrupted or terminated.
cancelled_terminating
- The EC2 Fleet or Spot Fleet request is canceled and its Spot Instances are
terminating.
expired
- The EC2 Fleet or 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 EC2 Fleet or Spot Fleet request was accepted and is in
progress.
modify_successful
- The EC2 Fleet or Spot Fleet request was modified.
price_update
- The price for a launch configuration was adjusted because it was too high. This
change is permanent.
submitted
- The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to
launch the target number of Spot Instances.
The following are the instanceChange
events:
launched
- A request was fulfilled and a new instance was launched.
terminated
- An instance was terminated by the user.
The following are the Information
events:
launchSpecTemporarilyBlacklisted
- The configuration is not valid and several attempts to launch
instances have failed. For more information, see the description of the event.
launchSpecUnusable
- The price in a launch specification is not valid because it is below the Spot
price or the Spot price is above the On-Demand price.
fleetProgressHalted
- The price in every launch specification is not valid. A launch specification
might become valid if the Spot price changes.
String instanceId
The ID of the instance. This information is available only for instanceChange
events.
AnalysisComponent acl
The network ACL.
AnalysisAclRule aclRule
The network ACL rule.
String address
The IPv4 address, in CIDR notation.
SdkInternalList<T> addresses
The IPv4 addresses, in CIDR notation.
AnalysisComponent attachedTo
The resource to which the component is attached.
SdkInternalList<T> availabilityZones
The Availability Zones.
SdkInternalList<T> cidrs
The CIDR ranges.
AnalysisComponent component
The component.
AnalysisComponent customerGateway
The customer gateway.
AnalysisComponent destination
The destination.
AnalysisComponent destinationVpc
The destination VPC.
String direction
The direction. The following are possible values:
egress
ingress
String explanationCode
The explanation code.
AnalysisComponent ingressRouteTable
The route table.
AnalysisComponent internetGateway
The internet gateway.
String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
AnalysisLoadBalancerListener classicLoadBalancerListener
The listener for a Classic Load Balancer.
Integer loadBalancerListenerPort
The listener port of the load balancer.
AnalysisLoadBalancerTarget loadBalancerTarget
The target.
AnalysisComponent loadBalancerTargetGroup
The target group.
SdkInternalList<T> loadBalancerTargetGroups
The target groups.
Integer loadBalancerTargetPort
The target port.
AnalysisComponent elasticLoadBalancerListener
The load balancer listener.
String missingComponent
The missing component.
AnalysisComponent natGateway
The NAT gateway.
AnalysisComponent networkInterface
The network interface.
String packetField
The packet field.
AnalysisComponent vpcPeeringConnection
The VPC peering connection.
Integer port
The port.
SdkInternalList<T> portRanges
The port ranges.
AnalysisComponent prefixList
The prefix list.
SdkInternalList<T> protocols
The protocols.
AnalysisRouteTableRoute routeTableRoute
The route table route.
AnalysisComponent routeTable
The route table.
AnalysisComponent securityGroup
The security group.
AnalysisSecurityGroupRule securityGroupRule
The security group rule.
SdkInternalList<T> securityGroups
The security groups.
AnalysisComponent sourceVpc
The source VPC.
String state
The state.
AnalysisComponent subnet
The subnet.
AnalysisComponent subnetRouteTable
The route table for the subnet.
AnalysisComponent vpc
The component VPC.
AnalysisComponent vpcEndpoint
The VPC endpoint.
AnalysisComponent vpnConnection
The VPN connection.
AnalysisComponent vpnGateway
The VPN gateway.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
String certificateRevocationList
Information about the client certificate revocation list.
ClientCertificateRevocationListStatus status
The current state of the client certificate revocation list.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
String clientConfiguration
The contents of the Client VPN endpoint configuration file.
String clientToken
Token to enable idempotency for export image requests.
String description
A description of the image being exported. The maximum length is 255 characters.
String diskImageFormat
The disk image format.
String imageId
The ID of the image.
ExportTaskS3LocationRequest s3ExportLocation
Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
String roleName
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
SdkInternalList<T> tagSpecifications
The tags to apply to the export image task during creation.
String description
A description of the image being exported.
String diskImageFormat
The disk image format for the exported image.
String exportImageTaskId
The ID of the export image task.
String imageId
The ID of the image.
String roleName
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
String progress
The percent complete of the export image task.
ExportTaskS3Location s3ExportLocation
Information about the destination Amazon S3 bucket.
String status
The status of the export image task. The possible values are active
, completed
,
deleting
, and deleted
.
String statusMessage
The status message for the export image task.
SdkInternalList<T> tags
Any tags assigned to the export image task.
String description
A description of the image being exported.
String exportImageTaskId
The ID of the export image task.
String imageId
The ID of the image.
String progress
The percent complete of the export image task.
ExportTaskS3Location s3ExportLocation
Information about the destination Amazon S3 bucket.
String status
The status of the export image task. The possible values are active
, completed
,
deleting
, and deleted
.
String statusMessage
The status message for the export image task.
SdkInternalList<T> tags
Any tags assigned to the export image task.
String description
A description of the resource being exported.
String exportTaskId
The ID of the export task.
ExportToS3Task exportToS3Task
Information about the export task.
InstanceExportDetails instanceExportDetails
Information about the instance to export.
String state
The state of the export task.
String statusMessage
The status message related to the export task.
SdkInternalList<T> tags
The tags for the export task.
String containerFormat
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
String diskImageFormat
The format for the exported image.
String s3Bucket
The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP
permissions to the AWS account [email protected]
.
String s3Key
The encryption key for your S3 bucket.
String containerFormat
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
String diskImageFormat
The format for the exported image.
String s3Bucket
The Amazon 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 Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
String transitGatewayRouteTableId
The ID of the route table.
SdkInternalList<T> filters
One or more filters. The possible values are:
attachment.transit-gateway-attachment-id
- The id of the transit gateway attachment.
attachment.resource-id
- The resource id of the transit gateway attachment.
route-search.exact-match
- The exact match of the specified filter.
route-search.longest-prefix-match
- The longest prefix that matches the route.
route-search.subnet-of-match
- The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match
- The routes with a CIDR that encompass the CIDR filter. For example,
if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
10.0.1.0/30, then the result returns 10.0.1.0/29.
state
- The state of the route (active
| blackhole
).
transit-gateway-route-destination-cidr-block
- The CIDR range.
type
- The type of route (propagated
| static
).
String s3Bucket
The name of the S3 bucket.
String s3Location
The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
DeleteQueuedReservedInstancesError error
The error.
String reservedInstancesId
The ID of the Reserved Instance.
String name
The name of the filter. Filter names are case-sensitive.
SdkInternalList<T> values
The filter values. Filter values are case-sensitive.
String activityStatus
The progress of the EC2 Fleet. If there is an error, the status is error
. After all requests are
placed, the status is pending_fulfillment
. If the size of the EC2 Fleet is equal to or greater than
its target capacity, the status is fulfilled
. If the size of the EC2 Fleet is decreased, the status
is pending_termination
while instances are terminating.
Date createTime
The creation date and time of the EC2 Fleet.
String fleetId
The ID of the EC2 Fleet.
String fleetState
The state of the EC2 Fleet.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
String excessCapacityTerminationPolicy
Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Double fulfilledCapacity
The number of units fulfilled by this request compared to the set target capacity.
Double fulfilledOnDemandCapacity
The number of units fulfilled by this request compared to the set target On-Demand capacity.
SdkInternalList<T> launchTemplateConfigs
The launch template and overrides.
TargetCapacitySpecification targetCapacitySpecification
The number of units to request. You can choose to set the target capacity in terms of instances or a performance
characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type
is maintain
, you can specify a target capacity of 0 and add capacity later.
Boolean terminateInstancesWithExpiration
Indicates whether running instances should be terminated when the EC2 Fleet expires.
String type
The type of request. Indicates whether the EC2 Fleet only requests
the target capacity, or also
attempts to maintain
it. If you request a certain target capacity, EC2 Fleet only places the
required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit
requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2
Fleet places the required requests to meet this target capacity. It also automatically replenishes any
interrupted Spot Instances. Default: maintain
.
Date validFrom
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
Date validUntil
The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
Boolean replaceUnhealthyInstances
Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type
maintain
. For more information, see EC2
Fleet health checks in the Amazon EC2 User Guide.
SpotOptions spotOptions
The configuration of Spot Instances in an EC2 Fleet.
OnDemandOptions onDemandOptions
The allocation strategy of On-Demand Instances in an EC2 Fleet.
SdkInternalList<T> tags
The tags for an EC2 Fleet resource.
SdkInternalList<T> errors
Information about the instances that could not be launched by the fleet. Valid only when Type is set to
instant
.
SdkInternalList<T> instances
Information about the instances that were launched by the fleet. Valid only when Type is set to
instant
.
FleetLaunchTemplateSpecification launchTemplateSpecification
The launch template.
SdkInternalList<T> overrides
Any parameters that you specify override the same parameters in the launch template.
FleetLaunchTemplateSpecificationRequest launchTemplateSpecification
The launch template to use. You must specify either the launch template ID or launch template name in the request.
SdkInternalList<T> overrides
Any parameters that you specify override the same parameters in the launch template.
String instanceType
The instance type.
String maxPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance.
String subnetId
The ID of the subnet in which to launch the instances.
String availabilityZone
The Availability Zone in which to launch the instances.
Double weightedCapacity
The number of units provided by the specified instance type.
Double priority
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy
is set to prioritized
, EC2 Fleet uses priority to
determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy
is set to capacity-optimized-prioritized
, EC2 Fleet uses
priority on a best-effort basis to determine which launch template override to use first in fulfilling Spot
capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0
. The lower the number, the higher the priority. If no
number is set, the override has the lowest priority. You can set the same priority for different launch template
overrides.
PlacementResponse placement
The location where the instance launched, if applicable.
String instanceType
The instance type.
String maxPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance.
String subnetId
The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example,
subnet-1234abcdeexample1, subnet-0987cdef6example2
). A request of type instant
can have
only one subnet ID.
String availabilityZone
The Availability Zone in which to launch the instances.
Double weightedCapacity
The number of units provided by the specified instance type.
Double priority
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy
is set to prioritized
, EC2 Fleet uses priority to
determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy
is set to capacity-optimized-prioritized
, EC2 Fleet uses
priority on a best-effort basis to determine which launch template override to use first in fulfilling Spot
capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0
. The lower the number, the higher the priority. If no
number is set, the launch template override has the lowest priority. You can set the same priority for different
launch template overrides.
Placement placement
The location where the instance launched, if applicable.
String launchTemplateId
The ID of the launch template. If you specify the template ID, you can't specify the template name.
String launchTemplateName
The name of the launch template. If you specify the template name, you can't specify the template ID.
String version
The launch template version number, $Latest
, or $Default
. You must specify a value,
otherwise the request fails.
If the value is $Latest
, Amazon EC2 uses the latest version of the launch template.
If the value is $Default
, Amazon EC2 uses the default version of the launch template.
String launchTemplateId
The ID of the launch template. If you specify the template ID, you can't specify the template name.
String launchTemplateName
The name of the launch template. If you specify the template name, you can't specify the template ID.
String version
The launch template version number, $Latest
, or $Default
. You must specify a value,
otherwise the request fails.
If the value is $Latest
, Amazon EC2 uses the latest version of the launch template.
If the value is $Default
, Amazon EC2 uses the default version of the launch template.
String replacementStrategy
To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for
an existing Spot Instance in the fleet, specify launch
. Only available for fleets of type
maintain
.
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for both instances while they are running.
String replacementStrategy
The replacement strategy to use. Only available for fleets of type maintain
.
To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for
an existing Spot Instance in the fleet, specify launch
. You must specify a value, otherwise you get
an error.
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
FleetSpotCapacityRebalance capacityRebalance
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
FleetSpotCapacityRebalanceRequest capacityRebalance
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
Date creationTime
The date and time the flow log was created.
String deliverLogsErrorMessage
Information about the error that occurred. Rate limited
indicates that CloudWatch Logs throttling
has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups
that you can create. Access error
indicates that the IAM role associated with the flow log does not
have sufficient permissions to publish to CloudWatch Logs. Unknown error
indicates an internal
error.
String deliverLogsPermissionArn
The ARN of the IAM role that posts logs to CloudWatch Logs.
String deliverLogsStatus
The status of the logs delivery (SUCCESS
| FAILED
).
String flowLogId
The flow log ID.
String flowLogStatus
The status of the flow log (ACTIVE
).
String logGroupName
The name of the flow log group.
String resourceId
The ID of the resource on which the flow log was created.
String trafficType
The type of traffic captured for the flow log.
String logDestinationType
Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
String logDestination
Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.
String logFormat
The format of the flow log record.
SdkInternalList<T> tags
The tags for the flow log.
Integer maxAggregationInterval
The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
Valid Values: 60
| 600
String name
The name of the FPGA accelerator.
String manufacturer
The manufacturer of the FPGA accelerator.
Integer count
The count of FPGA accelerators for the instance type.
FpgaDeviceMemoryInfo memoryInfo
Describes the memory for the FPGA accelerator for the instance type.
Integer sizeInMiB
The size of the memory available to the FPGA accelerator, in MiB.
String fpgaImageId
The FPGA image identifier (AFI ID).
String fpgaImageGlobalId
The global FPGA image identifier (AGFI ID).
String name
The name of the AFI.
String description
The description of the AFI.
String shellVersion
The version of the AWS Shell that was used to create the bitstream.
PciId pciId
Information about the PCI bus.
FpgaImageState state
Information about the state of the AFI.
Date createTime
The date and time the AFI was created.
Date updateTime
The time of the most recent update to the AFI.
String ownerId
The AWS account ID of the AFI owner.
String ownerAlias
The alias of the AFI owner. Possible values include self
, amazon
, and
aws-marketplace
.
SdkInternalList<T> productCodes
The product codes for the AFI.
SdkInternalList<T> tags
Any tags assigned to the AFI.
Boolean publicValue
Indicates whether the AFI is public.
Boolean dataRetentionSupport
Indicates whether data retention support is enabled for the AFI.
String fpgaImageId
The ID of the AFI.
String name
The name of the AFI.
String description
The description of the AFI.
SdkInternalList<T> loadPermissions
The load permissions.
SdkInternalList<T> productCodes
The product codes.
String code
The state. The following are the possible values:
pending
- AFI bitstream generation is in progress.
available
- The AFI is available for use.
failed
- AFI bitstream generation failed.
unavailable
- The AFI is no longer available for use.
String message
If the state is failed
, this is the error message.
SdkInternalList<T> fpgas
Describes the FPGAs for the instance type.
Integer totalFpgaMemoryInMiB
The total memory of all FPGA accelerators for the instance type.
String certificateArn
The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.
SdkInternalList<T> associatedRoles
Information about the associated IAM roles.
SdkInternalList<T> ipv6CidrAssociations
Information about the IPv6 CIDR block associations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String capacityReservationId
The ID of the Capacity Reservation.
String nextToken
The token to use 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 receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
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 capacityReservationId
The ID of the Capacity Reservation.
String instanceType
The type of instance for which the Capacity Reservation reserves capacity.
Integer totalInstanceCount
The number of instances for which the Capacity Reservation reserves capacity.
Integer availableInstanceCount
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
String state
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active
- The Capacity Reservation is active and the capacity is available for your use.
expired
- The Capacity Reservation expired automatically at the date and time specified in your
request. The reserved capacity is no longer available for your use.
cancelled
- The Capacity Reservation was cancelled. The reserved capacity is no longer available for
your use.
pending
- The Capacity Reservation request was successful but the capacity provisioning is still
pending.
failed
- The Capacity Reservation request has failed. A request might fail due to invalid request
parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
SdkInternalList<T> instanceUsages
Information about the Capacity Reservation usage.
String poolId
The ID of the address pool.
SdkInternalList<T> filters
The filters. The following are the possible values:
coip-address-usage.allocation-id
coip-address-usage.aws-account-id
coip-address-usage.aws-service
coip-address-usage.co-ip
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
String coipPoolId
The ID of the customer-owned address pool.
SdkInternalList<T> coipAddressUsages
Information about the address usage.
String localGatewayRouteTableId
The ID of the local gateway route table.
String instanceFamily
The instance family.
InstanceFamilyCreditSpecification instanceFamilyCreditSpecification
The default credit option for CPU usage of the instance family.
String kmsKeyId
The Amazon Resource Name (ARN) of the default CMK for encryption by default.
Boolean ebsEncryptionByDefault
Indicates whether encryption by default is enabled.
String capacityReservationId
The ID of the Capacity Reservation.
String nextToken
The token to use 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 receive an error.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
SdkInternalList<T> capacityReservationGroups
Information about the resource groups to which the Capacity Reservation has been added.
SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts with which the reservation is associated.
String offeringId
The offering ID of the reservation.
String currencyCode
The currency in which the totalUpfrontPrice
and totalHourlyPrice
amounts are specified.
At this time, the only supported currency is USD
.
SdkInternalList<T> purchase
The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
String totalHourlyPrice
The potential total hourly price of the reservation per hour.
String totalUpfrontPrice
The potential total upfront price. This is billed immediately.
String instanceId
The ID of the instance.
ResponseLaunchTemplateData launchTemplateData
The instance data.
String prefixListId
The ID of the prefix list.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> prefixListAssociations
Information about the associations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String prefixListId
The ID of the prefix list.
Long targetVersion
The version of the prefix list for which to return the entries. The default is the current version.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> entries
Information about the prefix list entries.
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 instanceId
The ID of the Windows instance.
SdkInternalList<T> reservedInstanceIds
The IDs of the Convertible Reserved Instances to exchange.
SdkInternalList<T> targetConfigurations
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
String currencyCode
The currency of the transaction.
Boolean isValidExchange
If true
, the exchange is valid. If false
, the exchange cannot be completed.
Date outputReservedInstancesWillExpireAt
The new end date of the reservation term.
String paymentDue
The total true upfront charge for the exchange.
ReservationValue reservedInstanceValueRollup
The cost associated with the Reserved Instance.
SdkInternalList<T> reservedInstanceValueSet
The configuration of your Convertible Reserved Instances.
ReservationValue targetConfigurationValueRollup
The cost associated with the Reserved Instance.
SdkInternalList<T> targetConfigurationValueSet
The values of the target Convertible Reserved Instances.
String validationFailureReason
Describes the reason why the exchange cannot be completed.
String transitGatewayAttachmentId
The ID of the attachment.
SdkInternalList<T> filters
One or more filters. The possible values are:
transit-gateway-route-table-id
- The ID of the transit gateway route table.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayAttachmentPropagations
Information about the propagation route tables.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
SdkInternalList<T> filters
One or more filters. The possible values are:
resource-id
- The ID of the resource.
resource-type
- The type of resource. The valid value is: vpc
.
state
- The state of the subnet association. Valid values are associated
|
associating
| disassociated
| disassociating
.
subnet-id
- The ID of the subnet.
transit-gateway-attachment-id
- The id of the transit gateway attachment.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> multicastDomainAssociations
Information about the multicast domain associations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
SdkInternalList<T> filters
One or more filters. The possible values are:
attachment.resource-id
- The ID of the resource for the attachment.
attachment.resource-type
- The type of resource for the attachment. Valid values are
vpc
| vpn
| direct-connect-gateway
| peering
.
attachment.transit-gateway-attachment-id
- The ID of the attachment.
is-blackhole
- Whether traffic matching the route is blocked (true
| false
).
prefix-list-id
- The ID of the prefix list.
prefix-list-owner-id
- The ID of the owner of the prefix list.
state
- The state of the prefix list reference (pending
| available
|
modifying
| deleting
).
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayPrefixListReferences
Information about the prefix list references.
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 transitGatewayRouteTableId
The ID of the transit gateway route table.
SdkInternalList<T> filters
One or more filters. The possible values are:
resource-id
- The ID of the resource.
resource-type
- The resource type. Valid values are vpc
| vpn
|
direct-connect-gateway
| peering
| connect
.
transit-gateway-attachment-id
- The ID of the attachment.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> associations
Information about the associations.
String nextToken
The token to use to retrieve the next page of results. This value is null
when there are no more
results to return.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
SdkInternalList<T> filters
One or more filters. The possible values are:
resource-id
- The ID of the resource.
resource-type
- The resource type. Valid values are vpc
| vpn
|
direct-connect-gateway
| peering
| connect
.
transit-gateway-attachment-id
- The ID of the attachment.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> transitGatewayRouteTablePropagations
Information about the route table propagations.
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 name
The name of the GPU accelerator.
String manufacturer
The manufacturer of the GPU accelerator.
Integer count
The number of GPUs for the instance type.
GpuDeviceMemoryInfo memoryInfo
Describes the memory available to the GPU accelerator.
Integer sizeInMiB
The size of the memory available to the GPU accelerator, in MiB.
SdkInternalList<T> gpus
Describes the GPU accelerators for the instance type.
Integer totalGpuMemoryInMiB
The total size of the memory for the GPU accelerators for the instance type, in MiB.
Boolean configured
If this parameter is set to true
, your instance is enabled for hibernation; otherwise, it is not
enabled for hibernation.
Boolean configured
If you set this parameter to true
, your instance is enabled for hibernation.
Default: false
EventInformation eventInformation
Information about the event.
String eventType
The event type.
error
- An error with the Spot Fleet request.
fleetRequestChange
- A change in the status or configuration of the Spot Fleet request.
instanceChange
- An instance was launched or terminated.
Information
- An informational event.
Date timestamp
The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
EventInformation eventInformation
Information about the event.
String eventType
The event type.
Date timestamp
The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String autoPlacement
Whether auto-placement is on or off.
String availabilityZone
The Availability Zone of the Dedicated Host.
AvailableCapacity availableCapacity
Information about the instances running on the Dedicated Host.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String hostId
The ID of the Dedicated Host.
HostProperties hostProperties
The hardware specifications of the Dedicated Host.
String hostReservationId
The reservation ID of the Dedicated Host. This returns a null
response if the Dedicated Host doesn't
have an associated reservation.
SdkInternalList<T> instances
The IDs and instance type that are currently running on the Dedicated Host.
String state
The Dedicated Host's state.
Date allocationTime
The time that the Dedicated Host was allocated.
Date releaseTime
The time that the Dedicated Host was released.
SdkInternalList<T> tags
Any tags assigned to the Dedicated Host.
String hostRecovery
Indicates whether host recovery is enabled or disabled for the Dedicated Host.
String allowsMultipleInstanceTypes
Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value
is on
, the Dedicated Host supports multiple instance types in the instance family. If the value is
off
, the Dedicated Host supports a single instance type only.
String ownerId
The ID of the AWS account that owns the Dedicated Host.
String availabilityZoneId
The ID of the Availability Zone in which the Dedicated Host is allocated.
Boolean memberOfServiceLinkedResourceGroup
Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is
true
, the host is in a host resource group; otherwise, it is not.
String currencyCode
The currency of the offering.
Integer duration
The duration of the offering (in seconds).
String hourlyPrice
The hourly price of the offering.
String instanceFamily
The instance family of the offering.
String offeringId
The ID of the offering.
String paymentOption
The available payment option.
String upfrontPrice
The upfront price of the offering. Does not apply to No Upfront offerings.
Integer cores
The number of cores on the Dedicated Host.
String instanceType
The instance type supported by the Dedicated Host. For example, m5.large
. If the host supports
multiple instance types, no instanceType is returned.
String instanceFamily
The instance family supported by the Dedicated Host. For example, m5
.
Integer sockets
The number of sockets on the Dedicated Host.
Integer totalVCpus
The total number of vCPUs on the Dedicated Host.
Integer count
The number of Dedicated Hosts the reservation is associated with.
String currencyCode
The currency in which the upfrontPrice
and hourlyPrice
amounts are specified. At this
time, the only supported currency is USD
.
Integer duration
The length of the reservation's term, specified in seconds. Can be 31536000 (1 year)
|
94608000 (3 years)
.
Date end
The date and time that the reservation ends.
SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts associated with the reservation.
String hostReservationId
The ID of the reservation that specifies the associated Dedicated Hosts.
String hourlyPrice
The hourly price of the reservation.
String instanceFamily
The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
String offeringId
The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
String paymentOption
The payment option selected for this reservation.
Date start
The date and time that the reservation started.
String state
The state of the reservation.
String upfrontPrice
The upfront price of the reservation.
SdkInternalList<T> tags
Any tags assigned to the Dedicated Host Reservation.
String associationId
The ID of the association.
String instanceId
The ID of the instance.
IamInstanceProfile iamInstanceProfile
The IAM instance profile.
String state
The state of the association.
Date timestamp
The time the IAM instance profile was associated with the instance.
Date deadline
The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
String resource
The type of resource.
Boolean useLongIds
Indicates whether longer IDs (17-character IDs) are enabled for the resource.
String value
The IKE version.
String value
The IKE version.
String architecture
The architecture of the image.
String creationDate
The date and time the image was created.
String imageId
The ID of the AMI.
String imageLocation
The location of the AMI.
String imageType
The type of image.
Boolean publicValue
Indicates whether the image has public launch permissions. The value is true
if this image has
public launch permissions or false
if it has only implicit and explicit launch permissions.
String kernelId
The kernel associated with the image, if any. Only applicable for machine images.
String ownerId
The AWS account ID of the image owner.
String platform
This value is set to windows
for Windows AMIs; otherwise, it is blank.
String platformDetails
The platform details associated with the billing code of the AMI. For more information, see Obtaining Billing Information in the Amazon Elastic Compute Cloud User Guide.
String usageOperation
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
usageOperation
corresponds to the lineitem/Operation column on your AWS Cost and Usage Report and in the AWS Price List API.
For the list of UsageOperation
codes, see Platform Details
and Usage Operation Billing Codes in the Amazon Elastic Compute Cloud User Guide.
SdkInternalList<T> productCodes
Any product codes associated with the AMI.
String ramdiskId
The RAM disk associated with the image, if any. Only applicable for machine images.
String state
The current state of the AMI. If the state is available
, the image is successfully registered and
can be used to launch an instance.
SdkInternalList<T> blockDeviceMappings
Any block device mapping entries.
String description
The description of the AMI that was provided during image creation.
Boolean enaSupport
Specifies whether enhanced networking with ENA is enabled.
String hypervisor
The hypervisor type of the image.
String imageOwnerAlias
The AWS account alias (for example, amazon
, self
) or the AWS account ID of the AMI
owner.
String name
The name of the AMI that was provided during image creation.
String rootDeviceName
The device name of the root device volume (for example, /dev/sda1
).
String rootDeviceType
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
String sriovNetSupport
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason stateReason
The reason for the state change.
SdkInternalList<T> tags
Any tags assigned to the image.
String virtualizationType
The type of virtualization of the AMI.
SdkInternalList<T> blockDeviceMappings
The block device mapping entries.
String imageId
The ID of the AMI.
SdkInternalList<T> launchPermissions
The launch permissions.
SdkInternalList<T> productCodes
The product codes.
String description
A description for the AMI.
String kernelId
The kernel ID.
String ramdiskId
The RAM disk ID.
String sriovNetSupport
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
String description
The description of the disk image.
String deviceName
The block device mapping for the disk.
String format
The format of the disk image being imported.
Valid values: OVA
| VHD
| VHDX
| VMDK
| RAW
String snapshotId
The ID of the EBS snapshot to be used for importing the snapshot.
String url
The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)
UserBucket userBucket
The S3 bucket for the disk image.
String clientVpnEndpointId
The ID of the Client VPN endpoint to which the client certificate revocation list applies.
String certificateRevocationList
The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String licenseConfigurationArn
The ARN of a license configuration.
String licenseConfigurationArn
The ARN of a license configuration.
String architecture
The architecture of the virtual machine.
Valid values: i386
| x86_64
| arm64
ClientData clientData
The client-specific data.
String clientToken
The token to enable idempotency for VM import requests.
String description
A description string for the import image task.
SdkInternalList<T> diskContainers
Information about the disk containers.
Boolean encrypted
Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used
unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId
. For more
information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
String hypervisor
The target hypervisor platform.
Valid values: xen
String kmsKeyId
An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this
parameter is not specified, the default CMK for EBS is used. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the Region of the CMK, the
AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms
namespace, followed by the Region of the CMK,
the AWS account ID of the CMK owner, the key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the Region of the
CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even
though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric CMKs.
String licenseType
The license type to be used for the Amazon Machine Image (AMI) after importing.
By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify
AWS
to replace the source-system license with an AWS license, if appropriate. Specify
BYOL
to retain the source-system license, if appropriate.
To use BYOL
, you must have existing licenses with rights to use these licenses in a third party
cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
String platform
The operating system of the virtual machine.
Valid values: Windows
| Linux
String roleName
The name of the role to use when not using the default role, 'vmimport'.
SdkInternalList<T> licenseSpecifications
The ARNs of the license configurations.
SdkInternalList<T> tagSpecifications
The tags to apply to the import image task during creation.
String architecture
The architecture of the virtual machine.
String description
A description of the import task.
Boolean encrypted
Indicates whether the AMI is encrypted.
String hypervisor
The target hypervisor of the import task.
String imageId
The ID of the Amazon Machine Image (AMI) created by the import task.
String importTaskId
The task ID of the import image task.
String kmsKeyId
The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted AMI.
String licenseType
The license type of the virtual machine.
String platform
The operating system of the virtual machine.
String progress
The progress of the task.
SdkInternalList<T> snapshotDetails
Information about the snapshots.
String status
A brief status of the task.
String statusMessage
A detailed status message of the import task.
SdkInternalList<T> licenseSpecifications
The ARNs of the license configurations.
SdkInternalList<T> tags
Any tags assigned to the import image task.
String architecture
The architecture of the virtual machine.
Valid values: i386
| x86_64
| arm64
String description
A description of the import task.
Boolean encrypted
Indicates whether the image is encrypted.
String hypervisor
The target hypervisor for the import task.
Valid values: xen
String imageId
The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
String importTaskId
The ID of the import image task.
String kmsKeyId
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted image.
String licenseType
The license type of the virtual machine.
String platform
The description string for the import image task.
String progress
The percentage of progress of the import image task.
SdkInternalList<T> snapshotDetails
Information about the snapshots.
String status
A brief status for the import image task.
String statusMessage
A descriptive status message for the import image task.
SdkInternalList<T> tags
The tags for the import image task.
SdkInternalList<T> licenseSpecifications
The ARNs of the license configurations that are associated with the import image task.
String additionalInfo
Reserved.
String architecture
The architecture of the instance.
SdkInternalList<T> groupIds
The security group IDs.
SdkInternalList<T> groupNames
The security group names.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String instanceType
The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.
Boolean monitoring
Indicates whether monitoring is enabled.
Placement placement
The placement information for the instance.
String privateIpAddress
[EC2-VPC] An available IP address from the IP address range of the subnet.
String subnetId
[EC2-VPC] The ID of the subnet in which to launch the instance.
UserData userData
The Base64-encoded user data to make available to the instance.
String description
A description for the instance being imported.
SdkInternalList<T> diskImages
The disk image.
ImportInstanceLaunchSpecification launchSpecification
The launch specification.
String platform
The instance operating system.
ConversionTask conversionTask
Information about the conversion task.
String description
A description of the task.
String instanceId
The ID of the instance.
String platform
The instance operating system.
SdkInternalList<T> volumes
The volumes.
String availabilityZone
The Availability Zone where the resulting instance will reside.
Long bytesConverted
The number of bytes converted so far.
String description
A description of the task.
DiskImageDescription image
The image.
String status
The status of the import of this particular disk image.
String statusMessage
The status information or errors related to the disk image.
DiskImageVolumeDescription volume
The volume.
String keyName
A unique name for the key pair.
String publicKeyMaterial
The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
SdkInternalList<T> tagSpecifications
The tags to apply to the imported key pair.
String keyFingerprint
The MD5 public key fingerprint as specified in section 4 of RFC 4716.
String keyName
The key pair name you provided.
String keyPairId
The ID of the resulting key pair.
SdkInternalList<T> tags
The tags applied to the imported key pair.
ClientData clientData
The client-specific data.
String clientToken
Token to enable idempotency for VM import requests.
String description
The description string for the import snapshot task.
SnapshotDiskContainer diskContainer
Information about the disk container.
Boolean encrypted
Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is
used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId
. For
more information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
String kmsKeyId
An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this
parameter is not specified, the default CMK for EBS is used. If a KmsKeyId
is specified, the
Encrypted
flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the Region of the CMK, the
AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms
namespace, followed by the Region of the CMK,
the AWS account ID of the CMK owner, the key
namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the Region of the
CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even
though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric CMKs.
String roleName
The name of the role to use when not using the default role, 'vmimport'.
SdkInternalList<T> tagSpecifications
The tags to apply to the import snapshot task during creation.
String description
A description of the import snapshot task.
String importTaskId
The ID of the import snapshot task.
SnapshotTaskDetail snapshotTaskDetail
Information about the import snapshot task.
SdkInternalList<T> tags
Any tags assigned to 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.
SdkInternalList<T> tags
The tags for the import snapshot task.
String availabilityZone
The Availability Zone for the resulting EBS volume.
String description
A description of the volume.
DiskImageDetail image
The disk image.
VolumeDetail volume
The volume size.
ConversionTask conversionTask
Information about the conversion task.
String availabilityZone
The Availability Zone where the resulting volume will reside.
Long bytesConverted
The number of bytes converted so far.
String description
The description you provided when starting the import volume task.
DiskImageDescription image
The image.
DiskImageVolumeDescription volume
The volume.
SdkInternalList<T> accelerators
Describes the Inference accelerators for the instance type.
Integer amiLaunchIndex
The AMI launch index, which can be used to find this instance in the launch group.
String imageId
The ID of the AMI used to launch the instance.
String instanceId
The ID of the instance.
String instanceType
The instance type.
String kernelId
The kernel associated with this instance, if applicable.
String keyName
The name of the key pair, if this instance was launched with an associated key pair.
Date launchTime
The time the instance was launched.
Monitoring monitoring
The monitoring for the instance.
Placement placement
The location where the instance launched, if applicable.
String platform
The value is Windows
for Windows instances; otherwise blank.
String privateDnsName
(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the
Amazon EC2 network. This name is not available until the instance enters the running
state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
String privateIpAddress
The private IPv4 address assigned to the instance.
SdkInternalList<T> productCodes
The product codes attached to this instance, if applicable.
String publicDnsName
(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters
the running
state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your
VPC.
String publicIpAddress
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
String ramdiskId
The RAM disk associated with this instance, if applicable.
InstanceState state
The current state of the instance.
String stateTransitionReason
The reason for the most recent state transition. This might be an empty string.
String subnetId
[EC2-VPC] The ID of the subnet in which the instance is running.
String vpcId
[EC2-VPC] The ID of the VPC in which the instance is running.
String architecture
The architecture of the image.
SdkInternalList<T> blockDeviceMappings
Any block device mapping entries for the instance.
String clientToken
The idempotency token you provided when you launched the instance, if applicable.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Boolean enaSupport
Specifies whether enhanced networking with ENA is enabled.
String hypervisor
The hypervisor type of the instance. The value xen
is used for both Xen and Nitro hypervisors.
IamInstanceProfile iamInstanceProfile
The IAM instance profile associated with the instance, if applicable.
String instanceLifecycle
Indicates whether this is a Spot Instance or a Scheduled Instance.
SdkInternalList<T> elasticGpuAssociations
The Elastic GPU associated with the instance.
SdkInternalList<T> elasticInferenceAcceleratorAssociations
The elastic inference accelerator associated with the instance.
SdkInternalList<T> networkInterfaces
[EC2-VPC] The network interfaces for the instance.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
String rootDeviceName
The device name of the root device volume (for example, /dev/sda1
).
String rootDeviceType
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
SdkInternalList<T> securityGroups
The security groups for the instance.
Boolean sourceDestCheck
Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether
source/destination checking is enabled on the instance. A value of true
means that checking is
enabled, and false
means that checking is disabled. The value must be false
for the
instance to perform NAT. For more information, see NAT instances in the
Amazon VPC User Guide.
String spotInstanceRequestId
If the request is a Spot Instance request, the ID of the request.
String sriovNetSupport
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason stateReason
The reason for the most recent state transition.
SdkInternalList<T> tags
Any tags assigned to the instance.
String virtualizationType
The virtualization type of the instance.
CpuOptions cpuOptions
The CPU options for the instance.
String capacityReservationId
The ID of the Capacity Reservation.
CapacityReservationSpecificationResponse capacityReservationSpecification
Information about the Capacity Reservation targeting option.
HibernationOptions hibernationOptions
Indicates whether the instance is enabled for hibernation.
SdkInternalList<T> licenses
The license configurations.
InstanceMetadataOptionsResponse metadataOptions
The metadata options for the instance.
EnclaveOptions enclaveOptions
Indicates whether the instance is enabled for AWS Nitro Enclaves.
SdkInternalList<T> groups
The security groups associated with the instance.
SdkInternalList<T> blockDeviceMappings
The block device mapping of the instance.
Boolean disableApiTermination
If the value is true
, you can't terminate the instance through the Amazon EC2 console, CLI, or API;
otherwise, you can.
Boolean enaSupport
Indicates whether enhanced networking with ENA is enabled.
EnclaveOptions enclaveOptions
To enable the instance for AWS Nitro Enclaves, set this parameter to true
; otherwise, set it to
false
.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O.
String instanceId
The ID of the instance.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String instanceType
The instance type.
String kernelId
The kernel ID.
SdkInternalList<T> productCodes
A list of product codes.
String ramdiskId
The RAM disk ID.
String rootDeviceName
The device name of the root device volume (for example, /dev/sda1
).
Boolean sourceDestCheck
Indicates whether source/destination checking is enabled. A value of true
means that checking is
enabled, and false
means that checking is disabled. This value must be false
for a NAT
instance to perform NAT.
String sriovNetSupport
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
String userData
The user data.
String deviceName
The device name (for example, /dev/sdh
or xvdh
).
EbsInstanceBlockDevice ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String deviceName
The device name (for example, /dev/sdh
or xvdh
).
EbsInstanceBlockDeviceSpecification ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String noDevice
suppress the specified device included in the block device mapping.
String virtualName
The virtual device name.
Integer availableCapacity
The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.
String instanceType
The instance type supported by the Dedicated Host.
Integer totalCapacity
The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.
String ipv6Address
The IPv6 address.
String ipv6Address
The IPv6 address.
String marketType
The market type.
SpotMarketOptions spotOptions
The options for Spot Instances.
String httpTokens
The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
the default state is optional
.
If the state is optional
, you can choose to retrieve instance metadata with or without a signed
token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
role credentials are returned.
If the state is required
, you must send a signed token header with any instance metadata retrieval
requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
version 1.0 credentials are not available.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
String httpEndpoint
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
specified, the default state is enabled
.
If you specify a value of disabled
, you will not be able to access your instance metadata.
String state
The state of the metadata option changes.
pending
- The metadata options are being updated and the instance is not ready to process metadata
traffic with the new selection.
applied
- The metadata options have been successfully applied on the instance.
String httpTokens
The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
the default state is optional
.
If the state is optional
, you can choose to retrieve instance metadata with or without a signed
token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
role credentials are returned.
If the state is required
, you must send a signed token header with any instance metadata retrieval
requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the
version 1.0 credentials are not available.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
String httpEndpoint
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
specified, the default state is enabled
.
If you specify a value of disabled
, you will not be able to access your instance metadata.
String instanceId
The ID of the instance.
Monitoring monitoring
The monitoring for the instance.
InstanceNetworkInterfaceAssociation association
The association information for an Elastic IPv4 associated with the network interface.
InstanceNetworkInterfaceAttachment attachment
The network interface attachment.
String description
The description.
SdkInternalList<T> groups
One or more security groups.
SdkInternalList<T> ipv6Addresses
One or more IPv6 addresses associated with the network interface.
String macAddress
The MAC address.
String networkInterfaceId
The ID of the network interface.
String ownerId
The ID of the AWS account that created the network interface.
String privateDnsName
The private DNS name.
String privateIpAddress
The IPv4 address of the network interface within the subnet.
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses associated with the network interface.
Boolean sourceDestCheck
Indicates whether to validate network traffic to or from this network interface.
String status
The status of the network interface.
String subnetId
The ID of the subnet.
String vpcId
The ID of the VPC.
String interfaceType
Describes the type of network interface.
Valid values: interface
| efa
String carrierIp
The carrier IP address associated with the network interface.
String ipOwnerId
The ID of the owner of the Elastic IP address.
String publicDnsName
The public DNS name.
String publicIp
The public IP address or Elastic IP address bound to the network interface.
Date attachTime
The time stamp when the attachment initiated.
String attachmentId
The ID of the network interface attachment.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
Integer deviceIndex
The index of the device on the instance for the network interface attachment.
String status
The attachment state.
Integer networkCardIndex
The index of the network card.
Boolean associatePublicIpAddress
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can
only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an
existing one. You cannot specify more than one network interface in the request. If launching into a default
subnet, the default value is true
.
Boolean deleteOnTermination
If set to true
, the interface is deleted when the instance is terminated. You can specify
true
only if creating a new network interface when launching an instance.
String description
The description of the network interface. Applies only if creating a network interface when launching an instance.
Integer deviceIndex
The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
SdkInternalList<T> groups
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
Integer ipv6AddressCount
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
SdkInternalList<T> ipv6Addresses
One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
String networkInterfaceId
The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
String privateIpAddress
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
String subnetId
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
Boolean associateCarrierIpAddress
Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.
String interfaceType
The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa
. For more information, see Elastic Fabric Adapter in the Amazon
Elastic Compute Cloud User Guide.
If you are not creating an EFA, specify interface
or omit this parameter.
Valid values: interface
| efa
Integer networkCardIndex
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
InstanceNetworkInterfaceAssociation association
The association information for an Elastic IP address for the network interface.
Boolean primary
Indicates whether this IPv4 address is the primary private IP address of the network interface.
String privateDnsName
The private IPv4 DNS name.
String privateIpAddress
The private IPv4 address of the network interface.
Integer code
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
0
: pending
16
: running
32
: shutting-down
48
: terminated
64
: stopping
80
: stopped
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
String name
The current state of the instance.
InstanceState currentState
The current state of the instance.
String instanceId
The ID of the instance.
InstanceState previousState
The previous state of the instance.
String availabilityZone
The Availability Zone of the instance.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
SdkInternalList<T> events
Any scheduled events associated with the instance.
String instanceId
The ID of the instance.
InstanceState instanceState
The intended state of the instance. DescribeInstanceStatus requires that an instance be in the
running
state.
InstanceStatusSummary instanceStatus
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
InstanceStatusSummary systemStatus
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
String instanceEventId
The ID of the event.
String code
The event code.
String description
A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
Date notAfter
The latest scheduled end time for the event.
Date notBefore
The earliest scheduled start time for the event.
Date notBeforeDeadline
The deadline for starting the event.
SdkInternalList<T> details
The system instance health or application instance health.
String status
The status.
Long totalSizeInGB
The total size of the disks, in GB.
SdkInternalList<T> disks
Describes the disks that are available for the instance type.
String nvmeSupport
Indicates whether non-volatile memory express (NVMe) is supported for instance store.
SdkInternalList<T> instanceTagKeys
The registered tag keys.
Boolean includeAllTagsOfInstance
Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications.
true
indicates that all tag keys in the current Region are registered.
String instanceType
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
Boolean currentGeneration
Indicates whether the instance type is current generation.
Boolean freeTierEligible
Indicates whether the instance type is eligible for the free tier.
SdkInternalList<T> supportedUsageClasses
Indicates whether the instance type is offered for spot or On-Demand.
SdkInternalList<T> supportedRootDeviceTypes
The supported root device types.
SdkInternalList<T> supportedVirtualizationTypes
The supported virtualization types.
Boolean bareMetal
Indicates whether the instance is a bare metal instance type.
String hypervisor
The hypervisor for the instance type.
ProcessorInfo processorInfo
Describes the processor.
VCpuInfo vCpuInfo
Describes the vCPU configurations for the instance type.
MemoryInfo memoryInfo
Describes the memory for the instance type.
Boolean instanceStorageSupported
Indicates whether instance storage is supported.
InstanceStorageInfo instanceStorageInfo
Describes the instance storage for the instance type.
EbsInfo ebsInfo
Describes the Amazon EBS settings for the instance type.
NetworkInfo networkInfo
Describes the network settings for the instance type.
GpuInfo gpuInfo
Describes the GPU accelerator settings for the instance type.
FpgaInfo fpgaInfo
Describes the FPGA accelerator settings for the instance type.
PlacementGroupInfo placementGroupInfo
Describes the placement group settings for the instance type.
InferenceAcceleratorInfo inferenceAcceleratorInfo
Describes the Inference accelerator settings for the instance type.
Boolean hibernationSupported
Indicates whether On-Demand hibernation is supported.
Boolean burstablePerformanceSupported
Indicates whether the instance type is a burstable performance instance type.
Boolean dedicatedHostsSupported
Indicates whether Dedicated Hosts are supported on the instance type.
Boolean autoRecoverySupported
Indicates whether auto recovery is supported.
String instanceType
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
String locationType
The location type.
String location
The identifier for the location. This depends on the location type. For example, if the location type is
region
, the location is the Region code (for example, us-east-2
.)
SdkInternalList<T> attachments
Any VPCs attached to the internet gateway.
String internetGatewayId
The ID of the internet gateway.
String ownerId
The ID of the AWS account that owns the internet gateway.
SdkInternalList<T> tags
Any tags assigned to the internet gateway.
Integer fromPort
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1
indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
String ipProtocol
The IP protocol name (tcp
, udp
, icmp
, icmpv6
) or number (see
Protocol Numbers).
[VPC only] Use -1
to specify all protocols. When authorizing security group rules, specifying
-1
or a protocol number other than tcp
, udp
, icmp
, or
icmpv6
allows traffic on all ports, regardless of any port range you specify. For tcp
,
udp
, and icmp
, you must specify a port range. For icmpv6
, the port range
is optional; if you omit the port range, traffic for all types and codes is allowed.
SdkInternalList<T> ipv6Ranges
[VPC only] The IPv6 ranges.
SdkInternalList<T> prefixListIds
[VPC only] The prefix list IDs.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1
indicates
all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
SdkInternalList<T> userIdGroupPairs
The security group and AWS account ID pairs.
SdkInternalList<T> ipv4Ranges
The IPv4 ranges.
String cidrIp
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
String description
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String ipv6CidrBlock
The IPv6 CIDR block.
String poolId
The ID of the address pool.
String description
The description for the address pool.
SdkInternalList<T> poolCidrBlocks
The CIDR blocks for the address pool.
SdkInternalList<T> tags
Any tags for the address pool.
String cidrIpv6
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
String description
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
String keyFingerprint
The SHA-1 digest of the DER encoded private key.
String keyMaterial
An unencrypted PEM encoded RSA private key.
String keyName
The name of the key pair.
String keyPairId
The ID of the key pair.
SdkInternalList<T> tags
Any tags applied to the key pair.
String keyPairId
The ID 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.
String keyName
The name of the key pair.
SdkInternalList<T> tags
Any tags applied to the key pair.
SdkInternalList<T> add
The AWS account ID to add to the list of launch permissions for the AMI.
SdkInternalList<T> remove
The AWS account ID to remove from the list of launch permissions for the AMI.
String userData
The Base64-encoded user data for the instance.
String addressingType
Deprecated.
SdkInternalList<T> blockDeviceMappings
One or more block device mapping entries.
Boolean ebsOptimized
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String imageId
The ID of the AMI.
String instanceType
The instance type.
String kernelId
The ID of the kernel.
String keyName
The name of the key pair.
SdkInternalList<T> networkInterfaces
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotPlacement placement
The placement information for the instance.
String ramdiskId
The ID of the RAM disk.
String subnetId
The ID of the subnet in which to launch the instance.
SdkInternalList<T> allSecurityGroups
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
Boolean monitoringEnabled
SdkInternalList<T> securityGroups
One or more security group names.
String launchTemplateId
The ID of the launch template.
String launchTemplateName
The name of the launch template.
Date createTime
The time launch template was created.
String createdBy
The principal that created the launch template.
Long defaultVersionNumber
The version number of the default version of the launch template.
Long latestVersionNumber
The version number of the latest version of the launch template.
SdkInternalList<T> tags
The tags for the launch template.
FleetLaunchTemplateSpecification launchTemplateSpecification
The launch template.
FleetLaunchTemplateOverrides overrides
Any parameters that you specify override the same parameters in the launch template.
String deviceName
The device name.
String virtualName
The virtual device name (ephemeralN).
LaunchTemplateEbsBlockDevice ebs
Information about the block device for an EBS volume.
String noDevice
To omit the device from the block device mapping, specify an empty string.
String deviceName
The device name (for example, /dev/sdh or xvdh).
String virtualName
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
LaunchTemplateEbsBlockDeviceRequest ebs
Parameters used to automatically set up EBS volumes when the instance is launched.
String noDevice
To omit the device from the block device mapping, specify an empty string.
String capacityReservationPreference
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open
Capacity Reservation that has matching
attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs in On-Demand capacity.
CapacityReservationTarget capacityReservationTarget
Information about the target Capacity Reservation or Capacity Reservation group.
String capacityReservationPreference
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open
- The instance can run in any open
Capacity Reservation that has matching
attributes (instance type, platform, Availability Zone).
none
- The instance avoids running in a Capacity Reservation even if one is available. The instance
runs in On-Demand capacity.
CapacityReservationTargetResponse capacityReservationTarget
Information about the target Capacity Reservation or Capacity Reservation group.
FleetLaunchTemplateSpecification launchTemplateSpecification
The launch template.
SdkInternalList<T> overrides
Any parameters that you specify override the same parameters in the launch template.
Boolean encrypted
Indicates whether the EBS volume is encrypted.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Integer iops
The number of I/O operations per second (IOPS) that the volume supports.
String kmsKeyId
The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
String snapshotId
The ID of the snapshot.
Integer volumeSize
The size of the volume, in GiB.
String volumeType
The volume type.
Integer throughput
The throughput that the volume supports, in MiB/s.
Boolean encrypted
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Integer iops
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes,
this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits
for bursting.
The following are the supported values for each volume type:
gp3
: 3,000-16,000 IOPS
io1
: 100-64,000 IOPS
io2
: 100-64,000 IOPS
For io1
and io2
volumes, we guarantee 64,000 IOPS only for Instances
built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is supported for io1
, io2
, and gp3
volumes only. This
parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
String kmsKeyId
The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.
String snapshotId
The ID of the snapshot.
Integer volumeSize
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
gp2
and gp3
: 1-16,384
io1
and io2
: 4-16,384
st1
and sc1
: 125-16,384
standard
: 1-1,024
String volumeType
The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Integer throughput
The throughput to provision for a gp3
volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
Boolean enabled
If this parameter is set to true
, the instance is enabled for AWS Nitro Enclaves; otherwise, it is
not enabled for AWS Nitro Enclaves.
Boolean enabled
To enable the instance for AWS Nitro Enclaves, set this parameter to true
.
Boolean configured
If this parameter is set to true
, the instance is enabled for hibernation; otherwise, it is not
enabled for hibernation.
Boolean configured
If you set this parameter to true
, the instance is enabled for hibernation.
Default: false
String marketType
The market type.
LaunchTemplateSpotMarketOptions spotOptions
The options for Spot Instances.
String marketType
The market type.
LaunchTemplateSpotMarketOptionsRequest spotOptions
The options for Spot Instances.
String state
The state of the metadata option changes.
pending
- The metadata options are being updated and the instance is not ready to process metadata
traffic with the new selection.
applied
- The metadata options have been successfully applied on the instance.
String httpTokens
The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
the default state is optional
.
If the state is optional
, you can choose to retrieve instance metadata with or without a signed
token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
role credentials are returned.
If the state is required
, you must send a signed token header with any instance metadata retrieval
requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
version 1.0 credentials are not available.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
String httpEndpoint
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
specified, the default state is enabled
.
If you specify a value of disabled
, you will not be able to access your instance metadata.
String httpTokens
The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
the default state is optional
.
If the state is optional
, you can choose to retrieve instance metadata with or without a signed
token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
role credentials are returned.
If the state is required
, you must send a signed token header with any instance metadata retrieval
requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
version 1.0 credentials are not available.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
String httpEndpoint
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
specified, the default state is enabled
.
If you specify a value of disabled
, you will not be able to access your instance metadata.
Boolean associateCarrierIpAddress
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.
Boolean associatePublicIpAddress
Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
String description
A description for the network interface.
Integer deviceIndex
The device index for the network interface attachment.
SdkInternalList<T> groups
The IDs of one or more security groups.
String interfaceType
The type of network interface.
Integer ipv6AddressCount
The number of IPv6 addresses for the network interface.
SdkInternalList<T> ipv6Addresses
The IPv6 addresses for the network interface.
String networkInterfaceId
The ID of the network interface.
String privateIpAddress
The primary private IPv4 address of the network interface.
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses for the network interface.
String subnetId
The ID of the subnet for the network interface.
Integer networkCardIndex
The index of the network card.
Boolean associateCarrierIpAddress
Associates a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.
Boolean associatePublicIpAddress
Associates a public IPv4 address with eth0 for a new network interface.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
String description
A description for the network interface.
Integer deviceIndex
The device index for the network interface attachment.
SdkInternalList<T> groups
The IDs of one or more security groups.
String interfaceType
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa
. For more
information, see Elastic Fabric
Adapter in the Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA, specify interface
or omit this parameter.
Valid values: interface
| efa
Integer ipv6AddressCount
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
SdkInternalList<T> ipv6Addresses
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
String networkInterfaceId
The ID of the network interface.
String privateIpAddress
The primary private IPv4 address of the network interface.
SdkInternalList<T> privateIpAddresses
One or more private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses to assign to a network interface.
String subnetId
The ID of the subnet for the network interface.
Integer networkCardIndex
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
String licenseConfigurationArn
The Amazon Resource Name (ARN) of the license configuration.
String licenseConfigurationArn
The Amazon Resource Name (ARN) of the license configuration.
String instanceType
The instance type.
String spotPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance.
String subnetId
The ID of the subnet in which to launch the instances.
String availabilityZone
The Availability Zone in which to launch the instances.
Double weightedCapacity
The number of units provided by the specified instance type.
Double priority
The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy
is set to prioritized
, Spot Fleet uses priority to
determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy
is set to capacityOptimizedPrioritized
, Spot Fleet uses
priority on a best-effort basis to determine which launch template override to use first in fulfilling Spot
capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0
. The lower the number, the higher the priority. If no
number is set, the launch template override has the lowest priority. You can set the same priority for different
launch template overrides.
String availabilityZone
The Availability Zone of the instance.
String affinity
The affinity setting for the instance on the Dedicated Host.
String groupName
The name of the placement group for the instance.
String hostId
The ID of the Dedicated Host for the instance.
String tenancy
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of
dedicated
runs on single-tenant hardware.
String spreadDomain
Reserved for future use.
String hostResourceGroupArn
The ARN of the host resource group in which to launch the instances.
Integer partitionNumber
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to
partition
.
String availabilityZone
The Availability Zone for the instance.
String affinity
The affinity setting for an instance on a Dedicated Host.
String groupName
The name of the placement group for the instance.
String hostId
The ID of the Dedicated Host for the instance.
String tenancy
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
String spreadDomain
Reserved for future use.
String hostResourceGroupArn
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN,
omit the Tenancy parameter or set it to host
.
Integer partitionNumber
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to
partition
.
Boolean enabled
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Boolean enabled
Specify true
to enable detailed monitoring. Otherwise, basic monitoring is enabled.
String maxPrice
The maximum hourly price you're willing to pay for the Spot Instances.
String spotInstanceType
The Spot Instance request type.
Integer blockDurationMinutes
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
Date validUntil
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted.
String maxPrice
The maximum hourly price you're willing to pay for the Spot Instances.
String spotInstanceType
The Spot Instance request type.
Integer blockDurationMinutes
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
Date validUntil
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
String resourceType
The type of resource.
SdkInternalList<T> tags
The tags for the resource.
String resourceType
The type of resource to tag. Currently, the resource types that support tagging on creation are
instance
and volume
. To tag a resource after it has been created, see CreateTags.
SdkInternalList<T> tags
The tags to apply to the resource.
String launchTemplateId
The ID of the launch template.
String launchTemplateName
The name of the launch template.
Long versionNumber
The version number.
String versionDescription
The description for the version.
Date createTime
The time the version was created.
String createdBy
The principal that created the version.
Boolean defaultVersion
Indicates whether the version is the default version.
ResponseLaunchTemplateData launchTemplateData
Information about the launch template.
String licenseConfigurationArn
The Amazon Resource Name (ARN) of the license configuration.
String licenseConfigurationArn
The Amazon Resource Name (ARN) of the license configuration.
ClassicLoadBalancersConfig classicLoadBalancersConfig
The Classic Load Balancers.
TargetGroupsConfig targetGroupsConfig
The target groups.
SdkInternalList<T> add
The load permissions to add.
SdkInternalList<T> remove
The load permissions to remove.
String localGatewayId
The ID of the local gateway.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
String ownerId
The AWS account ID that owns the local gateway.
String state
The state of the local gateway.
SdkInternalList<T> tags
The tags assigned to the local gateway.
String destinationCidrBlock
The CIDR block used for destination matches.
String localGatewayVirtualInterfaceGroupId
The ID of the virtual interface group.
String type
The route type.
String state
The state of the route.
String localGatewayRouteTableId
The ID of the local gateway route table.
String localGatewayRouteTableArn
The Amazon Resource Name (ARN) of the local gateway route table.
String ownerId
The AWS account ID that owns the local gateway route.
String localGatewayRouteTableId
The ID of the local gateway route table.
String localGatewayRouteTableArn
The Amazon Resource Name (ARN) of the local gateway route table.
String localGatewayId
The ID of the local gateway.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
String ownerId
The AWS account ID that owns the local gateway route table.
String state
The state of the local gateway route table.
SdkInternalList<T> tags
The tags assigned to the local gateway route table.
String localGatewayRouteTableVirtualInterfaceGroupAssociationId
The ID of the association.
String localGatewayVirtualInterfaceGroupId
The ID of the virtual interface group.
String localGatewayId
The ID of the local gateway.
String localGatewayRouteTableId
The ID of the local gateway route table.
String localGatewayRouteTableArn
The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
String ownerId
The AWS account ID that owns the local gateway virtual interface group association.
String state
The state of the association.
SdkInternalList<T> tags
The tags assigned to the association.
String localGatewayRouteTableVpcAssociationId
The ID of the association.
String localGatewayRouteTableId
The ID of the local gateway route table.
String localGatewayRouteTableArn
The Amazon Resource Name (ARN) of the local gateway route table for the association.
String localGatewayId
The ID of the local gateway.
String vpcId
The ID of the VPC.
String ownerId
The AWS account ID that owns the local gateway route table for the association.
String state
The state of the association.
SdkInternalList<T> tags
The tags assigned to the association.
String localGatewayVirtualInterfaceId
The ID of the virtual interface.
String localGatewayId
The ID of the local gateway.
Integer vlan
The ID of the VLAN.
String localAddress
The local address.
String peerAddress
The peer address.
Integer localBgpAsn
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
Integer peerBgpAsn
The peer BGP ASN.
String ownerId
The AWS account ID that owns the local gateway virtual interface.
SdkInternalList<T> tags
The tags assigned to the virtual interface.
String localGatewayVirtualInterfaceGroupId
The ID of the virtual interface group.
SdkInternalList<T> localGatewayVirtualInterfaceIds
The IDs of the virtual interfaces.
String localGatewayId
The ID of the local gateway.
String ownerId
The AWS account ID that owns the local gateway virtual interface group.
SdkInternalList<T> tags
The tags assigned to the virtual interface group.
String prefixListId
The ID of the prefix list.
String addressFamily
The IP address version.
String state
The state of the prefix list.
String stateMessage
The state message.
String prefixListArn
The Amazon Resource Name (ARN) for the prefix list.
String prefixListName
The name of the prefix list.
Integer maxEntries
The maximum number of entries for the prefix list.
Long version
The version of the prefix list.
SdkInternalList<T> tags
The tags for the prefix list.
String ownerId
The ID of the owner of the prefix list.
Long sizeInMiB
The size of the memory, in MiB.
AddressAttribute address
Information about the Elastic IP address.
String groupName
The name of the Availability Zone group, Local Zone group, or Wavelength Zone group.
String optInStatus
Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The only valid value is
opted-in
. You must contact AWS Support to opt out of a Local Zone group, or Wavelength Zone group.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String capacityReservationId
The ID of the Capacity Reservation.
Integer instanceCount
The number of instances for which to reserve capacity.
Date endDate
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
expired
when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate
value if EndDateType
is limited
. Omit
EndDate
if EndDateType
is unlimited
.
String endDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide
an EndDate
value if EndDateType
is unlimited
.
limited
- The Capacity Reservation expires automatically at a specified date and time. You must
provide an EndDate
value if EndDateType
is limited
.
Boolean accept
Reserved. Capacity Reservations you have created are accepted by default.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String clientVpnEndpointId
The ID of the Client VPN endpoint to modify.
String serverCertificateArn
The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).
ConnectionLogOptions connectionLogOptions
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
DnsServersOptionsModifyStructure dnsServers
Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
Integer vpnPort
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443
| 1194
Default Value: 443
String description
A brief description of the Client VPN endpoint.
Boolean splitTunnel
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.
SdkInternalList<T> securityGroupIds
The IDs of one or more security groups to apply to the target network.
String vpcId
The ID of the VPC to associate with the Client VPN endpoint.
String selfServicePortal
Specify whether to enable the self-service portal for the Client VPN endpoint.
ClientConnectOptions clientConnectOptions
The options for managing connection authorization for new client connections.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
InstanceFamilyCreditSpecification instanceFamilyCreditSpecification
The default credit option for CPU usage of the instance family.
String kmsKeyId
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId
is
specified, the encrypted state must be true
.
You can specify the CMK using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric CMKs.
String kmsKeyId
The Amazon Resource Name (ARN) of the default CMK for encryption by default.
String excessCapacityTerminationPolicy
Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
SdkInternalList<T> launchTemplateConfigs
The launch template and overrides.
String fleetId
The ID of the EC2 Fleet.
TargetCapacitySpecificationRequest targetCapacitySpecification
The size of the EC2 Fleet.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String fpgaImageId
The ID of the AFI.
String attribute
The name of the attribute.
String operationType
The operation type.
SdkInternalList<T> userIds
The AWS account IDs. This parameter is valid only when modifying the loadPermission
attribute.
SdkInternalList<T> userGroups
The user groups. This parameter is valid only when modifying the loadPermission
attribute.
SdkInternalList<T> productCodes
The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when
modifying the productCodes
attribute.
LoadPermissionModifications loadPermission
The load permission for the AFI.
String description
A description for the AFI.
String name
A name for the AFI.
FpgaImageAttribute fpgaImageAttribute
Information about the attribute.
String autoPlacement
Specify whether to enable or disable auto-placement.
SdkInternalList<T> hostIds
The IDs of the Dedicated Hosts to modify.
String hostRecovery
Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.
String instanceType
Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.
If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
String instanceFamily
Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
SdkInternalList<T> successful
The IDs of the Dedicated Hosts that were successfully modified.
SdkInternalList<T> unsuccessful
The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
String principalArn
The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all
to
modify the ID format for all IAM users, IAM roles, and the root user of the account.
String resource
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
internet-gateway
| network-acl
| network-acl-association
|
network-interface
| network-interface-attachment
| prefix-list
|
route-table
| route-table-association
| security-group
|
subnet
| subnet-cidr-block-association
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
.
Alternatively, use the all-current
option to include all resource types that are currently within
their opt-in period for longer IDs.
Boolean useLongIds
Indicates whether the resource should use longer IDs (17-character IDs)
String resource
The type of resource: bundle
| conversion-task
| customer-gateway
|
dhcp-options
| elastic-ip-allocation
| elastic-ip-association
|
export-task
| flow-log
| image
| import-task
|
internet-gateway
| network-acl
| network-acl-association
|
network-interface
| network-interface-attachment
| prefix-list
|
route-table
| route-table-association
| security-group
|
subnet
| subnet-cidr-block-association
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
| vpc-peering-connection
|
vpn-connection
| vpn-gateway
.
Alternatively, use the all-current
option to include all resource types that are currently within
their opt-in period for longer IDs.
Boolean useLongIds
Indicate whether the resource should use longer IDs (17-character IDs).
String attribute
The name of the attribute to modify. The valid values are description
, launchPermission
, and productCodes
.
String description
A new description for the AMI.
String imageId
The ID of the AMI.
LaunchPermissionModifications launchPermission
A new launch permission for the AMI.
String operationType
The operation type. This parameter can be used only when the Attribute
parameter is
launchPermission
.
SdkInternalList<T> productCodes
The DevPay product codes. After you add a product code to an AMI, it can't be removed.
SdkInternalList<T> userGroups
The user groups. This parameter can be used only when the Attribute
parameter is
launchPermission
.
SdkInternalList<T> userIds
The AWS account IDs. This parameter can be used only when the Attribute
parameter is
launchPermission
.
String value
The value of the attribute being modified. This parameter can be used only when the Attribute
parameter is description
or productCodes
.
Boolean sourceDestCheck
Specifies whether source/destination checking is enabled. A value of true
means that checking is
enabled, and false
means that checking is disabled. This value must be false
for a NAT
instance to perform NAT.
String attribute
The name of the attribute.
SdkInternalList<T> blockDeviceMappings
Modifies the DeleteOnTermination
attribute for volumes that are currently attached. The volume must
be owned by the caller. If no value is specified for DeleteOnTermination
, the default is
true
and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the block device mapping when launching an instance in the Amazon EC2 User Guide.
Boolean disableApiTermination
If the value is true
, you can't terminate the instance using the Amazon EC2 console, CLI, or API;
otherwise, you can. You cannot use this parameter for Spot Instances.
Boolean ebsOptimized
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Boolean enaSupport
Set to true
to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
SdkInternalList<T> groups
[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.
String instanceId
The ID of the instance.
String instanceInitiatedShutdownBehavior
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String instanceType
Changes the instance type to the specified value. For more information, see Instance types in the
Amazon EC2 User Guide. If the instance type is not valid, the error returned is
InvalidInstanceAttributeValue
.
String kernel
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
String ramdisk
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
String sriovNetSupport
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the
instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
String userData
Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
String value
A new value for the attribute. Use only with the kernel
, ramdisk
, userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
attribute.
String instanceId
The ID of the instance to be modified.
CapacityReservationSpecification capacityReservationSpecification
Information about the Capacity Reservation targeting option.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String clientToken
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
SdkInternalList<T> instanceCreditSpecifications
Information about the credit option for CPU usage.
SdkInternalList<T> successfulInstanceCreditSpecifications
Information about the instances whose credit option for CPU usage was successfully modified.
SdkInternalList<T> unsuccessfulInstanceCreditSpecifications
Information about the instances whose credit option for CPU usage was not modified.
InstanceStatusEvent event
String instanceId
The ID of the instance.
String httpTokens
The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
the default state is optional
.
If the state is optional
, you can choose to retrieve instance metadata with or without a signed
token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
role credentials are returned.
If the state is required
, you must send a signed token header with any instance metadata retrieval
requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the
version 1.0 credentials are not available.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
String httpEndpoint
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the existing state is maintained.
If you specify a value of disabled
, you will not be able to access your instance metadata.
String instanceId
The ID of the instance.
InstanceMetadataOptionsResponse instanceMetadataOptions
The metadata options for the instance.
String affinity
The affinity setting for the instance.
String groupName
The name of the placement group in which to place the instance. For spread placement groups, the instance must
have a tenancy of default
. For cluster and partition placement groups, the instance must have a
tenancy of default
or dedicated
.
To remove an instance from a placement group, specify an empty string ("").
String hostId
The ID of the Dedicated Host with which to associate the instance.
String instanceId
The ID of the instance that you are modifying.
String tenancy
The tenancy for the instance.
Integer partitionNumber
Reserved for future use.
String hostResourceGroupArn
The ARN of the host resource group in which to place the instance.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
String launchTemplateId
The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
String launchTemplateName
The name of the launch template. You must specify either the launch template ID or launch template name in the request.
String defaultVersion
The version number of the launch template to set as the default version.
LaunchTemplate launchTemplate
Information about the launch template.
String prefixListId
The ID of the prefix list.
Long currentVersion
The current version of the prefix list.
String prefixListName
A name for the prefix list.
SdkInternalList<T> addEntries
One or more entries to add to the prefix list.
SdkInternalList<T> removeEntries
One or more entries to remove from the prefix list.
ManagedPrefixList prefixList
Information about the prefix list.
NetworkInterfaceAttachmentChanges attachment
Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
String description
A description for the network interface.
SdkInternalList<T> groups
Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
String networkInterfaceId
The ID of the network interface.
Boolean sourceDestCheck
Indicates whether source/destination checking is enabled. A value of true
means checking is enabled,
and false
means checking is disabled. This value must be false
for a NAT instance to
perform NAT. For more information, see NAT Instances in the
Amazon Virtual Private Cloud User Guide.
SdkInternalList<T> reservedInstancesIds
The IDs of the Reserved Instances to modify.
String clientToken
A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
SdkInternalList<T> targetConfigurations
The configuration settings for the Reserved Instances to modify.
String reservedInstancesModificationId
The ID for the modification.
String attribute
The snapshot attribute to modify. Only volume creation permissions can be modified.
CreateVolumePermissionModifications createVolumePermission
A JSON representation of the snapshot attribute modification.
SdkInternalList<T> groupNames
The group to modify for the snapshot.
String operationType
The type of operation to perform to the attribute.
String snapshotId
The ID of the snapshot.
SdkInternalList<T> userIds
The account ID to modify for the snapshot.
String excessCapacityTerminationPolicy
Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
SdkInternalList<T> launchTemplateConfigs
The launch template and overrides. You can only use this parameter if you specified a launch template (
LaunchTemplateConfigs
) in your Spot Fleet request. If you specified
LaunchSpecifications
in your Spot Fleet request, then omit this parameter.
String spotFleetRequestId
The ID of the Spot Fleet request.
Integer targetCapacity
The size of the fleet.
Integer onDemandTargetCapacity
The number of On-Demand Instances in the fleet.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
Boolean assignIpv6AddressOnCreation
Specify true
to indicate that network interfaces created in the specified subnet should be assigned
an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the
instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an
IPv6 address if it's created using version 2016-11-15
or later of the Amazon EC2 API.
Boolean mapPublicIpOnLaunch
Specify true
to indicate that network interfaces attached to instances created in the specified
subnet should be assigned a public IPv4 address.
String subnetId
The ID of the subnet.
Boolean mapCustomerOwnedIpOnLaunch
Specify true
to indicate that network interfaces attached to instances created in the specified
subnet should be assigned a customer-owned IPv4 address.
When this value is true
, you must specify the customer-owned IP pool using
CustomerOwnedIpv4Pool
.
String customerOwnedIpv4Pool
The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true
for MapCustomerOwnedIpOnLaunch
.
String trafficMirrorFilterId
The ID of the Traffic Mirror filter.
SdkInternalList<T> addNetworkServices
The network service, for example Amazon DNS, that you want to mirror.
SdkInternalList<T> removeNetworkServices
The network service, for example Amazon DNS, that you no longer want to mirror.
TrafficMirrorFilter trafficMirrorFilter
The Traffic Mirror filter that the network service is associated with.
String trafficMirrorFilterRuleId
The ID of the Traffic Mirror rule.
String trafficDirection
The type of traffic (ingress
| egress
) to assign to the rule.
Integer ruleNumber
The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
String ruleAction
The action to assign to the rule.
TrafficMirrorPortRangeRequest destinationPortRange
The destination ports that are associated with the Traffic Mirror rule.
TrafficMirrorPortRangeRequest sourcePortRange
The port range to assign to the Traffic Mirror rule.
Integer protocol
The protocol, for example TCP, to assign to the Traffic Mirror rule.
String destinationCidrBlock
The destination CIDR block to assign to the Traffic Mirror rule.
String sourceCidrBlock
The source CIDR block to assign to the Traffic Mirror rule.
String description
The description to assign to the Traffic Mirror rule.
SdkInternalList<T> removeFields
The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
TrafficMirrorFilterRule trafficMirrorFilterRule
Modifies a Traffic Mirror rule.
String trafficMirrorSessionId
The ID of the Traffic Mirror session.
String trafficMirrorTargetId
The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
String trafficMirrorFilterId
The ID of the Traffic Mirror filter.
Integer packetLength
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
Integer sessionNumber
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
Integer virtualNetworkId
The virtual network ID of the Traffic Mirror session.
String description
The description to assign to the Traffic Mirror session.
SdkInternalList<T> removeFields
The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
TrafficMirrorSession trafficMirrorSession
Information about the Traffic Mirror session.
SdkInternalList<T> addTransitGatewayCidrBlocks
Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
SdkInternalList<T> removeTransitGatewayCidrBlocks
Removes CIDR blocks for the transit gateway.
String vpnEcmpSupport
Enable or disable Equal Cost Multipath Protocol support.
String dnsSupport
Enable or disable DNS support.
String autoAcceptSharedAttachments
Enable or disable automatic acceptance of attachment requests.
String defaultRouteTableAssociation
Enable or disable automatic association with the default association route table.
String associationDefaultRouteTableId
The ID of the default association route table.
String defaultRouteTablePropagation
Enable or disable automatic propagation of routes to the default propagation route table.
String propagationDefaultRouteTableId
The ID of the default propagation route table.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
String prefixListId
The ID of the prefix list.
String transitGatewayAttachmentId
The ID of the attachment to which traffic is routed.
Boolean blackhole
Indicates whether to drop traffic that matches this route.
TransitGatewayPrefixListReference transitGatewayPrefixListReference
Information about the prefix list reference.
String transitGatewayId
The ID of the transit gateway.
String description
The description for the transit gateway.
ModifyTransitGatewayOptions options
The options to modify.
TransitGateway transitGateway
String transitGatewayAttachmentId
The ID of the attachment.
SdkInternalList<T> addSubnetIds
The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
SdkInternalList<T> removeSubnetIds
The IDs of one or more subnets to remove.
ModifyTransitGatewayVpcAttachmentRequestOptions options
The new VPC attachment options.
You cannot modify the IPv6 options.
String dnsSupport
Enable or disable DNS support. The default is enable
.
String ipv6Support
Enable or disable IPv6 support. The default is enable
.
String applianceModeSupport
Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses
the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is
disable
.
TransitGatewayVpcAttachment transitGatewayVpcAttachment
Information about the modified attachment.
String volumeId
The ID of the volume.
Integer size
The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2
and gp3
: 1-16,384
io1
and io2
: 4-16,384
st1
and sc1
: 125-16,384
standard
: 1-1,024
Default: If no size is specified, the existing size is retained.
String volumeType
The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: If no type is specified, the existing type is retained.
Integer iops
The target IOPS rate of the volume. This parameter is valid only for gp3
, io1
, and
io2
volumes.
The following are the supported values for each volume type:
gp3
: 3,000-16,000 IOPS
io1
: 100-64,000 IOPS
io2
: 100-64,000 IOPS
Default: If no IOPS value is specified, the existing value is retained.
Integer throughput
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3
volumes. The
maximum value is 1,000.
Default: If no throughput value is specified, the existing value is retained.
Valid Range: Minimum value of 125. Maximum value of 1000.
Boolean multiAttachEnabled
Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up
to 16
Nitro-based instances in the same Availability Zone. This parameter is supported with io1
and
io2
volumes only. For more information, see Amazon EBS Multi-Attach in
the Amazon Elastic Compute Cloud User Guide.
VolumeModification volumeModification
Information about the volume modification.
Boolean enableDnsHostnames
Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
Boolean enableDnsSupport
Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
String vpcId
The ID of the VPC.
String connectionNotificationId
The ID of the notification.
String connectionNotificationArn
The ARN for the SNS topic for the notification.
SdkInternalList<T> connectionEvents
One or more events for the endpoint. Valid values are Accept
, Connect
,
Delete
, and Reject
.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String vpcEndpointId
The ID of the endpoint.
Boolean resetPolicy
(Gateway endpoint) Specify true
to reset the policy document to the default policy. The default
policy allows full access to the service.
String policyDocument
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
SdkInternalList<T> addRouteTableIds
(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
SdkInternalList<T> removeRouteTableIds
(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
SdkInternalList<T> addSubnetIds
(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
SdkInternalList<T> removeSubnetIds
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
SdkInternalList<T> addSecurityGroupIds
(Interface endpoint) One or more security group IDs to associate with the network interface.
SdkInternalList<T> removeSecurityGroupIds
(Interface endpoint) One or more security group IDs to disassociate from the network interface.
Boolean privateDnsEnabled
(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String serviceId
The ID of the service.
String privateDnsName
(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
Boolean removePrivateDnsName
(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
Boolean acceptanceRequired
Indicates whether requests to create an endpoint to your service must be accepted.
SdkInternalList<T> addNetworkLoadBalancerArns
The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
SdkInternalList<T> removeNetworkLoadBalancerArns
The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
SdkInternalList<T> addGatewayLoadBalancerArns
The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
SdkInternalList<T> removeGatewayLoadBalancerArns
The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String serviceId
The ID of the service.
SdkInternalList<T> addAllowedPrincipals
The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).
SdkInternalList<T> removeAllowedPrincipals
The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
PeeringConnectionOptionsRequest accepterPeeringConnectionOptions
The VPC peering connection options for the accepter VPC.
PeeringConnectionOptionsRequest requesterPeeringConnectionOptions
The VPC peering connection options for the requester VPC.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
PeeringConnectionOptions accepterPeeringConnectionOptions
Information about the VPC peering connection options for the accepter VPC.
PeeringConnectionOptions requesterPeeringConnectionOptions
Information about the VPC peering connection options for the requester VPC.
Boolean returnValue
Returns true
if the request succeeds; otherwise, returns an error.
String vpnConnectionId
The ID of the Site-to-Site VPN connection.
String localIpv4NetworkCidr
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
String remoteIpv4NetworkCidr
The IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
String localIpv6NetworkCidr
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
String remoteIpv6NetworkCidr
The IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
VpnConnection vpnConnection
String vpnConnectionId
The ID of the VPN connection.
String transitGatewayId
The ID of the transit gateway.
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.
VpnConnection vpnConnection
VpnConnection vpnConnection
String vpnConnectionId
The ID of the AWS Site-to-Site VPN connection.
String vpnTunnelOutsideIpAddress
The external IP address of the VPN tunnel.
ModifyVpnTunnelOptionsSpecification tunnelOptions
The tunnel options to modify.
VpnConnection vpnConnection
String tunnelInsideCidr
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16
range. The following CIDR blocks are
reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
String tunnelInsideIpv6Cidr
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8
range.
String preSharedKey
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
Integer phase1LifetimeSeconds
The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
Integer phase2LifetimeSeconds
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for
Phase1LifetimeSeconds
.
Default: 3600
Integer rekeyMarginTimeSeconds
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection
performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for
RekeyFuzzPercentage
.
Constraints: A value between 60 and half of Phase2LifetimeSeconds
.
Default: 540
Integer rekeyFuzzPercentage
The percentage of the rekey window (determined by RekeyMarginTimeSeconds
) during which the rekey
time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
Integer replayWindowSize
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
Integer dPDTimeoutSeconds
The number of seconds after which a DPD timeout occurs.
Constraints: A value between 0 and 30.
Default: 30
String dPDTimeoutAction
The action to take after DPD timeout occurs. Specify restart
to restart the IKE initiation. Specify
clear
to end the IKE session.
Valid Values: clear
| none
| restart
Default: clear
SdkInternalList<T> phase1EncryptionAlgorithms
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128
| AES256
| AES128-GCM-16
| AES256-GCM-16
SdkInternalList<T> phase2EncryptionAlgorithms
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128
| AES256
| AES128-GCM-16
| AES256-GCM-16
SdkInternalList<T> phase1IntegrityAlgorithms
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1
| SHA2-256
| SHA2-384
| SHA2-512
SdkInternalList<T> phase2IntegrityAlgorithms
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1
| SHA2-256
| SHA2-384
| SHA2-512
SdkInternalList<T> phase1DHGroupNumbers
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2
| 14
| 15
| 16
| 17
|
18
| 19
| 20
| 21
| 22
| 23
|
24
SdkInternalList<T> phase2DHGroupNumbers
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2
| 5
| 14
| 15
| 16
|
17
| 18
| 19
| 20
| 21
| 22
|
23
| 24
SdkInternalList<T> iKEVersions
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1
| ikev2
String startupAction
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway
device must initiate the IKE negotiation and bring up the tunnel. Specify start
for AWS to initiate
the IKE negotiation.
Valid Values: add
| start
Default: add
String state
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
SdkInternalList<T> instanceIds
The IDs of the instances.
SdkInternalList<T> instanceMonitorings
The monitoring information.
String publicIp
The Elastic IP address.
Date createTime
The date and time the NAT gateway was created.
Date deleteTime
The date and time the NAT gateway was deleted, if applicable.
String failureCode
If the NAT gateway could not be created, specifies the error code for the failure. (
InsufficientFreeAddressesInSubnet
| Gateway.NotAttached
|
InvalidAllocationID.NotFound
| Resource.AlreadyAssociated
| InternalError
| InvalidSubnetID.NotFound
)
String failureMessage
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
SdkInternalList<T> natGatewayAddresses
Information about the IP addresses and network interface associated with the NAT gateway.
String natGatewayId
The ID of the NAT gateway.
ProvisionedBandwidth provisionedBandwidth
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String state
The state of the NAT gateway.
pending
: The NAT gateway is being created and is not ready to process traffic.
failed
: The NAT gateway could not be created. Check the failureCode
and
failureMessage
fields for the reason.
available
: The NAT gateway is able to process traffic. This status remains until you delete the NAT
gateway, and does not indicate the health of the NAT gateway.
deleting
: The NAT gateway is in the process of being terminated and may still be processing traffic.
deleted
: The NAT gateway has been terminated and is no longer processing traffic.
String subnetId
The ID of the subnet in which the NAT gateway is located.
String vpcId
The ID of the VPC in which the NAT gateway is located.
SdkInternalList<T> tags
The tags for the NAT gateway.
String allocationId
The allocation ID of the Elastic IP address that's associated with the NAT gateway.
String networkInterfaceId
The ID of the network interface associated with the NAT gateway.
String privateIp
The private IP address associated with the Elastic IP address.
String publicIp
The Elastic IP address associated with the NAT gateway.
SdkInternalList<T> associations
Any associations between the network ACL and one or more subnets
SdkInternalList<T> entries
One or more entries (rules) in the network ACL.
Boolean isDefault
Indicates whether this is the default network ACL for the VPC.
String networkAclId
The ID of the network ACL.
SdkInternalList<T> tags
Any tags assigned to the network ACL.
String vpcId
The ID of the VPC for the network ACL.
String ownerId
The ID of the AWS account that owns the network ACL.
String cidrBlock
The IPv4 network range to allow or deny, in CIDR notation.
Boolean egress
Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP type and code.
String ipv6CidrBlock
The IPv6 network range to allow or deny, in CIDR notation.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to.
String protocol
The protocol number. A value of "-1" means all protocols.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Integer ruleNumber
The rule number for the entry. ACL entries are processed in ascending order by rule number.
String networkPerformance
The network performance.
Integer maximumNetworkInterfaces
The maximum number of network interfaces for the instance type.
Integer maximumNetworkCards
The maximum number of physical network cards that can be allocated to the instance.
Integer defaultNetworkCardIndex
The index of the default network card, starting at 0.
SdkInternalList<T> networkCards
Describes the network cards for the instance type.
Integer ipv4AddressesPerInterface
The maximum number of IPv4 addresses per network interface.
Integer ipv6AddressesPerInterface
The maximum number of IPv6 addresses per network interface.
Boolean ipv6Supported
Indicates whether IPv6 is supported.
String enaSupport
Indicates whether Elastic Network Adapter (ENA) is supported.
Boolean efaSupported
Indicates whether Elastic Fabric Adapter (EFA) is supported.
String networkInsightsAnalysisId
The ID of the network insights analysis.
String networkInsightsAnalysisArn
The Amazon Resource Name (ARN) of the network insights analysis.
String networkInsightsPathId
The ID of the path.
SdkInternalList<T> filterInArns
The Amazon Resource Names (ARN) of the AWS resources that the path must traverse.
Date startDate
The time the analysis started.
String status
The status of the network insights analysis.
String statusMessage
The status message, if the status is failed
.
Boolean networkPathFound
Indicates whether the destination is reachable from the source.
SdkInternalList<T> forwardPathComponents
The components in the path from source to destination.
SdkInternalList<T> returnPathComponents
The components in the path from destination to source.
SdkInternalList<T> explanations
The explanations. For more information, see Reachability Analyzer explanation codes.
SdkInternalList<T> alternatePathHints
Potential intermediate components.
SdkInternalList<T> tags
The tags.
String networkInsightsPathId
The ID of the path.
String networkInsightsPathArn
The Amazon Resource Name (ARN) of the path.
Date createdDate
The time stamp when the path was created.
String source
The AWS resource that is the source of the path.
String destination
The AWS resource that is the destination of the path.
String sourceIp
The IP address of the AWS resource that is the source of the path.
String destinationIp
The IP address of the AWS resource that is the destination of the path.
String protocol
The protocol.
Integer destinationPort
The destination port.
SdkInternalList<T> tags
The tags associated with the path.
NetworkInterfaceAssociation association
The association information for an Elastic IP address (IPv4) associated with the network interface.
NetworkInterfaceAttachment attachment
The network interface attachment.
String availabilityZone
The Availability Zone.
String description
A description.
SdkInternalList<T> groups
Any security groups for the network interface.
String interfaceType
The type of network interface.
SdkInternalList<T> ipv6Addresses
The IPv6 addresses associated with the network interface.
String macAddress
The MAC address.
String networkInterfaceId
The ID of the network interface.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
String ownerId
The AWS account ID of the owner of the network interface.
String privateDnsName
The private DNS name.
String privateIpAddress
The IPv4 address of the network interface within the subnet.
SdkInternalList<T> privateIpAddresses
The private IPv4 addresses associated with the network interface.
String requesterId
The alias or AWS account ID of the principal or service that created the network interface.
Boolean requesterManaged
Indicates whether the network interface is being managed by AWS.
Boolean sourceDestCheck
Indicates whether traffic to or from the instance is validated.
String status
The status of the network interface.
String subnetId
The ID of the subnet.
SdkInternalList<T> tagSet
Any tags assigned to the network interface.
String vpcId
The ID of the VPC.
String allocationId
The allocation ID.
String associationId
The association ID.
String ipOwnerId
The ID of the Elastic IP address owner.
String publicDnsName
The public DNS name.
String publicIp
The address of the Elastic IP address bound to the network interface.
String customerOwnedIp
The customer-owned IP address associated with the network interface.
String carrierIp
The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
Date attachTime
The timestamp indicating when the attachment initiated.
String attachmentId
The ID of the network interface attachment.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
Integer deviceIndex
The device index of the network interface attachment on the instance.
Integer networkCardIndex
The index of the network card.
String instanceId
The ID of the instance.
String instanceOwnerId
The AWS account ID of the owner of the instance.
String status
The attachment state.
String ipv6Address
The IPv6 address.
String networkInterfacePermissionId
The ID of the network interface permission.
String networkInterfaceId
The ID of the network interface.
String awsAccountId
The AWS account ID.
String awsService
The AWS service.
String permission
The type of permission.
NetworkInterfacePermissionState permissionState
Information about the state of the permission.
NetworkInterfaceAssociation association
The association information for an Elastic IP address (IPv4) associated with the network interface.
Boolean primary
Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
String privateDnsName
The private DNS name.
String privateIpAddress
The private IPv4 address.
String allocationStrategy
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
lowest-price
, EC2 Fleet uses price to determine the order, launching the lowest price first. If you
specify prioritized
, EC2 Fleet uses the priority that you assigned to each launch template override,
launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to
lowest-price
.
CapacityReservationOptions capacityReservationOptions
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets
of type instant
.
Boolean singleInstanceType
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported
only for fleets of type instant
.
Boolean singleAvailabilityZone
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for
fleets of type instant
.
Integer minTargetCapacity
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
String maxTotalPrice
The maximum amount per hour for On-Demand Instances that you're willing to pay.
String allocationStrategy
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
lowest-price
, EC2 Fleet uses price to determine the order, launching the lowest price first. If you
specify prioritized
, EC2 Fleet uses the priority that you assigned to each launch template override,
launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to
lowest-price
.
CapacityReservationOptionsRequest capacityReservationOptions
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets
of type instant
.
Boolean singleInstanceType
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported
only for fleets of type instant
.
Boolean singleAvailabilityZone
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for
fleets of type instant
.
Integer minTargetCapacity
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
String maxTotalPrice
The maximum amount per hour for On-Demand Instances that you're willing to pay.
Integer sequenceNumber
The sequence number.
AnalysisAclRule aclRule
The network ACL rule.
AnalysisComponent component
The component.
AnalysisComponent destinationVpc
The destination VPC.
AnalysisPacketHeader outboundHeader
The outbound header.
AnalysisPacketHeader inboundHeader
The inbound header.
AnalysisRouteTableRoute routeTableRoute
The route table route.
AnalysisSecurityGroupRule securityGroupRule
The security group rule.
AnalysisComponent sourceVpc
The source VPC.
AnalysisComponent subnet
The subnet.
AnalysisComponent vpc
The component VPC.
Boolean allowDnsResolutionFromRemoteVpc
If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.
Boolean allowEgressFromLocalClassicLinkToRemoteVpc
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
Boolean allowEgressFromLocalVpcToRemoteClassicLink
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
Boolean allowDnsResolutionFromRemoteVpc
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
Boolean allowEgressFromLocalClassicLinkToRemoteVpc
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
Boolean allowEgressFromLocalVpcToRemoteClassicLink
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
Integer value
The Diffie-Hellmann group number.
Integer value
The Diffie-Hellmann group number.
String value
The value for the encryption algorithm.
String value
The value for the encryption algorithm.
String value
The value for the integrity algorithm.
String value
The value for the integrity algorithm.
Integer value
The Diffie-Hellmann group number.
Integer value
The Diffie-Hellmann group number.
String value
The encryption algorithm.
String value
The encryption algorithm.
String value
The integrity algorithm.
String value
The integrity algorithm.
String availabilityZone
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet.
String affinity
The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
String groupName
The name of the placement group the instance is in.
Integer partitionNumber
The number of the partition the instance is in. Valid only if the placement group strategy is set to
partition
.
This parameter is not supported by CreateFleet.
String hostId
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
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.
This parameter is not supported by CreateFleet.
String spreadDomain
Reserved for future use.
This parameter is not supported by CreateFleet.
String hostResourceGroupArn
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN,
omit the Tenancy parameter or set it to host
.
This parameter is not supported by CreateFleet.
String groupName
The name of the placement group.
String state
The state of the placement group.
String strategy
The placement strategy.
Integer partitionCount
The number of partitions. Valid only if strategy is set to partition
.
String groupId
The ID of the placement group.
SdkInternalList<T> tags
Any tags applied to the placement group.
SdkInternalList<T> supportedStrategies
The supported placement group types.
String groupName
The name of the placement group that the instance is in.
String cidr
The CIDR block.
SdkInternalList<T> cidrs
The IP address range of the AWS service.
String prefixListId
The ID of the prefix.
String prefixListName
The name of the prefix.
Boolean active
The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
String currencyCode
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
USD
.
Double price
The fixed price for the term.
Long term
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
String currencyCode
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
USD
.
Double price
The fixed price for the term.
Long term
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
String arn
PrincipalIdFormatARN description
SdkInternalList<T> statuses
PrincipalIdFormatStatuses description
String privateDnsName
The private DNS name assigned to the VPC endpoint service.
String state
The verification state of the VPC endpoint service.
>Consumers of the endpoint service can use the private name only when the state is verified
.
String type
The endpoint service verification type, for example TXT.
String value
The value the service provider adds to the private DNS name domain record before verification.
String name
The name of the record subdomain the service provider needs to create. The service provider adds the
value
text to the name
.
SdkInternalList<T> supportedArchitectures
The architectures supported by the instance type.
Double sustainedClockSpeedInGhz
The speed of the processor, in GHz.
String gatewayId
The ID of the virtual private gateway.
String cidr
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've brought to this or another Region.
CidrAuthorizationContext cidrAuthorizationContext
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Boolean publiclyAdvertisable
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
String description
A description for the address range and the address pool.
SdkInternalList<T> poolTagSpecifications
The tags to apply to the address pool.
ByoipCidr byoipCidr
Information about the address range.
Date provisionTime
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String provisioned
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
Date requestTime
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String requested
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String status
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
String poolId
The ID of the address pool.
String description
A description of the address pool.
SdkInternalList<T> poolAddressRanges
The address ranges.
Integer totalAddressCount
The total number of addresses.
Integer totalAvailableAddressCount
The total number of available addresses.
String networkBorderGroup
The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises public IP addresses.
SdkInternalList<T> tags
Any tags for the address pool.
String firstAddress
The first IP address in the range.
String lastAddress
The last IP address in the range.
Integer addressCount
The number of addresses in the range.
Integer availableAddressCount
The number of available addresses in the range.
String currencyCode
The currency in which the UpfrontPrice
and HourlyPrice
amounts are specified. At this
time, the only supported currency is USD
.
Integer duration
The duration of the reservation's term in seconds.
SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts associated with the reservation.
String hostReservationId
The ID of the reservation.
String hourlyPrice
The hourly price of the reservation per hour.
String instanceFamily
The instance family on the Dedicated Host that the reservation can be associated with.
String paymentOption
The payment option for the reservation.
String upfrontPrice
The upfront price of the reservation.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String currencyCode
The currency in which the totalUpfrontPrice
, LimitPrice
, and
totalHourlyPrice
amounts are specified. At this time, the only supported currency is
USD
.
SdkInternalList<T> hostIdSet
The IDs of the Dedicated Hosts with which the reservation will be associated.
String limitPrice
The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's
upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit,
the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the
purchase. At this time, the only supported currency is USD
. For example, to indicate a limit price
of USD 100, specify 100.00.
String offeringId
The ID of the offering.
SdkInternalList<T> tagSpecifications
The tags to apply to the Dedicated Host Reservation during purchase.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
String currencyCode
The currency in which the totalUpfrontPrice
and totalHourlyPrice
amounts are specified.
At this time, the only supported currency is USD
.
SdkInternalList<T> purchase
Describes the details of the purchase.
String totalHourlyPrice
The total hourly price of the reservation calculated per hour.
String totalUpfrontPrice
The total amount charged to your account when you purchase the reservation.
Integer instanceCount
The number of Reserved Instances to purchase.
String reservedInstancesOfferingId
The ID of the Reserved Instance offering to purchase.
ReservedInstanceLimitPrice limitPrice
Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
Date purchaseTime
The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
String reservedInstancesId
The IDs of the purchased Reserved Instances.
String clientToken
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
SdkInternalList<T> purchaseRequests
The purchase requests.
SdkInternalList<T> scheduledInstanceSet
Information about the Scheduled Instances.
SdkInternalList<T> instanceIds
The instance IDs.
String imageLocation
The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the
aws-exec-read
canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For
more information, see Canned ACLs in the
Amazon S3 Service Developer Guide.
String architecture
The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386
. For instance store-backed AMIs, the architecture
specified in the manifest file.
SdkInternalList<T> blockDeviceMappings
The block device mapping entries.
If you specify an EBS volume using the ID of an EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
String description
A description for your AMI.
Boolean enaSupport
Set to true
to enable enhanced networking with ENA for the AMI and any instances that you launch
from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
String kernelId
The ID of the kernel.
String name
A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
SdkInternalList<T> billingProducts
The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.
String ramdiskId
The ID of the RAM disk.
String rootDeviceName
The device name of the root device volume (for example, /dev/sda1
).
String sriovNetSupport
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the
AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport
at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
String virtualizationType
The type of virtualization (hvm
| paravirtual
).
Default: paravirtual
String imageId
The ID of the newly registered AMI.
RegisterInstanceTagAttributeRequest instanceTagAttribute
Information about the tag keys to register.
InstanceTagNotificationAttribute instanceTagAttribute
The resulting set of tag keys.
Boolean includeAllTagsOfInstance
Indicates whether to register all tag keys in the current Region. Specify true
to register all tag
keys.
SdkInternalList<T> instanceTagKeys
The tag keys to register.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
SdkInternalList<T> networkInterfaceIds
The group members' network interface IDs to register with the transit gateway multicast group.
TransitGatewayMulticastRegisteredGroupMembers registeredMulticastGroupMembers
Information about the registered transit gateway multicast group members.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
SdkInternalList<T> networkInterfaceIds
The group sources' network interface IDs to register with the transit gateway multicast group.
TransitGatewayMulticastRegisteredGroupSources registeredMulticastGroupSources
Information about the transit gateway multicast group sources.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String transitGatewayAttachmentId
The ID of the transit gateway attachment.
SdkInternalList<T> subnetIds
The IDs of the subnets to associate with the transit gateway multicast domain.
TransitGatewayMulticastDomainAssociations associations
String transitGatewayAttachmentId
The ID of the transit gateway peering attachment.
TransitGatewayPeeringAttachment transitGatewayPeeringAttachment
The transit gateway peering attachment.
String transitGatewayAttachmentId
The ID of the attachment.
TransitGatewayVpcAttachment transitGatewayVpcAttachment
Information about the attachment.
String serviceId
The ID of the service.
SdkInternalList<T> vpcEndpointIds
The IDs of one or more VPC endpoints.
SdkInternalList<T> unsuccessful
Information about the endpoints that were not rejected, if applicable.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String allocationId
[EC2-VPC] The allocation ID. Required for EC2-VPC.
String publicIp
[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
String networkBorderGroup
The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound
error.
For more information, see Error Codes.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will
receive an InvalidParameterCombination
error. For more information, see Error Codes.
SdkInternalList<T> hostIds
The IDs of the Dedicated Hosts to release.
SdkInternalList<T> successful
The IDs of the Dedicated Hosts that were successfully released.
SdkInternalList<T> unsuccessful
The IDs of the Dedicated Hosts that could not be released, including an error message.
String cidr
The CIDR block.
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String associationId
The ID of the existing IAM instance profile association.
IamInstanceProfileAssociation iamInstanceProfileAssociation
Information about the IAM instance profile association.
String newAssociationId
The ID of the new association.
String cidrBlock
The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24
).
Boolean egress
Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
IcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
String ipv6CidrBlock
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64
).
String networkAclId
The ID of the ACL.
PortRange portRange
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
String protocol
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Integer ruleNumber
The rule number of the entry to replace.
String destinationCidrBlock
The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
String destinationIpv6CidrBlock
The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
String destinationPrefixListId
The ID of the prefix list for the route.
String vpcEndpointId
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
String egressOnlyInternetGatewayId
[IPv6 traffic only] The ID of an egress-only internet gateway.
String gatewayId
The ID of an internet gateway or virtual private gateway.
String instanceId
The ID of a NAT instance in your VPC.
Boolean localTarget
Specifies whether to reset the local route to its default target (local
).
String natGatewayId
[IPv4 traffic only] The ID of a NAT gateway.
String transitGatewayId
The ID of a transit gateway.
String localGatewayId
The ID of the local gateway.
String carrierGatewayId
[IPv4 traffic only] The ID of a carrier gateway.
String networkInterfaceId
The ID of a network interface.
String routeTableId
The ID of the route table.
String vpcPeeringConnectionId
The ID of a VPC peering connection.
String newAssociationId
The ID of the new association.
RouteTableAssociationState associationState
The state of the association.
String destinationCidrBlock
The CIDR range used for the destination match. Routing decisions are based on the most specific match.
String transitGatewayRouteTableId
The ID of the route table.
String transitGatewayAttachmentId
The ID of the attachment.
Boolean blackhole
Indicates whether traffic matching this route is to be dropped.
TransitGatewayRoute route
Information about the modified route.
String description
Descriptive text about the health state of your instance.
Date endTime
The time at which the reported instance health state ended.
SdkInternalList<T> instances
The instances.
SdkInternalList<T> reasonCodes
The reason codes that describe the health state of your instance.
instance-stuck-in-state
: My instance is stuck in a state.
unresponsive
: My instance is unresponsive.
not-accepting-credentials
: My instance is not accepting my credentials.
password-not-available
: A password is not available for my instance.
performance-network
: My instance is experiencing performance problems that I believe are network
related.
performance-instance-store
: My instance is experiencing performance problems that I believe are
related to the instance stores.
performance-ebs-volume
: My instance is experiencing performance problems that I believe are related
to an EBS volume.
performance-other
: My instance is experiencing performance problems.
other
: [explain using the description parameter]
Date startTime
The time at which the reported instance health state began.
String status
The status of all instances listed.
String kernelId
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
LaunchTemplateIamInstanceProfileSpecificationRequest iamInstanceProfile
The name or Amazon Resource Name (ARN) of an IAM instance profile.
SdkInternalList<T> blockDeviceMappings
The block device mapping.
SdkInternalList<T> networkInterfaces
One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
String imageId
The ID of the AMI.
String instanceType
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
String keyName
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
LaunchTemplatesMonitoringRequest monitoring
The monitoring for the instance.
LaunchTemplatePlacementRequest placement
The placement for the instance.
String ramDiskId
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.
Boolean disableApiTermination
If you set this parameter to true
, you can't terminate the instance using the Amazon EC2 console,
CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior
to
terminate
, you can terminate the instance by running the shutdown command from the instance.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
String userData
The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).
SdkInternalList<T> tagSpecifications
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
SdkInternalList<T> elasticGpuSpecifications
An elastic GPU to associate with the instance.
SdkInternalList<T> elasticInferenceAccelerators
The elastic inference accelerator for the instance.
SdkInternalList<T> securityGroupIds
One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
SdkInternalList<T> securityGroups
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
LaunchTemplateInstanceMarketOptionsRequest instanceMarketOptions
The market (purchasing) option for the instances.
CreditSpecificationRequest creditSpecification
The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.
LaunchTemplateCpuOptionsRequest cpuOptions
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.
LaunchTemplateCapacityReservationSpecificationRequest capacityReservationSpecification
The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity
Reservation preference defaults to open
, which enables it to run in any open Capacity Reservation
that has matching attributes (instance type, platform, Availability Zone).
SdkInternalList<T> licenseSpecifications
The license configurations.
LaunchTemplateHibernationOptionsRequest hibernationOptions
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
LaunchTemplateInstanceMetadataOptionsRequest metadataOptions
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.
LaunchTemplateEnclaveOptionsRequest enclaveOptions
Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide.
You can't enable AWS Nitro Enclaves and hibernation on the same instance.
SpotFleetRequestConfigData spotFleetRequestConfig
The configuration for the Spot Fleet request.
String spotFleetRequestId
The ID of the Spot Fleet request.
String availabilityZoneGroup
The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
Integer blockDurationMinutes
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
You can't specify an Availability Zone group or a launch group if you specify a duration.
New accounts or accounts with no previous billing history with AWS are not eligible for Spot Instances with a defined duration (also known as Spot blocks).
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.
Integer instanceCount
The maximum number of Spot Instances to launch.
Default: 1
String launchGroup
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
LaunchSpecification launchSpecification
The launch specification.
String spotPrice
The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
String type
The Spot Instance request type.
Default: one-time
Date validFrom
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
Date validUntil
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil
date and time is reached.
Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the
ValidUntil
date and time is reached. By default, the request is valid for 7 days from the date the
request was created.
SdkInternalList<T> tagSpecifications
The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType
must be spot-instances-request
, otherwise the Spot Instance request fails. To tag the Spot Instance
request after it has been created, see CreateTags.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
SdkInternalList<T> spotInstanceRequests
One or more Spot Instance requests.
SdkInternalList<T> groups
[EC2-Classic only] The security groups.
SdkInternalList<T> instances
The instances.
String ownerId
The ID of the AWS account that owns the reservation.
String requesterId
The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).
String reservationId
The ID of the reservation.
SdkInternalList<T> groupNames
One or more security group names.
String hourlyPrice
The hourly rate of the reservation.
String remainingTotalValue
The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
String remainingUpfrontValue
The remaining upfront cost of the reservation.
ReservationValue reservationValue
The total value of the Convertible Reserved Instance that you are exchanging.
String reservedInstanceId
The ID of the Convertible Reserved Instance that you are exchanging.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
Long duration
The duration of the Reserved Instance, in seconds.
Date end
The time when the Reserved Instance expires.
Float fixedPrice
The purchase price of the Reserved Instance.
Integer instanceCount
The number of reservations purchased.
String instanceType
The instance type on which the Reserved Instance can be used.
String productDescription
The Reserved Instance product platform description.
String reservedInstancesId
The ID of the Reserved Instance.
Date start
The date and time the Reserved Instance started.
String state
The state of the Reserved Instance purchase.
Float usagePrice
The usage price of the Reserved Instance, per hour.
String currencyCode
The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the
only supported currency is USD
.
String instanceTenancy
The tenancy of the instance.
String offeringClass
The offering class of the Reserved Instance.
String offeringType
The Reserved Instance offering type.
SdkInternalList<T> recurringCharges
The recurring charge tag assigned to the resource.
String scope
The scope of the Reserved Instance.
SdkInternalList<T> tags
Any tags assigned to the resource.
String availabilityZone
The Availability Zone for the modified Reserved Instances.
Integer instanceCount
The number of modified Reserved Instances.
This is a required field for a request.
String instanceType
The instance type for the modified Reserved Instances.
String platform
The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
String scope
Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
String reservedInstancesId
The ID of the Reserved Instance.
String clientToken
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
Date createDate
The time the listing was created.
SdkInternalList<T> instanceCounts
The number of instances in this state.
SdkInternalList<T> priceSchedules
The price of the Reserved Instance listing.
String reservedInstancesId
The ID of the Reserved Instance.
String reservedInstancesListingId
The ID of the Reserved Instance listing.
String status
The status of the Reserved Instance listing.
String statusMessage
The reason for the current status of the Reserved Instance listing. The response can be blank.
SdkInternalList<T> tags
Any tags assigned to the resource.
Date updateDate
The last modified timestamp of the listing.
String clientToken
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
Date createDate
The time when the modification request was created.
Date effectiveDate
The time for the modification to become effective.
SdkInternalList<T> modificationResults
Contains target configurations along with their corresponding new Reserved Instance IDs.
SdkInternalList<T> reservedInstancesIds
The IDs of one or more Reserved Instances.
String reservedInstancesModificationId
A unique ID for the Reserved Instance modification.
String status
The status of the Reserved Instances modification request.
String statusMessage
The reason for the status.
Date updateDate
The time when the modification request was last updated.
String reservedInstancesId
The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
ReservedInstancesConfiguration targetConfiguration
The target Reserved Instances configurations supplied as part of the modification request.
String availabilityZone
The Availability Zone in which the Reserved Instance can be used.
Long duration
The duration of the Reserved Instance, in seconds.
Float fixedPrice
The purchase price of the Reserved Instance.
String instanceType
The instance type on which the Reserved Instance can be used.
String productDescription
The Reserved Instance product platform description.
String reservedInstancesOfferingId
The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
Float usagePrice
The usage price of the Reserved Instance, per hour.
String currencyCode
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard
currency codes. At this time, the only supported currency is USD
.
String instanceTenancy
The tenancy of the instance.
Boolean marketplace
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a
Reserved Instance Marketplace offering, this is true
.
String offeringClass
If convertible
it can be exchanged for Reserved Instances of the same or higher monetary value, with
different configurations. If standard
, it is not possible to perform an exchange.
String offeringType
The Reserved Instance offering type.
SdkInternalList<T> pricingDetails
The pricing details of the Reserved Instance offering.
SdkInternalList<T> recurringCharges
The recurring charge tag assigned to the resource.
String scope
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
AddressAttribute address
Information about the IP address.
String kmsKeyId
The Amazon Resource Name (ARN) of the default CMK for EBS encryption by default.
Boolean returnValue
Is true
if the request succeeds, and an error otherwise.
String attribute
The attribute to reset.
You can only reset the following attributes: kernel
| ramdisk
|
sourceDestCheck
. To change an instance attribute, use ModifyInstanceAttribute.
String instanceId
The ID of the instance.
String kernelId
The ID of the kernel, if applicable.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O.
LaunchTemplateIamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
SdkInternalList<T> blockDeviceMappings
The block device mappings.
SdkInternalList<T> networkInterfaces
The network interfaces.
String imageId
The ID of the AMI that was used to launch the instance.
String instanceType
The instance type.
String keyName
The name of the key pair.
LaunchTemplatesMonitoring monitoring
The monitoring for the instance.
LaunchTemplatePlacement placement
The placement of the instance.
String ramDiskId
The ID of the RAM disk, if applicable.
Boolean disableApiTermination
If set to true
, indicates that the instance cannot be terminated using the Amazon EC2 console,
command line tool, or API.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String userData
The user data for the instance.
SdkInternalList<T> tagSpecifications
The tags.
SdkInternalList<T> elasticGpuSpecifications
The elastic GPU specification.
SdkInternalList<T> elasticInferenceAccelerators
The elastic inference accelerator for the instance.
SdkInternalList<T> securityGroupIds
The security group IDs.
SdkInternalList<T> securityGroups
The security group names.
LaunchTemplateInstanceMarketOptions instanceMarketOptions
The market (purchasing) option for the instances.
CreditSpecification creditSpecification
The credit option for CPU usage of the instance.
LaunchTemplateCpuOptions cpuOptions
The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.
LaunchTemplateCapacityReservationSpecificationResponse capacityReservationSpecification
Information about the Capacity Reservation targeting option.
SdkInternalList<T> licenseSpecifications
The license configurations.
LaunchTemplateHibernationOptions hibernationOptions
Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
LaunchTemplateInstanceMetadataOptions metadataOptions
The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.
LaunchTemplateEnclaveOptions enclaveOptions
Indicates whether the instance is enabled for AWS Nitro Enclaves.
String publicIp
The Elastic IP address.
ManagedPrefixList prefixList
Information about the prefix list.
String clientVpnEndpointId
The ID of the Client VPN endpoint with which the authorization rule is associated.
String targetNetworkCidr
The IPv4 address range, in CIDR notation, of the network for which access is being removed.
String accessGroupId
The ID of the Active Directory group for which to revoke access.
Boolean revokeAllGroups
Indicates whether access should be revoked for all clients.
ClientVpnAuthorizationRuleStatus status
The current state of the authorization rule.
String groupId
The ID of the security group.
SdkInternalList<T> ipPermissions
The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
String cidrIp
Not supported. Use a set of IP permissions to specify the CIDR.
Integer fromPort
Not supported. Use a set of IP permissions to specify the port.
String ipProtocol
Not supported. Use a set of IP permissions to specify the protocol name or number.
Integer toPort
Not supported. Use a set of IP permissions to specify the port.
String sourceSecurityGroupName
Not supported. Use a set of IP permissions to specify a destination security group.
String sourceSecurityGroupOwnerId
Not supported. Use a set of IP permissions to specify a destination security group.
Boolean returnValue
Returns true
if the request succeeds; otherwise, returns an error.
SdkInternalList<T> unknownIpPermissions
The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet
might be
in a different format from the request parameter.
String cidrIp
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
Integer fromPort
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use
-1
to specify all ICMP types.
String groupId
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
String groupName
[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
SdkInternalList<T> ipPermissions
The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
String ipProtocol
The IP protocol name (tcp
, udp
, icmp
) or number (see Protocol Numbers). Use
-1
to specify all.
String sourceSecurityGroupName
[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
String sourceSecurityGroupOwnerId
[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
Integer toPort
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use
-1
to specify all ICMP codes for the ICMP type.
Boolean returnValue
Returns true
if the request succeeds; otherwise, returns an error.
SdkInternalList<T> unknownIpPermissions
The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet
might be
in a different format from the request parameter.
String destinationCidrBlock
The IPv4 CIDR block used for the destination match.
String destinationIpv6CidrBlock
The IPv6 CIDR block used for the destination match.
String destinationPrefixListId
The prefix of the AWS service.
String egressOnlyInternetGatewayId
The ID of the egress-only internet gateway.
String gatewayId
The ID of a gateway attached to your VPC.
String instanceId
The ID of a NAT instance in your VPC.
String instanceOwnerId
The AWS account ID of the owner of the instance.
String natGatewayId
The ID of a NAT gateway.
String transitGatewayId
The ID of a transit gateway.
String localGatewayId
The ID of the local gateway.
String carrierGatewayId
The ID of the carrier gateway.
String networkInterfaceId
The ID of the network interface.
String origin
Describes how the route was created.
CreateRouteTable
- The route was automatically created when the route table was created.
CreateRoute
- The route was manually added to the route table.
EnableVgwRoutePropagation
- The route was propagated by route propagation.
String state
The state of the route. The blackhole
state indicates that the route's target isn't available (for
example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
String vpcPeeringConnectionId
The ID of a VPC peering connection.
SdkInternalList<T> associations
The associations between the route table and one or more subnets or a gateway.
SdkInternalList<T> propagatingVgws
Any virtual private gateway (VGW) propagating routes.
String routeTableId
The ID of the route table.
SdkInternalList<T> routes
The routes in the route table.
SdkInternalList<T> tags
Any tags assigned to the route table.
String vpcId
The ID of the VPC.
String ownerId
The ID of the AWS account that owns the route table.
Boolean main
Indicates whether this is the main route table.
String routeTableAssociationId
The ID of the association.
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.
String gatewayId
The ID of the internet gateway or virtual private gateway.
RouteTableAssociationState associationState
The state of the association.
SdkInternalList<T> blockDeviceMappings
The block device mapping entries.
String imageId
The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
String instanceType
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
Default: m1.small
Integer ipv6AddressCount
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
SdkInternalList<T> ipv6Addresses
[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
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 EC2 User Guide.
String keyName
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
Integer maxCount
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target
Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount
.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
Integer minCount
The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
Boolean monitoring
Specifies whether detailed monitoring is enabled for the instance.
Placement placement
The placement for the instance.
String ramdiskId
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
SdkInternalList<T> securityGroupIds
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
SdkInternalList<T> securityGroups
[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
String subnetId
[EC2-VPC] The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
String userData
The user data to make available to the instance. For more information, see Running commands on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
String additionalInfo
Reserved.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
Boolean disableApiTermination
If you set this parameter to true
, you can't terminate the instance using the Amazon EC2 console,
CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior
to
terminate
, you can terminate the instance by running the shutdown command from the instance.
Default: false
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
IamInstanceProfileSpecification iamInstanceProfile
The name or Amazon Resource Name (ARN) of an IAM instance profile.
String instanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
SdkInternalList<T> networkInterfaces
The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
String privateIpAddress
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
SdkInternalList<T> elasticGpuSpecification
An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.
SdkInternalList<T> elasticInferenceAccelerators
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
SdkInternalList<T> tagSpecifications
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
LaunchTemplateSpecification launchTemplate
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
InstanceMarketOptionsRequest instanceMarketOptions
The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when
InstanceInterruptionBehavior is set to either hibernate
or stop
.
CreditSpecificationRequest creditSpecification
The credit option for CPU usage of the burstable performance instance. Valid values are standard
and
unlimited
. To change this attribute after launch, use
ModifyInstanceCreditSpecification. For more information, see Burstable
performance instances in the Amazon EC2 User Guide.
Default: standard
(T2 instances) or unlimited
(T3/T3a instances)
CpuOptionsRequest cpuOptions
The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon EC2 User Guide.
CapacityReservationSpecification capacityReservationSpecification
Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's
Capacity Reservation preference defaults to open
, which enables it to run in any open Capacity
Reservation that has matching attributes (instance type, platform, Availability Zone).
HibernationOptionsRequest hibernationOptions
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can't enable hibernation and AWS Nitro Enclaves on the same instance.
SdkInternalList<T> licenseSpecifications
The license configurations.
InstanceMetadataOptionsRequest metadataOptions
The metadata options for the instance. For more information, see Instance metadata and user data.
EnclaveOptionsRequest enclaveOptions
Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide.
You can't enable AWS Nitro Enclaves and hibernation on the same instance.
Reservation reservation
Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.
String clientToken
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
Integer instanceCount
The number of instances.
Default: 1
ScheduledInstancesLaunchSpecification launchSpecification
The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.
String scheduledInstanceId
The Scheduled Instance ID.
SdkInternalList<T> instanceIdSet
The IDs of the newly launched instances.
String aWSAccessKeyId
The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.
String bucket
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
String prefix
The beginning of the file name of the AMI.
String uploadPolicy
An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
String uploadPolicySignature
The signature of the JSON document.
String availabilityZone
The Availability Zone.
Date createDate
The date when the Scheduled Instance was purchased.
String hourlyPrice
The hourly price for a single instance.
Integer instanceCount
The number of instances.
String instanceType
The instance type.
String networkPlatform
The network platform (EC2-Classic
or EC2-VPC
).
Date nextSlotStartTime
The time for the next schedule to start.
String platform
The platform (Linux/UNIX
or Windows
).
Date previousSlotEndTime
The time that the previous schedule ended or will end.
ScheduledInstanceRecurrence recurrence
The schedule recurrence.
String scheduledInstanceId
The Scheduled Instance ID.
Integer slotDurationInHours
The number of hours in the schedule.
Date termEndDate
The end date for the Scheduled Instance.
Date termStartDate
The start date for the Scheduled Instance.
Integer totalScheduledInstanceHours
The total number of hours for a single instance for the entire term.
String availabilityZone
The Availability Zone.
Integer availableInstanceCount
The number of available instances.
Date firstSlotStartTime
The time period for the first schedule to start.
String hourlyPrice
The hourly price for a single instance.
String instanceType
The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
Integer maxTermDurationInDays
The maximum term. The only possible value is 365 days.
Integer minTermDurationInDays
The minimum term. The only possible value is 365 days.
String networkPlatform
The network platform (EC2-Classic
or EC2-VPC
).
String platform
The platform (Linux/UNIX
or Windows
).
String purchaseToken
The purchase token. This token expires in two hours.
ScheduledInstanceRecurrence recurrence
The schedule recurrence.
Integer slotDurationInHours
The number of hours in the schedule.
Integer totalScheduledInstanceHours
The total number of hours for a single instance for the entire term.
String frequency
The frequency (Daily
, Weekly
, or Monthly
).
Integer interval
The interval quantity. The interval unit depends on the value of frequency
. For example, every 2
weeks or every 2 months.
SdkInternalList<T> occurrenceDaySet
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
Boolean occurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month.
String occurrenceUnit
The unit for occurrenceDaySet
(DayOfWeek
or DayOfMonth
).
String frequency
The frequency (Daily
, Weekly
, or Monthly
).
Integer interval
The interval quantity. The interval unit depends on the value of Frequency
. For example, every 2
weeks or every 2 months.
SdkInternalList<T> occurrenceDays
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
Boolean occurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
String occurrenceUnit
The unit for OccurrenceDays
(DayOfWeek
or DayOfMonth
). This value is
required for a monthly schedule. You can't specify DayOfWeek
with a weekly schedule. You can't
specify this value with a daily schedule.
String deviceName
The device name (for example, /dev/sdh
or xvdh
).
ScheduledInstancesEbs ebs
Parameters used to set up EBS volumes automatically when the instance is launched.
String noDevice
To omit the device from the block device mapping, specify an empty string.
String virtualName
The virtual device name (ephemeral
N). Instance store volumes are numbered starting from 0. An
instance type with two available instance store volumes can specify mappings for ephemeral0
and
ephemeral1
. The number of available instance store volumes depends on the instance type. After you
connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
Boolean deleteOnTermination
Indicates whether the volume is deleted on instance termination.
Boolean encrypted
Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.
Integer iops
The number of I/O operations per second (IOPS) to provision for an io1
or io2
volume,
with a maximum ratio of 50 IOPS/GiB for io1
, and 500 IOPS/GiB for io2
. Range is 100 to
64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on instances
built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS. For more
information, see Amazon EBS
volume types in the Amazon EC2 User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1
and io2
) volumes.
String snapshotId
The ID of the snapshot.
Integer volumeSize
The size of the volume, in GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
String volumeType
The volume type. gp2
for General Purpose SSD, io1
or io2
for Provisioned
IOPS SSD, Throughput Optimized HDD for st1
, Cold HDD for sc1
, or standard
for Magnetic.
Default: gp2
String ipv6Address
The IPv6 address.
SdkInternalList<T> blockDeviceMappings
The block device mapping entries.
Boolean ebsOptimized
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
ScheduledInstancesIamInstanceProfile iamInstanceProfile
The IAM instance profile.
String imageId
The ID of the Amazon Machine Image (AMI).
String instanceType
The instance type.
String kernelId
The ID of the kernel.
String keyName
The name of the key pair.
ScheduledInstancesMonitoring monitoring
Enable or disable monitoring for the instances.
SdkInternalList<T> networkInterfaces
The network interfaces.
ScheduledInstancesPlacement placement
The placement information.
String ramdiskId
The ID of the RAM disk.
SdkInternalList<T> securityGroupIds
The IDs of the security groups.
String subnetId
The ID of the subnet in which to launch the instances.
String userData
The base64-encoded MIME user data.
Boolean enabled
Indicates whether monitoring is enabled.
Boolean associatePublicIpAddress
Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can
only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an
existing one. You cannot specify more than one network interface in the request. If launching into a default
subnet, the default value is true
.
Boolean deleteOnTermination
Indicates whether to delete the interface when the instance is terminated.
String description
The description.
Integer deviceIndex
The index of the device for the network interface attachment.
SdkInternalList<T> groups
The IDs of the security groups.
Integer ipv6AddressCount
The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.
SdkInternalList<T> ipv6Addresses
The specific IPv6 addresses from the subnet range.
String networkInterfaceId
The ID of the network interface.
String privateIpAddress
The IPv4 address of the network interface within the subnet.
SdkInternalList<T> privateIpAddressConfigs
The private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses.
String subnetId
The ID of the subnet.
String localGatewayRouteTableId
The ID of the local gateway route table.
SdkInternalList<T> filters
One or more filters.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> routes
Information about the routes.
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 transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
SdkInternalList<T> filters
One or more filters. The possible values are:
group-ip-address
- The IP address of the transit gateway multicast group.
is-group-member
- The resource is a group member. Valid values are true
|
false
.
is-group-source
- The resource is a group source. Valid values are true
|
false
.
member-type
- The member type. Valid values are igmp
| static
.
resource-id
- The ID of the resource.
resource-type
- The type of resource. Valid values are vpc
| vpn
|
direct-connect-gateway
| tgw-peering
.
source-type
- The source type. Valid values are igmp
| static
.
state
- The state of the subnet association. Valid values are associated
|
associated
| disassociated
| disassociating
.
subnet-id
- The ID of the subnet.
transit-gateway-attachment-id
- The id of the transit gateway attachment.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken
value.
String nextToken
The token for the next page of results.
SdkInternalList<T> multicastGroups
Information about the transit gateway multicast group.
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 transitGatewayRouteTableId
The ID of the transit gateway route table.
SdkInternalList<T> filters
One or more filters. The possible values are:
attachment.transit-gateway-attachment-id
- The id of the transit gateway attachment.
attachment.resource-id
- The resource id of the transit gateway attachment.
attachment.resource-type
- The attachment resource type. Valid values are vpc
|
vpn
| direct-connect-gateway
| peering
| connect
.
prefix-list-id
- The ID of the prefix list.
route-search.exact-match
- The exact match of the specified filter.
route-search.longest-prefix-match
- The longest prefix that matches the route.
route-search.subnet-of-match
- The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match
- The routes with a CIDR that encompass the CIDR filter. For example,
if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
10.0.1.0/30, then the result returns 10.0.1.0/29.
state
- The state of the route (active
| blackhole
).
type
- The type of route (propagated
| static
).
Integer maxResults
The maximum number of routes to return.
SdkInternalList<T> routes
Information about the routes.
Boolean additionalRoutesAvailable
Indicates whether there are additional routes available.
String description
A description of the security group.
String groupName
The name of the security group.
SdkInternalList<T> ipPermissions
The inbound rules associated with the security group.
String ownerId
The AWS account ID of the owner of the security group.
String groupId
The ID of the security group.
SdkInternalList<T> ipPermissionsEgress
[VPC only] The outbound rules associated with the security group.
SdkInternalList<T> tags
Any tags assigned to the security group.
String vpcId
[VPC only] The ID of the VPC for the security group.
String instanceId
The ID of the instance.
SdkInternalList<T> serviceType
The type of service.
String serviceId
The ID of the service.
String serviceName
The name of the service.
String serviceState
The service state.
SdkInternalList<T> availabilityZones
The Availability Zones in which the service is available.
Boolean acceptanceRequired
Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
Boolean managesVpcEndpoints
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
SdkInternalList<T> networkLoadBalancerArns
The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
SdkInternalList<T> gatewayLoadBalancerArns
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
SdkInternalList<T> baseEndpointDnsNames
The DNS names for the service.
String privateDnsName
The private DNS name for the service.
PrivateDnsNameConfiguration privateDnsNameConfiguration
Information about the endpoint service private DNS name configuration.
SdkInternalList<T> tags
Any tags assigned to the service.
String serviceName
The Amazon Resource Name (ARN) of the service.
String serviceId
The ID of the endpoint service.
SdkInternalList<T> serviceType
The type of service.
SdkInternalList<T> availabilityZones
The Availability Zones in which the service is available.
String owner
The AWS account ID of the service owner.
SdkInternalList<T> baseEndpointDnsNames
The DNS names for the service.
String privateDnsName
The private DNS name for the service.
SdkInternalList<T> privateDnsNames
The private DNS names assigned to the VPC endpoint service.
Boolean vpcEndpointPolicySupported
Indicates whether the service supports endpoint policies.
Boolean acceptanceRequired
Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
Boolean managesVpcEndpoints
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
SdkInternalList<T> tags
Any tags assigned to the service.
String privateDnsNameVerificationState
The verification state of the VPC endpoint service.
Consumers of the endpoint service cannot use the private name when the state is not verified
.
String serviceType
The type of service.
Date earliestTime
The earliest date and time, in UTC, for the Scheduled Instance to start.
Date latestTime
The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
String dataEncryptionKeyId
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
String description
The description for the snapshot.
Boolean encrypted
Indicates whether the snapshot is encrypted.
String kmsKeyId
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
String ownerId
The AWS account ID of the EBS snapshot owner.
String progress
The progress of the snapshot, as a percentage.
String snapshotId
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
Date startTime
The time stamp when the snapshot was initiated.
String state
The snapshot state.
String stateMessage
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
String volumeId
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
Integer volumeSize
The size of the volume, in GiB.
String ownerAlias
The AWS owner alias, from an Amazon-maintained list (amazon
). This is not the user-configured AWS
account alias set using the IAM console.
String outpostArn
The ARN of the AWS Outpost on which the snapshot is stored. For more information, see EBS Local Snapshot on Outposts in the Amazon Elastic Compute Cloud User Guide.
SdkInternalList<T> tags
Any tags assigned to the snapshot.
String description
A description for the snapshot.
String deviceName
The block device mapping for the snapshot.
Double diskImageSize
The size of the disk in the snapshot, in GiB.
String format
The format of the disk image from which the snapshot is created.
String progress
The percentage of progress for the task.
String snapshotId
The snapshot ID of the disk being imported.
String status
A brief status of the snapshot creation.
String statusMessage
A detailed status message for the snapshot creation.
String url
The URL used to access the disk image.
UserBucketDetails userBucket
The Amazon S3 bucket for the disk image.
String description
The description of the disk image being imported.
String format
The format of the disk image being imported.
Valid values: VHD
| VMDK
| RAW
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 Amazon S3 bucket for the disk image.
String description
Description specified by the CreateSnapshotRequest that has been applied to all snapshots.
SdkInternalList<T> tags
Tags associated with this snapshot.
Boolean encrypted
Indicates whether the snapshot is encrypted.
String volumeId
Source volume from which this snapshot was created.
String state
Current state of the snapshot.
Integer volumeSize
Size of the volume from which this snapshot was created.
Date startTime
Time this snapshot was started. This is the same for all snapshots initiated by the same request.
String progress
Progress this snapshot has made towards completing.
String ownerId
Account id used when creating this snapshot.
String snapshotId
Snapshot id that can be used to describe this snapshot.
String outpostArn
The ARN of the AWS Outpost on which the snapshot is stored. For more information, see EBS Local Snapshot on Outposts in the Amazon Elastic Compute Cloud User Guide.
String description
The description of the snapshot.
Double diskImageSize
The size of the disk in the snapshot, in GiB.
Boolean encrypted
Indicates whether the snapshot is encrypted.
String format
The format of the disk image from which the snapshot is created.
String kmsKeyId
The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted snapshot.
String progress
The percentage of completion for the import snapshot task.
String snapshotId
The snapshot ID of the disk being imported.
String status
A brief status for the import snapshot task.
String statusMessage
A detailed status message for the import snapshot task.
String url
The URL of the disk image from which the snapshot is created.
UserBucketDetails userBucket
The Amazon S3 bucket for the disk image.
String replacementStrategy
The replacement strategy to use. Only available for fleets of type maintain
. You must specify a
value, otherwise you get an error.
To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for
a Spot Instance in the fleet, specify launch
.
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
String bucket
The name of the Amazon S3 bucket where the Spot Instance data feed is located.
SpotInstanceStateFault fault
The fault codes for the Spot Instance request, if any.
String ownerId
The AWS account ID of the account.
String prefix
The prefix for the data feed files.
String state
The state of the Spot Instance data feed subscription.
SdkInternalList<T> securityGroups
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
String addressingType
Deprecated.
SdkInternalList<T> blockDeviceMappings
One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
Boolean ebsOptimized
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
IamInstanceProfileSpecification iamInstanceProfile
The IAM instance profile.
String imageId
The ID of the AMI.
String instanceType
The instance type.
String kernelId
The ID of the kernel.
String keyName
The name of the key pair.
SpotFleetMonitoring monitoring
Enable or disable monitoring for the instances.
SdkInternalList<T> networkInterfaces
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotFleetLaunchSpecification
currently does not support Elastic Fabric Adapter (EFA). To specify an
EFA, you must use
LaunchTemplateConfig.
SpotPlacement placement
The placement information.
String ramdiskId
The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID.
String spotPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified,
the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot
price by the value of WeightedCapacity
.
String subnetId
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
String userData
The Base64-encoded user data that instances use when starting up.
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 of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
SdkInternalList<T> tagSpecifications
The tags to apply during creation.
Boolean enabled
Enables monitoring for the instance.
Default: false
String activityStatus
The progress of the Spot Fleet request. If there is an error, the status is error
. After all
requests are placed, the status is pending_fulfillment
. If the size of the fleet is equal to or
greater than its target capacity, the status is fulfilled
. If the size of the fleet is decreased,
the status is pending_termination
while Spot Instances are terminating.
Date createTime
The creation date and time of the request.
SpotFleetRequestConfigData spotFleetRequestConfig
The configuration of the Spot Fleet request.
String spotFleetRequestId
The ID of the Spot Fleet request.
String spotFleetRequestState
The state of the Spot Fleet request.
SdkInternalList<T> tags
The tags for a Spot Fleet resource.
String allocationStrategy
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.
If the allocation strategy is lowestPrice
, Spot Fleet launches instances from the Spot Instance
pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified
, Spot Fleet launches instances from all the Spot Instance
pools that you specify.
If the allocation strategy is capacityOptimized
(recommended), Spot Fleet launches instances from
Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain
instance types a higher chance of launching first, use capacityOptimizedPrioritized
. Set a priority
for each instance type by using the Priority
parameter for LaunchTemplateOverrides
. You
can assign the same priority to different LaunchTemplateOverrides
. EC2 implements the priorities on
a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized
is supported
only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy
is set
to prioritized
, the same priority is applied when fulfilling On-Demand capacity.
String onDemandAllocationStrategy
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
lowestPrice
, Spot Fleet uses price to determine the order, launching the lowest price first. If you
specify prioritized
, Spot Fleet uses the priority that you assign to each Spot Fleet launch template
override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to
lowestPrice
.
SpotMaintenanceStrategies spotMaintenanceStrategies
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
String excessCapacityTerminationPolicy
Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
Double fulfilledCapacity
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
Double onDemandFulfilledCapacity
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
String iamFleetRole
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the
permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot
Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot
Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set
TerminateInstancesWithExpiration
.
SdkInternalList<T> launchSpecifications
The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications
, you can't
specify LaunchTemplateConfigs
. If you include On-Demand capacity in your request, you must use
LaunchTemplateConfigs
.
SdkInternalList<T> launchTemplateConfigs
The launch template and overrides. If you specify LaunchTemplateConfigs
, you can't specify
LaunchSpecifications
. If you include On-Demand capacity in your request, you must use
LaunchTemplateConfigs
.
String spotPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
Integer targetCapacity
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of
instances or a performance characteristic that is important to your application workload, such as vCPUs, memory,
or I/O. If the request type is maintain
, you can specify a target capacity of 0 and add capacity
later.
Integer onDemandTargetCapacity
The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a
performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the
request type is maintain
, you can specify a target capacity of 0 and add capacity later.
String onDemandMaxTotalPrice
The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the
onDemandMaxTotalPrice
parameter, the spotMaxTotalPrice
parameter, or both parameters to
ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand
Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum
amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching
instances even if it hasn’t met the target capacity.
String spotMaxTotalPrice
The maximum amount per hour for Spot Instances that you're willing to pay. You can use the
spotdMaxTotalPrice
parameter, the onDemandMaxTotalPrice
parameter, or both parameters
to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand
Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum
amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching
instances even if it hasn’t met the target capacity.
Boolean terminateInstancesWithExpiration
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
String type
The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to
maintain it. When this value is request
, the Spot Fleet only places the required requests. It does
not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative
Spot pools if capacity is not available. When this value is maintain
, the Spot Fleet maintains the
target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any
interrupted instances. Default: maintain
. instant
is listed but is not used by Spot
Fleet.
Date validFrom
The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.
Date validUntil
The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
Boolean replaceUnhealthyInstances
Indicates whether Spot Fleet should replace unhealthy instances.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
LoadBalancersConfig loadBalancersConfig
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
Integer instancePoolsToUseCount
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot
AllocationStrategy is set to lowest-price
. Spot Fleet selects the cheapest Spot pools and
evenly allocates your target Spot capacity across the number of Spot pools that you specify.
SdkInternalList<T> tagSpecifications
The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType
must
be spot-fleet-request
, otherwise the Spot Fleet request fails. To tag instances at launch, specify
the tags in the launch template (valid only if you use LaunchTemplateConfigs
) or in the
SpotFleetTagSpecification
(valid only if you use LaunchSpecifications
). For
information about tagging after launch, see Tagging Your
Resources.
String resourceType
The type of resource. Currently, the only resource type that is supported is instance
. To tag the
Spot Fleet request on creation, use the TagSpecifications
parameter in
SpotFleetRequestConfigData
.
SdkInternalList<T> tags
The tags.
String actualBlockHourlyPrice
If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.
String availabilityZoneGroup
The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
Integer blockDurationMinutes
The duration for the Spot Instance, in minutes.
Date createTime
The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SpotInstanceStateFault fault
The fault codes for the Spot Instance request, if any.
String instanceId
The instance ID, if an instance has been launched to fulfill the Spot Instance request.
String launchGroup
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
LaunchSpecification launchSpecification
Additional information for launching instances.
String launchedAvailabilityZone
The Availability Zone in which the request is launched.
String productDescription
The product description associated with the Spot Instance.
String spotInstanceRequestId
The ID of the Spot Instance request.
String spotPrice
The maximum price per hour that you are willing to pay for a Spot Instance.
String state
The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot status in the Amazon EC2 User Guide for Linux Instances.
SpotInstanceStatus status
The status code and status message describing the Spot Instance request.
SdkInternalList<T> tags
Any tags assigned to the resource.
String type
The Spot Instance request type.
Date validFrom
The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.
Date validUntil
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the validUntil
date and time is reached.
Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the
validUntil
date and time is reached. By default, the request is valid for 7 days from the date the
request was created.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted.
String code
The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances.
String message
The description for the status code.
Date updateTime
The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
SpotCapacityRebalance capacityRebalance
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
String maxPrice
The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price.
String spotInstanceType
The Spot Instance request type. For RunInstances, persistent Spot
Instance requests are only supported when the instance interruption behavior is either hibernate
or
stop
.
Integer blockDurationMinutes
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
You can't specify an Availability Zone group or a launch group if you specify a duration.
New accounts or accounts with no previous billing history with AWS are not eligible for Spot Instances with a defined duration (also known as Spot blocks).
Date validUntil
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.
For a persistent request, the request remains active until the ValidUntil
date and time is reached.
Otherwise, the request remains active until you cancel it.
For a one-time request, ValidUntil
is not supported. The request remains active until all instances
launch or you cancel the request.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
String allocationStrategy
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
If the allocation strategy is lowest-price
, EC2 Fleet launches instances from the Spot Instance
pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified
, EC2 Fleet launches instances from all of the Spot
Instance pools that you specify.
If the allocation strategy is capacity-optimized
(recommended), EC2 Fleet launches instances from
Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain
instance types a higher chance of launching first, use capacity-optimized-prioritized
. Set a
priority for each instance type by using the Priority
parameter for
LaunchTemplateOverrides
. You can assign the same priority to different
LaunchTemplateOverrides
. EC2 implements the priorities on a best-effort basis, but optimizes for
capacity first. capacity-optimized-prioritized
is supported only if your fleet uses a launch
template. Note that if the On-Demand AllocationStrategy
is set to prioritized
, the same
priority is applied when fulfilling On-Demand capacity.
FleetSpotMaintenanceStrategies maintenanceStrategies
The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
Integer instancePoolsToUseCount
The number of Spot pools across which to allocate your target Spot capacity. Valid only when
AllocationStrategy is set to lowest-price
. EC2 Fleet selects the cheapest Spot pools and
evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Boolean singleInstanceType
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only
for fleets of type instant
.
Boolean singleAvailabilityZone
Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets
of type instant
.
Integer minTargetCapacity
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
String maxTotalPrice
The maximum amount per hour for Spot Instances that you're willing to pay.
String allocationStrategy
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
If the allocation strategy is lowest-price
, EC2 Fleet launches instances from the Spot Instance
pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified
, EC2 Fleet launches instances from all of the Spot
Instance pools that you specify.
If the allocation strategy is capacity-optimized
(recommended), EC2 Fleet launches instances from
Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain
instance types a higher chance of launching first, use capacity-optimized-prioritized
. Set a
priority for each instance type by using the Priority
parameter for
LaunchTemplateOverrides
. You can assign the same priority to different
LaunchTemplateOverrides
. EC2 implements the priorities on a best-effort basis, but optimizes for
capacity first. capacity-optimized-prioritized
is supported only if your fleet uses a launch
template. Note that if the On-Demand AllocationStrategy
is set to prioritized
, the same
priority is applied when fulfilling On-Demand capacity.
FleetSpotMaintenanceStrategiesRequest maintenanceStrategies
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted. The default is terminate
.
Integer instancePoolsToUseCount
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot
AllocationStrategy is set to lowest-price
. EC2 Fleet selects the cheapest Spot pools and
evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Boolean singleInstanceType
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only
for fleets of type instant
.
Boolean singleAvailabilityZone
Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets
of type instant
.
Integer minTargetCapacity
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
String maxTotalPrice
The maximum amount per hour for Spot Instances that you're willing to pay.
String availabilityZone
The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
String groupName
The name of the placement group.
String tenancy
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of
dedicated
runs on single-tenant hardware. The host
tenancy is not supported for Spot
Instances.
String availabilityZone
The Availability Zone.
String instanceType
The instance type.
String productDescription
A general description of the AMI.
String spotPrice
The maximum price per hour that you are willing to pay for a Spot Instance.
Date timestamp
The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Integer fromPort
The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1
indicates all ICMP types.
String ipProtocol
The IP protocol name (for tcp
, udp
, and icmp
) or number (see Protocol Numbers).
SdkInternalList<T> ipRanges
The IP ranges. Not applicable for stale security group rules.
SdkInternalList<T> prefixListIds
The prefix list IDs. Not applicable for stale security group rules.
Integer toPort
The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1
indicates all ICMP types.
SdkInternalList<T> userIdGroupPairs
The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
String description
The description of the security group.
String groupId
The ID of the security group.
String groupName
The name of the security group.
SdkInternalList<T> staleIpPermissions
Information about the stale inbound rules in the security group.
SdkInternalList<T> staleIpPermissionsEgress
Information about the stale outbound rules in the security group.
String vpcId
The ID of the VPC for the security group.
SdkInternalList<T> instanceIds
The IDs of the instances.
String additionalInfo
Reserved.
SdkInternalList<T> startingInstances
Information about the started instances.
String networkInsightsPathId
The ID of the path.
SdkInternalList<T> filterInArns
The Amazon Resource Names (ARN) of the resources that the path must traverse.
SdkInternalList<T> tagSpecifications
The tags to apply.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
NetworkInsightsAnalysis networkInsightsAnalysis
Information about the network insights analysis.
String serviceId
The ID of the endpoint service.
Boolean returnValue
Returns true
if the request succeeds; otherwise, it returns an error.
String code
The reason code for the state change.
String message
The message for the state change.
Server.InsufficientInstanceCapacity
: There was insufficient capacity available to satisfy the launch
request.
Server.InternalError
: An internal error caused the instance to terminate during launch.
Server.ScheduledStop
: The instance was stopped due to a scheduled retirement.
Server.SpotInstanceShutdown
: The instance was stopped because the number of Spot requests with a
maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the
Spot price.
Server.SpotInstanceTermination
: The instance was terminated because the number of Spot requests with
a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in
the Spot price.
Client.InstanceInitiatedShutdown
: The instance was shut down using the shutdown -h
command from the instance.
Client.InstanceTerminated
: The instance was terminated or rebooted during AMI creation.
Client.InternalError
: A client error caused the instance to terminate during launch.
Client.InvalidSnapshot.NotFound
: The specified snapshot was not found.
Client.UserInitiatedHibernate
: Hibernation was initiated on 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 account limits.
SdkInternalList<T> instanceIds
The IDs of the instances.
Boolean hibernate
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
Boolean force
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
SdkInternalList<T> stoppingInstances
Information about the stopped instances.
S3Storage s3
An Amazon S3 storage location.
String availabilityZone
The Availability Zone of the subnet.
String availabilityZoneId
The AZ ID of the subnet.
Integer availableIpAddressCount
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
String cidrBlock
The IPv4 CIDR block assigned to the subnet.
Boolean defaultForAz
Indicates whether this is the default subnet for the Availability Zone.
Boolean mapPublicIpOnLaunch
Indicates whether instances launched in this subnet receive a public IPv4 address.
Boolean mapCustomerOwnedIpOnLaunch
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
String customerOwnedIpv4Pool
The customer-owned IPv4 address pool associated with the subnet.
String state
The current state of the subnet.
String subnetId
The ID of the subnet.
String vpcId
The ID of the VPC the subnet is in.
String ownerId
The ID of the AWS account that owns the subnet.
Boolean assignIpv6AddressOnCreation
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
SdkInternalList<T> ipv6CidrBlockAssociationSet
Information about the IPv6 CIDR blocks associated with the subnet.
SdkInternalList<T> tags
Any tags assigned to the subnet.
String subnetArn
The Amazon Resource Name (ARN) of the subnet.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
String associationId
The association ID for the CIDR block.
String ipv6CidrBlock
The IPv6 CIDR block.
SubnetCidrBlockState ipv6CidrBlockState
Information about the state of the CIDR block.
String instanceId
The ID of the instance.
String reservedInstancesId
The ID of the Reserved Instance.
String resourceType
The type of resource to tag. Currently, the resource types that support tagging on creation are:
capacity-reservation
| carrier-gateway
| client-vpn-endpoint
|
customer-gateway
| dedicated-host
| dhcp-options
|
egress-only-internet-gateway
| elastic-ip
| elastic-gpu
|
export-image-task
| export-instance-task
| fleet
| fpga-image
| host-reservation
| image
| import-image-task
|
import-snapshot-task
| instance
| internet-gateway
|
ipv4pool-ec2
| ipv6pool-ec2
| key-pair
| launch-template
|
local-gateway-route-table-vpc-association
| placement-group
| prefix-list
| natgateway
| network-acl
| network-interface
|
reserved-instances
|route-table
| security-group
| snapshot
|
spot-fleet-request
| spot-instances-request
| snapshot
|
subnet
| traffic-mirror-filter
| traffic-mirror-session
|
traffic-mirror-target
| transit-gateway
| transit-gateway-attachment
|
transit-gateway-multicast-domain
| transit-gateway-route-table
| volume
|
vpc
| vpc-peering-connection
| vpc-endpoint
(for interface and gateway
endpoints) | vpc-endpoint-service
(for AWS PrivateLink) | vpc-flow-log
|
vpn-connection
| vpn-gateway
.
To tag a resource after it has been created, see CreateTags.
SdkInternalList<T> tags
The tags to apply to the resource.
Integer totalTargetCapacity
The number of units to request, filled using DefaultTargetCapacityType
.
Integer onDemandTargetCapacity
The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.
Integer spotTargetCapacity
The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.
String defaultTargetCapacityType
The default TotalTargetCapacity
, which is either Spot
or On-Demand
.
Integer totalTargetCapacity
The number of units to request, filled using DefaultTargetCapacityType
.
Integer onDemandTargetCapacity
The number of On-Demand units to request.
Integer spotTargetCapacity
The number of Spot units to request.
String defaultTargetCapacityType
The default TotalTargetCapacity
, which is either Spot
or On-Demand
.
String arn
The Amazon Resource Name (ARN) of the target group.
SdkInternalList<T> targetGroups
One or more target groups.
String associationId
The ID of the association.
String vpcId
The ID of the VPC in which the target network (subnet) is located.
String targetNetworkId
The ID of the subnet specified as the target network.
String clientVpnEndpointId
The ID of the Client VPN endpoint with which the target network is associated.
AssociationStatus status
The current state of the target network association.
SdkInternalList<T> securityGroups
The IDs of the security groups applied to the target network association.
ReservationValue reservationValue
The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.
TargetConfiguration targetConfiguration
The configuration of the Convertible Reserved Instances that make up the exchange.
String clientVpnEndpointId
The ID of the Client VPN endpoint to which the client is connected.
String connectionId
The ID of the client connection to be terminated.
String username
The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
String clientVpnEndpointId
The ID of the Client VPN endpoint.
String username
The user who established the terminated client connections.
SdkInternalList<T> connectionStatuses
The current state of the client connections.
String connectionId
The ID of the client connection.
ClientVpnConnectionStatus previousStatus
The state of the client connection.
ClientVpnConnectionStatus currentStatus
A message about the status of the client connection, if applicable.
SdkInternalList<T> instanceIds
The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
SdkInternalList<T> terminatingInstances
Information about the terminated instances.
String trafficMirrorFilterId
The ID of the Traffic Mirror filter.
SdkInternalList<T> ingressFilterRules
Information about the ingress rules that are associated with the Traffic Mirror filter.
SdkInternalList<T> egressFilterRules
Information about the egress rules that are associated with the Traffic Mirror filter.
SdkInternalList<T> networkServices
The network service traffic that is associated with the Traffic Mirror filter.
String description
The description of the Traffic Mirror filter.
SdkInternalList<T> tags
The tags assigned to the Traffic Mirror filter.
String trafficMirrorFilterRuleId
The ID of the Traffic Mirror rule.
String trafficMirrorFilterId
The ID of the Traffic Mirror filter that the rule is associated with.
String trafficDirection
The traffic direction assigned to the Traffic Mirror rule.
Integer ruleNumber
The rule number of the Traffic Mirror rule.
String ruleAction
The action assigned to the Traffic Mirror rule.
Integer protocol
The protocol assigned to the Traffic Mirror rule.
TrafficMirrorPortRange destinationPortRange
The destination port range assigned to the Traffic Mirror rule.
TrafficMirrorPortRange sourcePortRange
The source port range assigned to the Traffic Mirror rule.
String destinationCidrBlock
The destination CIDR block assigned to the Traffic Mirror rule.
String sourceCidrBlock
The source CIDR block assigned to the Traffic Mirror rule.
String description
The description of the Traffic Mirror rule.
String trafficMirrorSessionId
The ID for the Traffic Mirror session.
String trafficMirrorTargetId
The ID of the Traffic Mirror target.
String trafficMirrorFilterId
The ID of the Traffic Mirror filter.
String networkInterfaceId
The ID of the Traffic Mirror session's network interface.
String ownerId
The ID of the account that owns the Traffic Mirror session.
Integer packetLength
The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet
Integer sessionNumber
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
Integer virtualNetworkId
The virtual network ID associated with the Traffic Mirror session.
String description
The description of the Traffic Mirror session.
SdkInternalList<T> tags
The tags assigned to the Traffic Mirror session.
String trafficMirrorTargetId
The ID of the Traffic Mirror target.
String networkInterfaceId
The network interface ID that is attached to the target.
String networkLoadBalancerArn
The Amazon Resource Name (ARN) of the Network Load Balancer.
String type
The type of Traffic Mirror target.
String description
Information about the Traffic Mirror target.
String ownerId
The ID of the account that owns the Traffic Mirror target.
SdkInternalList<T> tags
The tags assigned to the Traffic Mirror target.
String transitGatewayId
The ID of the transit gateway.
String transitGatewayArn
The Amazon Resource Name (ARN) of the transit gateway.
String state
The state of the transit gateway.
String ownerId
The ID of the AWS account ID that owns the transit gateway.
String description
The description of the transit gateway.
Date creationTime
The creation time.
TransitGatewayOptions options
The transit gateway options.
SdkInternalList<T> tags
The tags for the transit gateway.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
String transitGatewayAttachmentId
The ID of the attachment.
String resourceId
The ID of the resource.
String resourceType
The resource type. Note that the tgw-peering
resource type has been deprecated.
String state
The state of the association.
String transitGatewayAttachmentId
The ID of the attachment.
String transitGatewayId
The ID of the transit gateway.
String transitGatewayOwnerId
The ID of the AWS account that owns the transit gateway.
String resourceOwnerId
The ID of the AWS account that owns the resource.
String resourceType
The resource type. Note that the tgw-peering
resource type has been deprecated.
String resourceId
The ID of the resource.
String state
The attachment state. Note that the initiating
state has been deprecated.
TransitGatewayAttachmentAssociation association
The association.
Date creationTime
The creation time.
SdkInternalList<T> tags
The tags for the attachment.
Long transitGatewayAsn
The transit gateway Autonomous System Number (ASN).
Long peerAsn
The peer Autonomous System Number (ASN).
String transitGatewayAddress
The interior BGP peer IP address for the transit gateway.
String peerAddress
The interior BGP peer IP address for the appliance.
String bgpStatus
The BGP status.
String transitGatewayAttachmentId
The ID of the Connect attachment.
String transportTransitGatewayAttachmentId
The ID of the attachment from which the Connect attachment was created.
String transitGatewayId
The ID of the transit gateway.
String state
The state of the attachment.
Date creationTime
The creation time.
TransitGatewayConnectOptions options
The Connect attachment options.
SdkInternalList<T> tags
The tags for the attachment.
String protocol
The tunnel protocol.
String transitGatewayAttachmentId
The ID of the Connect attachment.
String transitGatewayConnectPeerId
The ID of the Connect peer.
String state
The state of the Connect peer.
Date creationTime
The creation time.
TransitGatewayConnectPeerConfiguration connectPeerConfiguration
The Connect peer details.
SdkInternalList<T> tags
The tags for the Connect peer.
String transitGatewayAddress
The Connect peer IP address on the transit gateway side of the tunnel.
String peerAddress
The Connect peer IP address on the appliance side of the tunnel.
SdkInternalList<T> insideCidrBlocks
The range of interior BGP peer IP addresses.
String protocol
The tunnel protocol.
SdkInternalList<T> bgpConfigurations
The BGP configuration details.
Long peerAsn
The peer Autonomous System Number (ASN).
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
SdkInternalList<T> deregisteredNetworkInterfaceIds
The network interface IDs of the deregistered members.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
SdkInternalList<T> deregisteredNetworkInterfaceIds
The network interface IDs of the non-registered members.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String transitGatewayId
The ID of the transit gateway.
String transitGatewayMulticastDomainArn
The Amazon Resource Name (ARN) of the transit gateway multicast domain.
String ownerId
The ID of the AWS account that owns the transit gateway multiicast domain.
TransitGatewayMulticastDomainOptions options
The options for the transit gateway multicast domain.
String state
The state of the transit gateway multicast domain.
Date creationTime
The time the transit gateway multicast domain was created.
SdkInternalList<T> tags
The tags for the transit gateway multicast domain.
String transitGatewayAttachmentId
The ID of the transit gateway attachment.
String resourceId
The ID of the resource.
String resourceType
The type of resource, for example a VPC attachment.
String resourceOwnerId
The ID of the AWS account that owns the transit gateway multicast domain association resource.
SubnetAssociation subnet
The subnet associated with the transit gateway multicast domain.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
String transitGatewayAttachmentId
The ID of the transit gateway attachment.
String resourceId
The ID of the resource.
String resourceType
The type of resource, for example a VPC attachment.
String resourceOwnerId
The ID of the AWS account that owns the resource.
SdkInternalList<T> subnets
The subnets associated with the multicast domain.
String igmpv2Support
Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
String staticSourcesSupport
Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
String autoAcceptSharedAssociations
Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
String transitGatewayAttachmentId
The ID of the transit gateway attachment.
String subnetId
The ID of the subnet.
String resourceId
The ID of the resource.
String resourceType
The type of resource, for example a VPC attachment.
String resourceOwnerId
The ID of the AWS account that owns the transit gateway multicast domain group resource.
String networkInterfaceId
The ID of the transit gateway attachment.
Boolean groupMember
Indicates that the resource is a transit gateway multicast group member.
Boolean groupSource
Indicates that the resource is a transit gateway multicast group member.
String memberType
The member type (for example, static
).
String sourceType
The source type.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
SdkInternalList<T> registeredNetworkInterfaceIds
The ID of the registered network interfaces.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
String transitGatewayMulticastDomainId
The ID of the transit gateway multicast domain.
SdkInternalList<T> registeredNetworkInterfaceIds
The IDs of the network interfaces members registered with the transit gateway multicast group.
String groupIpAddress
The IP address assigned to the transit gateway multicast group.
Long amazonSideAsn
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
SdkInternalList<T> transitGatewayCidrBlocks
The transit gateway CIDR blocks.
String autoAcceptSharedAttachments
Indicates whether attachment requests are automatically accepted.
String defaultRouteTableAssociation
Indicates whether resource attachments are automatically associated with the default association route table.
String associationDefaultRouteTableId
The ID of the default association route table.
String defaultRouteTablePropagation
Indicates whether resource attachments automatically propagate routes to the default propagation route table.
String propagationDefaultRouteTableId
The ID of the default propagation route table.
String vpnEcmpSupport
Indicates whether Equal Cost Multipath Protocol support is enabled.
String dnsSupport
Indicates whether DNS support is enabled.
String multicastSupport
Indicates whether multicast is enabled on the transit gateway
String transitGatewayAttachmentId
The ID of the transit gateway peering attachment.
PeeringTgwInfo requesterTgwInfo
Information about the requester transit gateway.
PeeringTgwInfo accepterTgwInfo
Information about the accepter transit gateway.
PeeringAttachmentStatus status
The status of the transit gateway peering attachment.
String state
The state of the transit gateway peering attachment. Note that the initiating
state has been
deprecated.
Date creationTime
The time the transit gateway peering attachment was created.
SdkInternalList<T> tags
The tags for the transit gateway peering attachment.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
String prefixListId
The ID of the prefix list.
String prefixListOwnerId
The ID of the prefix list owner.
String state
The state of the prefix list reference.
Boolean blackhole
Indicates whether traffic that matches this route is dropped.
TransitGatewayPrefixListAttachment transitGatewayAttachment
Information about the transit gateway attachment.
String transitGatewayAttachmentId
The ID of the attachment.
String resourceId
The ID of the resource.
String resourceType
The resource type. Note that the tgw-peering
resource type has been deprecated.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
String state
The state.
Long amazonSideAsn
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for
16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512
.
String autoAcceptSharedAttachments
Enable or disable automatic acceptance of attachment requests. Disabled by default.
String defaultRouteTableAssociation
Enable or disable automatic association with the default association route table. Enabled by default.
String defaultRouteTablePropagation
Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
String vpnEcmpSupport
Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
String dnsSupport
Enable or disable DNS support. Enabled by default.
String multicastSupport
Indicates whether multicast is enabled on the transit gateway
SdkInternalList<T> transitGatewayCidrBlocks
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
String destinationCidrBlock
The CIDR block used for destination matches.
String prefixListId
The ID of the prefix list used for destination matches.
SdkInternalList<T> transitGatewayAttachments
The attachments.
String type
The route type.
String state
The state of the route.
String transitGatewayRouteTableId
The ID of the transit gateway route table.
String transitGatewayId
The ID of the transit gateway.
String state
The state of the transit gateway route table.
Boolean defaultAssociationRouteTable
Indicates whether this is the default association route table for the transit gateway.
Boolean defaultPropagationRouteTable
Indicates whether this is the default propagation route table for the transit gateway.
Date creationTime
The creation time.
SdkInternalList<T> tags
Any tags assigned to the route table.
String transitGatewayAttachmentId
The ID of the attachment.
String resourceId
The ID of the resource.
String resourceType
The resource type. Note that the tgw-peering
resource type has been deprecated.
String state
The state of the association.
String transitGatewayAttachmentId
The ID of the attachment.
String resourceId
The ID of the resource.
String resourceType
The type of resource. Note that the tgw-peering
resource type has been deprecated.
String state
The state of the resource.
String transitGatewayAttachmentId
The ID of the attachment.
String transitGatewayId
The ID of the transit gateway.
String vpcId
The ID of the VPC.
String vpcOwnerId
The ID of the AWS account that owns the VPC.
String state
The state of the VPC attachment. Note that the initiating
state has been deprecated.
SdkInternalList<T> subnetIds
The IDs of the subnets.
Date creationTime
The creation time.
TransitGatewayVpcAttachmentOptions options
The VPC attachment options.
SdkInternalList<T> tags
The tags for the VPC attachment.
String outsideIpAddress
The external IP address of the VPN tunnel.
String tunnelInsideCidr
The range of inside IPv4 addresses for the tunnel.
String tunnelInsideIpv6Cidr
The range of inside IPv6 addresses for the tunnel.
String preSharedKey
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Integer phase1LifetimeSeconds
The lifetime for phase 1 of the IKE negotiation, in seconds.
Integer phase2LifetimeSeconds
The lifetime for phase 2 of the IKE negotiation, in seconds.
Integer rekeyMarginTimeSeconds
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
Integer rekeyFuzzPercentage
The percentage of the rekey window determined by RekeyMarginTimeSeconds
during which the rekey time
is randomly selected.
Integer replayWindowSize
The number of packets in an IKE replay window.
Integer dpdTimeoutSeconds
The number of seconds after which a DPD timeout occurs.
String dpdTimeoutAction
The action to take after a DPD timeout occurs.
SdkInternalList<T> phase1EncryptionAlgorithms
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
SdkInternalList<T> phase2EncryptionAlgorithms
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
SdkInternalList<T> phase1IntegrityAlgorithms
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
SdkInternalList<T> phase2IntegrityAlgorithms
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
SdkInternalList<T> phase1DHGroupNumbers
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
SdkInternalList<T> phase2DHGroupNumbers
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
SdkInternalList<T> ikeVersions
The IKE versions that are permitted for the VPN tunnel.
String startupAction
The action to take when the establishing the VPN tunnels for a VPN connection.
SdkInternalList<T> ipv6Addresses
The IPv6 addresses to unassign from the network interface.
String networkInterfaceId
The ID of the network interface.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> unassignedIpv6Addresses
The IPv6 addresses that have been unassigned from the network interface.
String networkInterfaceId
The ID of the network interface.
SdkInternalList<T> privateIpAddresses
The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
SdkInternalList<T> instanceIds
The IDs of the instances.
SdkInternalList<T> instanceMonitorings
The monitoring information.
String instanceId
The ID of the instance.
UnsuccessfulInstanceCreditSpecificationItemError error
The applicable error for the burstable performance instance whose credit option for CPU usage was not modified.
UnsuccessfulItemError error
Information about the error.
String resourceId
The ID of the resource.
String groupId
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
String groupName
[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
SdkInternalList<T> ipPermissions
The IP permissions for the security group rule.
Boolean returnValue
Returns true
if the request succeeds; otherwise, returns an error.
String groupId
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
String groupName
[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.
SdkInternalList<T> ipPermissions
The IP permissions for the security group rule.
Boolean returnValue
Returns true
if the request succeeds; otherwise, returns an error.
String data
The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
String description
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
String groupId
The ID of the security group.
String groupName
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
String peeringStatus
The status of a VPC peering connection, if applicable.
String userId
The ID of an AWS account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.
String vpcId
The ID of the VPC for the referenced security group, if applicable.
String vpcPeeringConnectionId
The ID of the VPC peering connection, if applicable.
String code
The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.
String message
The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes.
SdkInternalList<T> errors
The error codes and error messages.
Integer defaultVCpus
The default number of vCPUs for the instance type.
Integer defaultCores
The default number of cores for the instance type.
Integer defaultThreadsPerCore
The default number of threads per core for the instance type.
SdkInternalList<T> validCores
The valid number of cores that can be configured for the instance type.
SdkInternalList<T> validThreadsPerCore
The valid number of threads per core that can be configured for the instance type.
Integer acceptedRouteCount
The number of accepted routes.
Date lastStatusChange
The date and time of the last change in status.
String outsideIpAddress
The Internet-routable IP address of the virtual private gateway's outside interface.
String status
The status of the VPN tunnel.
String statusMessage
If an error occurs, a description of the error.
String certificateArn
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
SdkInternalList<T> attachments
Information about the volume attachments.
String availabilityZone
The Availability Zone for the volume.
Date createTime
The time stamp when volume creation was initiated.
Boolean encrypted
Indicates whether the volume is encrypted.
String kmsKeyId
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
Integer size
The size of the volume, in GiBs.
String snapshotId
The snapshot from which the volume was created, if applicable.
String state
The volume state.
String volumeId
The ID of the volume.
Integer iops
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes,
this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits
for bursting.
SdkInternalList<T> tags
Any tags assigned to the volume.
String volumeType
The volume type.
Boolean fastRestored
Indicates whether the volume was created using fast snapshot restore.
Boolean multiAttachEnabled
Indicates whether Amazon EBS Multi-Attach is enabled.
Integer throughput
The throughput that the volume supports, in MiB/s.
Date attachTime
The time stamp when the attachment initiated.
String device
The device name.
String instanceId
The ID of the instance.
String state
The attachment state of the volume.
String volumeId
The ID of the volume.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Long size
The size of the volume, in GiB.
String volumeId
The ID of the volume.
String modificationState
The current modification state. The modification state is null for unmodified volumes.
String statusMessage
A status message about the modification progress or failure.
Integer targetSize
The target size of the volume, in GiB.
Integer targetIops
The target IOPS rate of the volume.
String targetVolumeType
The target EBS volume type of the volume.
Integer targetThroughput
The target throughput of the volume, in MiB/s.
Boolean targetMultiAttachEnabled
The target setting for Amazon EBS Multi-Attach.
Integer originalSize
The original size of the volume, in GiB.
Integer originalIops
The original IOPS rate of the volume.
String originalVolumeType
The original EBS volume type of the volume.
Integer originalThroughput
The original throughput of the volume, in MiB/s.
Boolean originalMultiAttachEnabled
The original setting for Amazon EBS Multi-Attach.
Long progress
The modification progress, from 0 to 100 percent complete.
Date startTime
The modification start time.
Date endTime
The modification completion or failure time.
String description
A description of the event.
String eventId
The ID of this event.
String eventType
The type of this event.
Date notAfter
The latest end time of the event.
Date notBefore
The earliest start time of the event.
String instanceId
The ID of the instance associated with the event.
SdkInternalList<T> details
The details of the volume status.
String status
The status of the volume.
SdkInternalList<T> actions
The details of the operation.
String availabilityZone
The Availability Zone of the volume.
String outpostArn
The Amazon Resource Name (ARN) of the Outpost.
SdkInternalList<T> events
A list of events associated with the volume.
String volumeId
The volume ID.
VolumeStatusInfo volumeStatus
The volume status.
SdkInternalList<T> attachmentStatuses
Information about the instances to which the volume is attached.
String cidrBlock
The primary IPv4 CIDR block for the VPC.
String dhcpOptionsId
The ID of the set of DHCP options you've associated with the VPC.
String state
The current state of the VPC.
String vpcId
The ID of the VPC.
String ownerId
The ID of the AWS account that owns the VPC.
String instanceTenancy
The allowed tenancy of instances launched into the VPC.
SdkInternalList<T> ipv6CidrBlockAssociationSet
Information about the IPv6 CIDR blocks associated with the VPC.
SdkInternalList<T> cidrBlockAssociationSet
Information about the IPv4 CIDR blocks associated with the VPC.
Boolean isDefault
Indicates whether the VPC is the default VPC.
SdkInternalList<T> tags
Any tags assigned to the VPC.
String associationId
The association ID for the IPv4 CIDR block.
String cidrBlock
The IPv4 CIDR block.
VpcCidrBlockState cidrBlockState
Information about the state of the CIDR block.
Boolean classicLinkEnabled
Indicates whether the VPC is enabled for ClassicLink.
SdkInternalList<T> tags
Any tags assigned to the VPC.
String vpcId
The ID of the VPC.
String vpcEndpointId
The ID of the VPC endpoint.
String vpcEndpointType
The type of endpoint.
String vpcId
The ID of the VPC to which the endpoint is associated.
String serviceName
The name of the service to which the endpoint is associated.
String state
The state of the VPC endpoint.
String policyDocument
The policy document associated with the endpoint, if applicable.
SdkInternalList<T> routeTableIds
(Gateway endpoint) One or more route tables associated with the endpoint.
SdkInternalList<T> subnetIds
(Interface endpoint) One or more subnets in which the endpoint is located.
SdkInternalList<T> groups
(Interface endpoint) Information about the security groups that are associated with the network interface.
Boolean privateDnsEnabled
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
Boolean requesterManaged
Indicates whether the VPC endpoint is being managed by its service.
SdkInternalList<T> networkInterfaceIds
(Interface endpoint) One or more network interfaces for the endpoint.
SdkInternalList<T> dnsEntries
(Interface endpoint) The DNS entries for the endpoint.
Date creationTimestamp
The date and time that the VPC endpoint was created.
SdkInternalList<T> tags
Any tags assigned to the VPC endpoint.
String ownerId
The ID of the AWS account that owns the VPC endpoint.
LastError lastError
The last error that occurred for VPC endpoint.
String serviceId
The ID of the service to which the endpoint is connected.
String vpcEndpointId
The ID of the VPC endpoint.
String vpcEndpointOwner
The AWS account ID of the owner of the VPC endpoint.
String vpcEndpointState
The state of the VPC endpoint.
Date creationTimestamp
The date and time that the VPC endpoint was created.
SdkInternalList<T> dnsEntries
The DNS entries for the VPC endpoint.
SdkInternalList<T> networkLoadBalancerArns
The Amazon Resource Names (ARNs) of the network load balancers for the service.
SdkInternalList<T> gatewayLoadBalancerArns
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
String associationId
The association ID for the IPv6 CIDR block.
String ipv6CidrBlock
The IPv6 CIDR block.
VpcCidrBlockState ipv6CidrBlockState
Information about the state of the CIDR block.
String networkBorderGroup
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP
addresses, for example, us-east-1-wl1-bos-wlz-1
.
String ipv6Pool
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
VpcPeeringConnectionVpcInfo accepterVpcInfo
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
Date expirationTime
The time that an unaccepted VPC peering connection will expire.
VpcPeeringConnectionVpcInfo requesterVpcInfo
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
VpcPeeringConnectionStateReason status
The status of the VPC peering connection.
SdkInternalList<T> tags
Any tags assigned to the resource.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
Boolean allowDnsResolutionFromRemoteVpc
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
Boolean allowEgressFromLocalClassicLinkToRemoteVpc
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
Boolean allowEgressFromLocalVpcToRemoteClassicLink
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
String cidrBlock
The IPv4 CIDR block for the VPC.
SdkInternalList<T> ipv6CidrBlockSet
The IPv6 CIDR block for the VPC.
SdkInternalList<T> cidrBlockSet
Information about the IPv4 CIDR blocks for the VPC.
String ownerId
The AWS account ID of the VPC owner.
VpcPeeringConnectionOptionsDescription peeringOptions
Information about the VPC peering connection options for the accepter or requester VPC.
String vpcId
The ID of the VPC.
String region
The Region in which the VPC is located.
String customerGatewayConfiguration
The configuration information for the VPN connection's customer gateway (in the native XML format). This element
is always present in the CreateVpnConnection response; however, it's present in the
DescribeVpnConnections response only if the VPN connection is in the pending
or
available
state.
String customerGatewayId
The ID of the customer gateway at your end of the VPN connection.
String category
The category of the VPN connection. A value of VPN
indicates an AWS VPN connection. A value of
VPN-Classic
indicates an AWS Classic VPN connection.
String state
The current state of the VPN connection.
String type
The type of VPN connection.
String vpnConnectionId
The ID of the VPN connection.
String vpnGatewayId
The ID of the virtual private gateway at the AWS side of the VPN connection.
String transitGatewayId
The ID of the transit gateway associated with the VPN connection.
VpnConnectionOptions options
The VPN connection options.
SdkInternalList<T> routes
The static routes associated with the VPN connection.
SdkInternalList<T> tags
Any tags assigned to the VPN connection.
SdkInternalList<T> vgwTelemetry
Information about the VPN tunnel.
Boolean enableAcceleration
Indicates whether acceleration is enabled for 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.
String localIpv4NetworkCidr
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
String remoteIpv4NetworkCidr
The IPv4 CIDR on the AWS side of the VPN connection.
String localIpv6NetworkCidr
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
String remoteIpv6NetworkCidr
The IPv6 CIDR on the AWS side of the VPN connection.
String tunnelInsideIpVersion
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
SdkInternalList<T> tunnelOptions
Indicates the VPN tunnel options.
Boolean enableAcceleration
Indicate whether to enable acceleration for the VPN connection.
Default: false
Boolean staticRoutesOnly
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device
that does not support BGP, you must specify true
. Use CreateVpnConnectionRoute to create a
static route.
Default: false
String tunnelInsideIpVersion
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
SdkInternalList<T> tunnelOptions
The tunnel options for the VPN connection.
String localIpv4NetworkCidr
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
String remoteIpv4NetworkCidr
The IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
String localIpv6NetworkCidr
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
String remoteIpv6NetworkCidr
The IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
String availabilityZone
The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
String state
The current state of the virtual private gateway.
String type
The type of VPN connection the virtual private gateway supports.
SdkInternalList<T> vpcAttachments
Any VPCs attached to the virtual private gateway.
String vpnGatewayId
The ID of the virtual private gateway.
Long amazonSideAsn
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
SdkInternalList<T> tags
Any tags assigned to the virtual private gateway.
String tunnelInsideCidr
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16
range. The following CIDR blocks are
reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
String tunnelInsideIpv6Cidr
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8
range.
String preSharedKey
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
Integer phase1LifetimeSeconds
The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
Integer phase2LifetimeSeconds
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for
Phase1LifetimeSeconds
.
Default: 3600
Integer rekeyMarginTimeSeconds
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection
performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for
RekeyFuzzPercentage
.
Constraints: A value between 60 and half of Phase2LifetimeSeconds
.
Default: 540
Integer rekeyFuzzPercentage
The percentage of the rekey window (determined by RekeyMarginTimeSeconds
) during which the rekey
time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
Integer replayWindowSize
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
Integer dPDTimeoutSeconds
The number of seconds after which a DPD timeout occurs.
Constraints: A value between 0 and 30.
Default: 30
String dPDTimeoutAction
The action to take after DPD timeout occurs. Specify restart
to restart the IKE initiation. Specify
clear
to end the IKE session.
Valid Values: clear
| none
| restart
Default: clear
SdkInternalList<T> phase1EncryptionAlgorithms
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128
| AES256
| AES128-GCM-16
| AES256-GCM-16
SdkInternalList<T> phase2EncryptionAlgorithms
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128
| AES256
| AES128-GCM-16
| AES256-GCM-16
SdkInternalList<T> phase1IntegrityAlgorithms
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1
| SHA2-256
| SHA2-384
| SHA2-512
SdkInternalList<T> phase2IntegrityAlgorithms
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1
| SHA2-256
| SHA2-384
| SHA2-512
SdkInternalList<T> phase1DHGroupNumbers
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2
| 14
| 15
| 16
| 17
|
18
| 19
| 20
| 21
| 22
| 23
|
24
SdkInternalList<T> phase2DHGroupNumbers
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2
| 5
| 14
| 15
| 16
|
17
| 18
| 19
| 20
| 21
| 22
|
23
| 24
SdkInternalList<T> iKEVersions
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1
| ikev2
String startupAction
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway
device must initiate the IKE negotiation and bring up the tunnel. Specify start
for AWS to initiate
the IKE negotiation.
Valid Values: add
| start
Default: add
String cidr
The address range, in CIDR notation.
ByoipCidr byoipCidr
Information about the address pool.
Copyright © 2021. All rights reserved.