From 227e3996228d3f95ec312a21e6cb103f7c500629 Mon Sep 17 00:00:00 2001
From: awstools Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon Virtual Private Cloud User Guide. Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created * from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own - * IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
+ * IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide. *If you release an Elastic IP address, you might be able to recover it. You cannot recover * an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify * it in this operation.
- *For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
+ *For more information, see Elastic IP Addresses in the Amazon EC2 User Guide.
*You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, * to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
* @example diff --git a/clients/client-ec2/src/commands/AssignIpv6AddressesCommand.ts b/clients/client-ec2/src/commands/AssignIpv6AddressesCommand.ts index 391f8354d630..5aa6b78babc1 100644 --- a/clients/client-ec2/src/commands/AssignIpv6AddressesCommand.ts +++ b/clients/client-ec2/src/commands/AssignIpv6AddressesCommand.ts @@ -32,13 +32,12 @@ export interface AssignIpv6AddressesCommandOutput extends AssignIpv6AddressesRes * specify one or more specific IPv6 addresses, or you can specify the number of IPv6 * addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. * You can assign as many IPv6 addresses to a network interface as you can assign private - * IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type - * in the Amazon Elastic Compute Cloud User Guide. + * IPv4 addresses, and the limit varies per instance type. *You must specify either the IPv6 addresses or the IPv6 address count in the request.
*You can optionally use Prefix Delegation on the network interface. You must specify * either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For * information, see - * Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
+ * Assigning prefixes to network interfaces in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/AssignPrivateIpAddressesCommand.ts b/clients/client-ec2/src/commands/AssignPrivateIpAddressesCommand.ts index 055514e1081f..cfd145b548d5 100644 --- a/clients/client-ec2/src/commands/AssignPrivateIpAddressesCommand.ts +++ b/clients/client-ec2/src/commands/AssignPrivateIpAddressesCommand.ts @@ -32,8 +32,7 @@ export interface AssignPrivateIpAddressesCommandOutput extends AssignPrivateIpAd *You can specify one or more specific secondary IP addresses, or you can specify the number * of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. * The number of secondary IP addresses that you can assign to an instance varies by instance type. - * For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about - * Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
+ * For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide. *When you move a secondary private IP address to another network interface, any Elastic IP address * that is associated with the IP address is also moved.
*Remapping an IP address is an asynchronous operation. When you move an IP address from one network @@ -43,7 +42,7 @@ export interface AssignPrivateIpAddressesCommandOutput extends AssignPrivateIpAd *
You can optionally use Prefix Delegation on the network interface. You must specify * either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For * information, see - * Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
+ * Assigning prefixes to network interfaces in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/AssignPrivateNatGatewayAddressCommand.ts b/clients/client-ec2/src/commands/AssignPrivateNatGatewayAddressCommand.ts index 62e985932da4..5445373c1b32 100644 --- a/clients/client-ec2/src/commands/AssignPrivateNatGatewayAddressCommand.ts +++ b/clients/client-ec2/src/commands/AssignPrivateNatGatewayAddressCommand.ts @@ -33,7 +33,7 @@ export interface AssignPrivateNatGatewayAddressCommandOutput __MetadataBearer {} /** - *Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see + *
Assigns private IPv4 addresses to a private NAT gateway. For more information, see * Work with NAT gateways in the Amazon VPC User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts b/clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts index d9a69c5daac5..b281b0413ee0 100644 --- a/clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts +++ b/clients/client-ec2/src/commands/AssociateDhcpOptionsCommand.ts @@ -30,7 +30,7 @@ export interface AssociateDhcpOptionsCommandOutput extends __MetadataBearer {} /** *Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
*After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
- *For more information, see DHCP options sets + *
For more information, see DHCP option sets * in the Amazon VPC User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/AssociateNatGatewayAddressCommand.ts b/clients/client-ec2/src/commands/AssociateNatGatewayAddressCommand.ts index 4b02f8e04073..8c958619cf7a 100644 --- a/clients/client-ec2/src/commands/AssociateNatGatewayAddressCommand.ts +++ b/clients/client-ec2/src/commands/AssociateNatGatewayAddressCommand.ts @@ -30,7 +30,8 @@ export interface AssociateNatGatewayAddressCommandOutput extends AssociateNatGat /** *Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, * see Work with NAT gateways in the Amazon VPC User Guide.
- *By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
+ *By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. + * For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
*When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. *
diff --git a/clients/client-ec2/src/commands/AssociateTrunkInterfaceCommand.ts b/clients/client-ec2/src/commands/AssociateTrunkInterfaceCommand.ts index 679aa17d4b61..366f47a84f5c 100644 --- a/clients/client-ec2/src/commands/AssociateTrunkInterfaceCommand.ts +++ b/clients/client-ec2/src/commands/AssociateTrunkInterfaceCommand.ts @@ -29,8 +29,10 @@ export interface AssociateTrunkInterfaceCommandOutput extends AssociateTrunkInte /** *Associates a branch network interface with a trunk network interface.
- *Before you create the association, run the create-network-interface command and set
- * --interface-type
to trunk
. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
Before you create the association, use CreateNetworkInterface command and set the interface type
+ * to trunk
. You must also create a network interface for
+ * each branch network interface that you want to associate with the trunk
+ * network interface.
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, * an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that - * you provisioned through bring your own IP addresses (BYOIP).
+ * you provisioned through bring your own IP addresses (BYOIP). *You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 * pool, or an Amazon-provided IPv6 CIDR block.
*For more information about associating CIDR blocks with your VPC and applicable diff --git a/clients/client-ec2/src/commands/CancelReservedInstancesListingCommand.ts b/clients/client-ec2/src/commands/CancelReservedInstancesListingCommand.ts index 359a333fa912..d288315f4061 100644 --- a/clients/client-ec2/src/commands/CancelReservedInstancesListingCommand.ts +++ b/clients/client-ec2/src/commands/CancelReservedInstancesListingCommand.ts @@ -34,9 +34,8 @@ export interface CancelReservedInstancesListingCommandOutput /** *
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
- *For more information, see - * Reserved Instance Marketplace - * in the Amazon EC2 User Guide.
+ *For more information, see Sell in the Reserved Instance + * Marketplace in the Amazon EC2 User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CopySnapshotCommand.ts b/clients/client-ec2/src/commands/CopySnapshotCommand.ts index 2b8b0b578f3a..c359cfe2a1f3 100644 --- a/clients/client-ec2/src/commands/CopySnapshotCommand.ts +++ b/clients/client-ec2/src/commands/CopySnapshotCommand.ts @@ -36,8 +36,8 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat *You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
*When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. * Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the - * snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) - * KMS key; however, you can specify a different KMS key. To copy an encrypted + * snapshot copy operation. By default, encrypted snapshot copies use the default KMS key; + * however, you can specify a different KMS key. To copy an encrypted * snapshot that has been shared from another account, you must have permissions for the KMS key * used to encrypt the snapshot.
*Snapshots copied to an Outpost are encrypted by default using the default diff --git a/clients/client-ec2/src/commands/CreateCapacityReservationFleetCommand.ts b/clients/client-ec2/src/commands/CreateCapacityReservationFleetCommand.ts index 53c16eabb5ed..61c9b2eb1be7 100644 --- a/clients/client-ec2/src/commands/CreateCapacityReservationFleetCommand.ts +++ b/clients/client-ec2/src/commands/CreateCapacityReservationFleetCommand.ts @@ -33,8 +33,9 @@ export interface CreateCapacityReservationFleetCommandOutput __MetadataBearer {} /** - *
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity - * Reservation Fleet in the Amazon EC2 User Guide.
+ *Creates a Capacity Reservation Fleet. For more information, see Create a + * Capacity Reservation Fleet in the + * Amazon EC2 User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateDhcpOptionsCommand.ts b/clients/client-ec2/src/commands/CreateDhcpOptionsCommand.ts index 6e2a719fff29..bed925e28e0e 100644 --- a/clients/client-ec2/src/commands/CreateDhcpOptionsCommand.ts +++ b/clients/client-ec2/src/commands/CreateDhcpOptionsCommand.ts @@ -32,7 +32,7 @@ export interface CreateDhcpOptionsCommandOutput extends CreateDhcpOptionsResult, * it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly * launched instances in the VPC use this set of DHCP options. *The following are the individual DHCP options you can specify. For more information, see - * DHCP options sets + * DHCP option sets * in the Amazon VPC User Guide.
*
* netbios-node-type
- The NetBIOS node type (1, 2, 4, or 8). We recommend that
* you specify 2. Broadcast and multicast are not supported. For more information about
- * NetBIOS node types, see RFC 2132.
diff --git a/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts b/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts index 128937bc9086..90f71dc42be5 100644 --- a/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts +++ b/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts @@ -33,12 +33,13 @@ export interface CreateFlowLogsCommandOutput extends CreateFlowLogsResult, __Met *
Flow log data for a monitored network interface is recorded as flow log records, which are log events * consisting of fields that describe the traffic flow. For more information, see * Flow log records - * in the Amazon Virtual Private Cloud User Guide.
+ * in the Amazon VPC User Guide. *When publishing to CloudWatch Logs, flow log records are published to a log group, and each network * interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all * of the monitored network interfaces are published to a single log file object that is stored in the specified * bucket.
- *For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
+ *For more information, see VPC Flow Logs + * in the Amazon VPC User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateInstanceConnectEndpointCommand.ts b/clients/client-ec2/src/commands/CreateInstanceConnectEndpointCommand.ts index 5080da017f0d..ca1e28009537 100644 --- a/clients/client-ec2/src/commands/CreateInstanceConnectEndpointCommand.ts +++ b/clients/client-ec2/src/commands/CreateInstanceConnectEndpointCommand.ts @@ -33,8 +33,7 @@ export interface CreateInstanceConnectEndpointCommandOutput *Creates an EC2 Instance Connect Endpoint.
*An EC2 Instance Connect Endpoint allows you to connect to an instance, without * requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2 - * Instance Connect Endpoint in the Amazon EC2 User - * Guide.
+ * Instance Connect Endpoint in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateLaunchTemplateCommand.ts b/clients/client-ec2/src/commands/CreateLaunchTemplateCommand.ts index 959935b20b4a..4cd4df2fd405 100644 --- a/clients/client-ec2/src/commands/CreateLaunchTemplateCommand.ts +++ b/clients/client-ec2/src/commands/CreateLaunchTemplateCommand.ts @@ -37,11 +37,11 @@ export interface CreateLaunchTemplateCommandOutput extends CreateLaunchTemplateR * instance using RunInstances, you can specify a launch template instead * of providing the launch parameters in the request. For more information, see Launch * an instance from a launch template in the - * Amazon Elastic Compute Cloud User Guide. + * Amazon EC2 User Guide. *To clone an existing launch template as the basis for a new launch template, use the * Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more * information, see Create a launch template from an existing launch template in the - * Amazon Elastic Compute Cloud User Guide.
+ * Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateLaunchTemplateVersionCommand.ts b/clients/client-ec2/src/commands/CreateLaunchTemplateVersionCommand.ts index 79ce4218b003..dc6074684a07 100644 --- a/clients/client-ec2/src/commands/CreateLaunchTemplateVersionCommand.ts +++ b/clients/client-ec2/src/commands/CreateLaunchTemplateVersionCommand.ts @@ -42,7 +42,7 @@ export interface CreateLaunchTemplateVersionCommandOutput extends CreateLaunchTe * it. Instead, you can create a new version of the launch template that includes the * changes that you require. *For more information, see Modify a launch template (manage launch template versions) in the - * Amazon Elastic Compute Cloud User Guide.
+ * Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateNetworkInterfaceCommand.ts b/clients/client-ec2/src/commands/CreateNetworkInterfaceCommand.ts index 80899ac43ad8..3a43ed6f8fa1 100644 --- a/clients/client-ec2/src/commands/CreateNetworkInterfaceCommand.ts +++ b/clients/client-ec2/src/commands/CreateNetworkInterfaceCommand.ts @@ -31,10 +31,9 @@ export interface CreateNetworkInterfaceCommandOutput extends CreateNetworkInterf /** *Creates a network interface in the specified subnet.
*The number of IP addresses you can assign to a network interface varies by instance - * type. For more information, see IP Addresses Per ENI Per - * Instance Type in the Amazon Virtual Private Cloud User Guide.
+ * type. *For more information about network interfaces, see Elastic network interfaces - * in the Amazon Elastic Compute Cloud User Guide.
+ * in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateReplaceRootVolumeTaskCommand.ts b/clients/client-ec2/src/commands/CreateReplaceRootVolumeTaskCommand.ts index e682f70cf5d3..843772aa12e0 100644 --- a/clients/client-ec2/src/commands/CreateReplaceRootVolumeTaskCommand.ts +++ b/clients/client-ec2/src/commands/CreateReplaceRootVolumeTaskCommand.ts @@ -32,7 +32,7 @@ export interface CreateReplaceRootVolumeTaskCommandOutput extends CreateReplaceR * volume that is restored to the original root volume's launch state, that is restored to a * specific snapshot taken from the original root volume, or that is restored from an AMI * that has the same key characteristics as that of the instance. - *For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
+ *For more information, see Replace a root volume in the Amazon EC2 User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateReservedInstancesListingCommand.ts b/clients/client-ec2/src/commands/CreateReservedInstancesListingCommand.ts index 24dbc4b31ae2..6c574acc0260 100644 --- a/clients/client-ec2/src/commands/CreateReservedInstancesListingCommand.ts +++ b/clients/client-ec2/src/commands/CreateReservedInstancesListingCommand.ts @@ -47,8 +47,8 @@ export interface CreateReservedInstancesListingCommandOutput * to receive for them. Your Standard Reserved Instance listings then become available for purchase. To * view the details of your Standard Reserved Instance listing, you can use the * DescribeReservedInstancesListings operation. - *For more information, see Reserved Instance Marketplace in the - * Amazon EC2 User Guide.
+ *For more information, see Sell in the Reserved Instance + * Marketplace in the Amazon EC2 User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateSnapshotCommand.ts b/clients/client-ec2/src/commands/CreateSnapshotCommand.ts index 663201b65570..f679a135561c 100644 --- a/clients/client-ec2/src/commands/CreateSnapshotCommand.ts +++ b/clients/client-ec2/src/commands/CreateSnapshotCommand.ts @@ -51,8 +51,8 @@ export interface CreateSnapshotCommandOutput extends Snapshot, __MetadataBearer * are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes * and any associated snapshots always remain protected. *You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 - * resources in the Amazon Elastic Compute Cloud User Guide.
- *For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon EBS User Guide.
+ * resources in the Amazon EC2 User Guide. + *For more information, see Amazon EBS and Amazon EBS encryption in the Amazon EBS User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateSpotDatafeedSubscriptionCommand.ts b/clients/client-ec2/src/commands/CreateSpotDatafeedSubscriptionCommand.ts index cedc2aab6e48..aa3a59a61c67 100644 --- a/clients/client-ec2/src/commands/CreateSpotDatafeedSubscriptionCommand.ts +++ b/clients/client-ec2/src/commands/CreateSpotDatafeedSubscriptionCommand.ts @@ -36,7 +36,7 @@ export interface CreateSpotDatafeedSubscriptionCommandOutput *Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. * You can create one data feed per Amazon Web Services account. For more information, see * Spot Instance data feed - * in the Amazon EC2 User Guide for Linux Instances.
+ * in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateSubnetCidrReservationCommand.ts b/clients/client-ec2/src/commands/CreateSubnetCidrReservationCommand.ts index 45677523bd6d..c5b63c89ad12 100644 --- a/clients/client-ec2/src/commands/CreateSubnetCidrReservationCommand.ts +++ b/clients/client-ec2/src/commands/CreateSubnetCidrReservationCommand.ts @@ -29,8 +29,8 @@ export interface CreateSubnetCidrReservationCommandOutput extends CreateSubnetCi /** *Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations - * in the Amazon Virtual Private Cloud User Guide and Assign prefixes - * to network interfaces in the Amazon Elastic Compute Cloud User Guide.
+ * in the Amazon VPC User Guide and Assign prefixes + * to network interfaces in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateTransitGatewayConnectPeerCommand.ts b/clients/client-ec2/src/commands/CreateTransitGatewayConnectPeerCommand.ts index 1d90004d8805..e59dbb251a0f 100644 --- a/clients/client-ec2/src/commands/CreateTransitGatewayConnectPeerCommand.ts +++ b/clients/client-ec2/src/commands/CreateTransitGatewayConnectPeerCommand.ts @@ -36,7 +36,8 @@ export interface CreateTransitGatewayConnectPeerCommandOutput *Creates a Connect peer for a specified transit gateway Connect attachment between a * transit gateway and an appliance.
*The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
- *For more information, see Connect peers in the Transit Gateways Guide.
+ *For more information, see Connect peers + * in the Amazon Web Services Transit Gateways Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateVolumeCommand.ts b/clients/client-ec2/src/commands/CreateVolumeCommand.ts index 7ff9236fc5f5..fb260954f098 100644 --- a/clients/client-ec2/src/commands/CreateVolumeCommand.ts +++ b/clients/client-ec2/src/commands/CreateVolumeCommand.ts @@ -36,7 +36,7 @@ export interface CreateVolumeCommandOutput extends Volume, __MetadataBearer {} * encrypted. For more information, see Amazon EBS encryption * in the Amazon EBS User Guide. *You can tag your volumes during creation. For more information, see Tag your Amazon EC2 - * resources in the Amazon Elastic Compute Cloud User Guide.
+ * resources in the Amazon EC2 User Guide. *For more information, see Create an Amazon EBS volume in the * Amazon EBS User Guide.
* @example diff --git a/clients/client-ec2/src/commands/CreateVpcEndpointConnectionNotificationCommand.ts b/clients/client-ec2/src/commands/CreateVpcEndpointConnectionNotificationCommand.ts index 8b6ca163cc4f..124e930d100d 100644 --- a/clients/client-ec2/src/commands/CreateVpcEndpointConnectionNotificationCommand.ts +++ b/clients/client-ec2/src/commands/CreateVpcEndpointConnectionNotificationCommand.ts @@ -39,8 +39,8 @@ export interface CreateVpcEndpointConnectionNotificationCommandOutput /** *Creates a connection notification for a specified VPC endpoint or VPC endpoint * service. A connection notification notifies you of specific endpoint events. You must - * create an SNS topic to receive notifications. For more information, see Create a Topic in - * the Amazon Simple Notification Service Developer Guide.
+ * create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in + * the Amazon SNS Developer Guide. *You can create a connection notification for interface endpoints only.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/CreateVpcPeeringConnectionCommand.ts b/clients/client-ec2/src/commands/CreateVpcPeeringConnectionCommand.ts index 23b59e75f923..b5c4ad2705f6 100644 --- a/clients/client-ec2/src/commands/CreateVpcPeeringConnectionCommand.ts +++ b/clients/client-ec2/src/commands/CreateVpcPeeringConnectionCommand.ts @@ -34,7 +34,7 @@ export interface CreateVpcPeeringConnectionCommandOutput extends CreateVpcPeerin * The requester VPC and accepter VPC cannot have overlapping CIDR blocks. *Limitations and rules apply to a VPC peering connection. For more information, see - * the limitations section in the VPC Peering Guide.
+ * the VPC peering limitations in the VPC Peering Guide. *The owner of the accepter VPC must accept the peering request to activate the peering * connection. The VPC peering connection request expires after 7 days, after which it diff --git a/clients/client-ec2/src/commands/DeleteLaunchTemplateVersionsCommand.ts b/clients/client-ec2/src/commands/DeleteLaunchTemplateVersionsCommand.ts index b343113725f3..c16d142f2a34 100644 --- a/clients/client-ec2/src/commands/DeleteLaunchTemplateVersionsCommand.ts +++ b/clients/client-ec2/src/commands/DeleteLaunchTemplateVersionsCommand.ts @@ -37,8 +37,8 @@ export interface DeleteLaunchTemplateVersionsCommandOutput *
You can delete up to 200 launch template versions in a single request. To delete more * than 200 versions in a single request, use DeleteLaunchTemplate, which * deletes the launch template and all of its versions.
- *For more information, see Delete a launch template version in the EC2 User - * Guide.
+ *For more information, see Delete a launch template version in the + * Amazon EC2 User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeAddressTransfersCommand.ts b/clients/client-ec2/src/commands/DescribeAddressTransfersCommand.ts index 619e5cff8384..5d97a6b663f5 100644 --- a/clients/client-ec2/src/commands/DescribeAddressTransfersCommand.ts +++ b/clients/client-ec2/src/commands/DescribeAddressTransfersCommand.ts @@ -28,7 +28,7 @@ export interface DescribeAddressTransfersCommandInput extends DescribeAddressTra export interface DescribeAddressTransfersCommandOutput extends DescribeAddressTransfersResult, __MetadataBearer {} /** - *Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
+ *Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
*When you transfer an Elastic IP address, there is a two-step handshake * between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, * the transfer account has seven days to accept the Elastic IP address diff --git a/clients/client-ec2/src/commands/DescribeAvailabilityZonesCommand.ts b/clients/client-ec2/src/commands/DescribeAvailabilityZonesCommand.ts index fd7f010b50ad..9845b9e6dc83 100644 --- a/clients/client-ec2/src/commands/DescribeAvailabilityZonesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeAvailabilityZonesCommand.ts @@ -33,7 +33,7 @@ export interface DescribeAvailabilityZonesCommandOutput extends DescribeAvailabi * provided messages for that zone.
*For more information about Availability Zones, Local Zones, and Wavelength Zones, see * Regions and zones - * in the Amazon Elastic Compute Cloud User Guide.
+ * in the Amazon EC2 User Guide. *The order of the elements in the response, including those within nested
* structures, might vary. Applications should not assume the elements appear in a
diff --git a/clients/client-ec2/src/commands/DescribeClassicLinkInstancesCommand.ts b/clients/client-ec2/src/commands/DescribeClassicLinkInstancesCommand.ts
index e00b8394e2eb..5241a60b9dfb 100644
--- a/clients/client-ec2/src/commands/DescribeClassicLinkInstancesCommand.ts
+++ b/clients/client-ec2/src/commands/DescribeClassicLinkInstancesCommand.ts
@@ -33,7 +33,7 @@ export interface DescribeClassicLinkInstancesCommandOutput
* This action is deprecated.
Describes one or more of your linked EC2-Classic instances. This request only returns + *
Describes your linked EC2-Classic instances. This request only returns * information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot * use this request to return information about other instances.
* @example diff --git a/clients/client-ec2/src/commands/DescribeDhcpOptionsCommand.ts b/clients/client-ec2/src/commands/DescribeDhcpOptionsCommand.ts index 7ede521ea924..10eda669cb94 100644 --- a/clients/client-ec2/src/commands/DescribeDhcpOptionsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeDhcpOptionsCommand.ts @@ -28,8 +28,10 @@ export interface DescribeDhcpOptionsCommandInput extends DescribeDhcpOptionsRequ export interface DescribeDhcpOptionsCommandOutput extends DescribeDhcpOptionsResult, __MetadataBearer {} /** - *Describes one or more of your DHCP options sets.
- *For more information, see DHCP options sets in the + *
Describes your DHCP option sets. The default is to describe all your DHCP option sets. + * Alternatively, you can specify specific DHCP option set IDs or filter the results to + * include only the DHCP option sets that match specific criteria.
+ *For more information, see DHCP option sets in the * Amazon VPC User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/DescribeEgressOnlyInternetGatewaysCommand.ts b/clients/client-ec2/src/commands/DescribeEgressOnlyInternetGatewaysCommand.ts index 3b21340ddf50..80295ac5e619 100644 --- a/clients/client-ec2/src/commands/DescribeEgressOnlyInternetGatewaysCommand.ts +++ b/clients/client-ec2/src/commands/DescribeEgressOnlyInternetGatewaysCommand.ts @@ -36,7 +36,9 @@ export interface DescribeEgressOnlyInternetGatewaysCommandOutput __MetadataBearer {} /** - *Describes one or more of your egress-only internet gateways.
+ *Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. + * Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to + * include only the egress-only internet gateways that match specific criteria.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeElasticGpusCommand.ts b/clients/client-ec2/src/commands/DescribeElasticGpusCommand.ts index 3ec7e1f941d6..15dd6d11d3d4 100644 --- a/clients/client-ec2/src/commands/DescribeElasticGpusCommand.ts +++ b/clients/client-ec2/src/commands/DescribeElasticGpusCommand.ts @@ -29,12 +29,10 @@ export interface DescribeElasticGpusCommandOutput extends DescribeElasticGpusRes /** *Amazon Elastic Graphics reached end of life on January 8, 2024. For - * workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, - * G4dn, or G5 instances.
+ *Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, + * we recommend that you use Amazon EC2 G4, G5, or G6 instances.
*Describes the Elastic Graphics accelerator associated with your instances. For more information - * about Elastic Graphics, see Amazon Elastic Graphics.
+ *Describes the Elastic Graphics accelerator associated with your instances.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeInstanceTypeOfferingsCommand.ts b/clients/client-ec2/src/commands/DescribeInstanceTypeOfferingsCommand.ts index e66ee93add13..6626d7def260 100644 --- a/clients/client-ec2/src/commands/DescribeInstanceTypeOfferingsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeInstanceTypeOfferingsCommand.ts @@ -30,8 +30,9 @@ export interface DescribeInstanceTypeOfferingsCommandOutput __MetadataBearer {} /** - *Lists the instance types that are offered for the specified location. If no location is specified, the default - * is to list the instance types that are offered in the current Region.
+ *Lists the instance types that are offered for the specified location. If no location is + * specified, the default is to list the instance types that are offered in the current + * Region.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeInstanceTypesCommand.ts b/clients/client-ec2/src/commands/DescribeInstanceTypesCommand.ts index f0bff59b1492..58595a017f75 100644 --- a/clients/client-ec2/src/commands/DescribeInstanceTypesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeInstanceTypesCommand.ts @@ -28,8 +28,8 @@ export interface DescribeInstanceTypesCommandInput extends DescribeInstanceTypes export interface DescribeInstanceTypesCommandOutput extends DescribeInstanceTypesResult, __MetadataBearer {} /** - *Describes the specified instance types. By default, all instance types for the current Region are described. - * Alternatively, you can filter the results.
+ *Describes the specified instance types. By default, all instance types for the current + * Region are described. Alternatively, you can filter the results.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeInternetGatewaysCommand.ts b/clients/client-ec2/src/commands/DescribeInternetGatewaysCommand.ts index 9ecf3f34b663..5a26ddbaf658 100644 --- a/clients/client-ec2/src/commands/DescribeInternetGatewaysCommand.ts +++ b/clients/client-ec2/src/commands/DescribeInternetGatewaysCommand.ts @@ -28,7 +28,9 @@ export interface DescribeInternetGatewaysCommandInput extends DescribeInternetGa export interface DescribeInternetGatewaysCommandOutput extends DescribeInternetGatewaysResult, __MetadataBearer {} /** - *Describes one or more of your internet gateways.
+ *Describes your internet gateways. The default is to describe all your internet gateways. + * Alternatively, you can specify specific internet gateway IDs or filter the results to + * include only the internet gateways that match specific criteria.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeNatGatewaysCommand.ts b/clients/client-ec2/src/commands/DescribeNatGatewaysCommand.ts index 29151a9b2efc..01052eaa0d2f 100644 --- a/clients/client-ec2/src/commands/DescribeNatGatewaysCommand.ts +++ b/clients/client-ec2/src/commands/DescribeNatGatewaysCommand.ts @@ -28,7 +28,9 @@ export interface DescribeNatGatewaysCommandInput extends DescribeNatGatewaysRequ export interface DescribeNatGatewaysCommandOutput extends DescribeNatGatewaysResult, __MetadataBearer {} /** - *Describes one or more of your NAT gateways.
+ *Describes your NAT gateways. The default is to describe all your NAT gateways. + * Alternatively, you can specify specific NAT gateway IDs or filter the results to + * include only the NAT gateways that match specific criteria.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeNetworkAclsCommand.ts b/clients/client-ec2/src/commands/DescribeNetworkAclsCommand.ts index a93a401bee3f..65d7e7e75b14 100644 --- a/clients/client-ec2/src/commands/DescribeNetworkAclsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeNetworkAclsCommand.ts @@ -28,7 +28,9 @@ export interface DescribeNetworkAclsCommandInput extends DescribeNetworkAclsRequ export interface DescribeNetworkAclsCommandOutput extends DescribeNetworkAclsResult, __MetadataBearer {} /** - *Describes one or more of your network ACLs.
+ *Describes your network ACLs. The default is to describe all your network ACLs. + * Alternatively, you can specify specific network ACL IDs or filter the results to + * include only the network ACLs that match specific criteria.
*For more information, see Network ACLs in the * Amazon VPC User Guide.
* @example diff --git a/clients/client-ec2/src/commands/DescribeRegionsCommand.ts b/clients/client-ec2/src/commands/DescribeRegionsCommand.ts index 40bd339b6835..bfe1aba92f53 100644 --- a/clients/client-ec2/src/commands/DescribeRegionsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeRegionsCommand.ts @@ -29,9 +29,9 @@ export interface DescribeRegionsCommandOutput extends DescribeRegionsResult, __M /** *Describes the Regions that are enabled for your account, or all Regions.
- *For a list of the Regions supported by Amazon EC2, see - * Amazon Elastic Compute Cloud endpoints and quotas.
- *For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
+ *For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints.
+ *For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions + * your account can use in the Amazon Web Services Account Management Reference Guide.
*The order of the elements in the response, including those within nested structures, * might vary. Applications should not assume the elements appear in a particular order.
diff --git a/clients/client-ec2/src/commands/DescribeReplaceRootVolumeTasksCommand.ts b/clients/client-ec2/src/commands/DescribeReplaceRootVolumeTasksCommand.ts index 0046354263c8..3882757d6beb 100644 --- a/clients/client-ec2/src/commands/DescribeReplaceRootVolumeTasksCommand.ts +++ b/clients/client-ec2/src/commands/DescribeReplaceRootVolumeTasksCommand.ts @@ -34,7 +34,7 @@ export interface DescribeReplaceRootVolumeTasksCommandOutput /** *Describes a root volume replacement task. For more information, see - * Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
+ * Replace a root volume in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeReservedInstancesListingsCommand.ts b/clients/client-ec2/src/commands/DescribeReservedInstancesListingsCommand.ts index c3a12945a02b..e02efbf20479 100644 --- a/clients/client-ec2/src/commands/DescribeReservedInstancesListingsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeReservedInstancesListingsCommand.ts @@ -37,8 +37,8 @@ export interface DescribeReservedInstancesListingsCommandOutput *The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
*As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
*As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
- *For more information, see Reserved Instance Marketplace - * in the Amazon EC2 User Guide.
+ *For more information, see Sell in the Reserved Instance + * Marketplace in the Amazon EC2 User Guide.
*The order of the elements in the response, including those within nested * structures, might vary. Applications should not assume the elements appear in a diff --git a/clients/client-ec2/src/commands/DescribeReservedInstancesModificationsCommand.ts b/clients/client-ec2/src/commands/DescribeReservedInstancesModificationsCommand.ts index 8e27a073d1f5..558ec12dc625 100644 --- a/clients/client-ec2/src/commands/DescribeReservedInstancesModificationsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeReservedInstancesModificationsCommand.ts @@ -38,7 +38,8 @@ export interface DescribeReservedInstancesModificationsCommandOutput /** *
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
- *For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
+ *For more information, see Modify Reserved Instances in the + * Amazon EC2 User Guide.
*The order of the elements in the response, including those within nested * structures, might vary. Applications should not assume the elements appear in a diff --git a/clients/client-ec2/src/commands/DescribeReservedInstancesOfferingsCommand.ts b/clients/client-ec2/src/commands/DescribeReservedInstancesOfferingsCommand.ts index 2f7c5e2283f7..7174cf70bb76 100644 --- a/clients/client-ec2/src/commands/DescribeReservedInstancesOfferingsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeReservedInstancesOfferingsCommand.ts @@ -38,8 +38,8 @@ export interface DescribeReservedInstancesOfferingsCommandOutput /** *
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
*If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
- *For more information, see Reserved Instance Marketplace - * in the Amazon EC2 User Guide.
+ *For more information, see Sell in the Reserved Instance + * Marketplace in the Amazon EC2 User Guide.
*The order of the elements in the response, including those within nested * structures, might vary. Applications should not assume the elements appear in a diff --git a/clients/client-ec2/src/commands/DescribeRouteTablesCommand.ts b/clients/client-ec2/src/commands/DescribeRouteTablesCommand.ts index fe0488d7c863..803b715abd53 100644 --- a/clients/client-ec2/src/commands/DescribeRouteTablesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeRouteTablesCommand.ts @@ -28,7 +28,9 @@ export interface DescribeRouteTablesCommandInput extends DescribeRouteTablesRequ export interface DescribeRouteTablesCommandOutput extends DescribeRouteTablesResult, __MetadataBearer {} /** - *
Describes one or more of your route tables.
+ *Describes your route tables. The default is to describe all your route tables. + * Alternatively, you can specify specific route table IDs or filter the results to + * include only the route tables that match specific criteria.
*Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
*For more information, see Route tables in the * Amazon VPC User Guide.
diff --git a/clients/client-ec2/src/commands/DescribeSpotDatafeedSubscriptionCommand.ts b/clients/client-ec2/src/commands/DescribeSpotDatafeedSubscriptionCommand.ts index 234b3d49b8ca..b6b4ad66d0b0 100644 --- a/clients/client-ec2/src/commands/DescribeSpotDatafeedSubscriptionCommand.ts +++ b/clients/client-ec2/src/commands/DescribeSpotDatafeedSubscriptionCommand.ts @@ -34,7 +34,7 @@ export interface DescribeSpotDatafeedSubscriptionCommandOutput /** *Describes the data feed for Spot Instances. For more information, see Spot - * Instance data feed in the Amazon EC2 User Guide for Linux Instances.
+ * Instance data feed in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeSpotPriceHistoryCommand.ts b/clients/client-ec2/src/commands/DescribeSpotPriceHistoryCommand.ts index fb3d55021ff0..85bdd3e53a3a 100644 --- a/clients/client-ec2/src/commands/DescribeSpotPriceHistoryCommand.ts +++ b/clients/client-ec2/src/commands/DescribeSpotPriceHistoryCommand.ts @@ -29,7 +29,7 @@ export interface DescribeSpotPriceHistoryCommandOutput extends DescribeSpotPrice /** *Describes the Spot price history. For more information, see Spot Instance pricing history in the - * Amazon EC2 User Guide for Linux Instances.
+ * Amazon EC2 User Guide. *When you specify a start and end time, the operation returns the prices of the * instance types within that time range. It also returns the last price change before the * start time, which is the effective price as of the start time.
diff --git a/clients/client-ec2/src/commands/DescribeSubnetsCommand.ts b/clients/client-ec2/src/commands/DescribeSubnetsCommand.ts index 3ef46ca056be..16b1553dc5fe 100644 --- a/clients/client-ec2/src/commands/DescribeSubnetsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeSubnetsCommand.ts @@ -28,7 +28,9 @@ export interface DescribeSubnetsCommandInput extends DescribeSubnetsRequest {} export interface DescribeSubnetsCommandOutput extends DescribeSubnetsResult, __MetadataBearer {} /** - *Describes one or more of your subnets.
+ *Describes your subnets. The default is to describe all your subnets. + * Alternatively, you can specify specific subnet IDs or filter the results to + * include only the subnets that match specific criteria.
*For more information, see Subnets in the * Amazon VPC User Guide.
* @example diff --git a/clients/client-ec2/src/commands/DescribeVolumesModificationsCommand.ts b/clients/client-ec2/src/commands/DescribeVolumesModificationsCommand.ts index 5da06bdd163d..ca7c7da48a99 100644 --- a/clients/client-ec2/src/commands/DescribeVolumesModificationsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeVolumesModificationsCommand.ts @@ -34,9 +34,8 @@ export interface DescribeVolumesModificationsCommandOutput *If a volume has never been modified, some information in the output will be null. * If a volume has been modified more than once, the output includes only the most * recent modification request.
- *You can also use CloudWatch Events to check the status of a modification to an EBS - * volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see - * Monitor the progress of volume modifications in the Amazon EBS User Guide.
+ *For more information, see + * Monitor the progress of volume modifications in the Amazon EBS User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeVpcEndpointsCommand.ts b/clients/client-ec2/src/commands/DescribeVpcEndpointsCommand.ts index 965c412ea6d6..248b6f048182 100644 --- a/clients/client-ec2/src/commands/DescribeVpcEndpointsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeVpcEndpointsCommand.ts @@ -28,7 +28,9 @@ export interface DescribeVpcEndpointsCommandInput extends DescribeVpcEndpointsRe export interface DescribeVpcEndpointsCommandOutput extends DescribeVpcEndpointsResult, __MetadataBearer {} /** - *Describes your VPC endpoints.
+ *Describes your VPC endpoints. The default is to describe all your VPC endpoints. + * Alternatively, you can specify specific VPC endpoint IDs or filter the results to + * include only the VPC endpoints that match specific criteria.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeVpcPeeringConnectionsCommand.ts b/clients/client-ec2/src/commands/DescribeVpcPeeringConnectionsCommand.ts index f78a595812bc..c9664aee175f 100644 --- a/clients/client-ec2/src/commands/DescribeVpcPeeringConnectionsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeVpcPeeringConnectionsCommand.ts @@ -30,7 +30,9 @@ export interface DescribeVpcPeeringConnectionsCommandOutput __MetadataBearer {} /** - *Describes one or more of your VPC peering connections.
+ *Describes your VPC peering connections. The default is to describe all your VPC peering connections. + * Alternatively, you can specify specific VPC peering connection IDs or filter the results to + * include only the VPC peering connections that match specific criteria.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeVpcsCommand.ts b/clients/client-ec2/src/commands/DescribeVpcsCommand.ts index 5a870ba85f55..b7af590aa20d 100644 --- a/clients/client-ec2/src/commands/DescribeVpcsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeVpcsCommand.ts @@ -28,7 +28,9 @@ export interface DescribeVpcsCommandInput extends DescribeVpcsRequest {} export interface DescribeVpcsCommandOutput extends DescribeVpcsResult, __MetadataBearer {} /** - *Describes one or more of your VPCs.
+ *Describes your VPCs. The default is to describe all your VPCs. + * Alternatively, you can specify specific VPC IDs or filter the results to + * include only the VPCs that match specific criteria.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DisableAddressTransferCommand.ts b/clients/client-ec2/src/commands/DisableAddressTransferCommand.ts index 163eeaf11378..b7926cb0dc30 100644 --- a/clients/client-ec2/src/commands/DisableAddressTransferCommand.ts +++ b/clients/client-ec2/src/commands/DisableAddressTransferCommand.ts @@ -28,7 +28,7 @@ export interface DisableAddressTransferCommandInput extends DisableAddressTransf export interface DisableAddressTransferCommandOutput extends DisableAddressTransferResult, __MetadataBearer {} /** - *Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
+ *Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/EnableAddressTransferCommand.ts b/clients/client-ec2/src/commands/EnableAddressTransferCommand.ts index d4d67fba2b4a..57afc0e90d44 100644 --- a/clients/client-ec2/src/commands/EnableAddressTransferCommand.ts +++ b/clients/client-ec2/src/commands/EnableAddressTransferCommand.ts @@ -28,7 +28,7 @@ export interface EnableAddressTransferCommandInput extends EnableAddressTransfer export interface EnableAddressTransferCommandOutput extends EnableAddressTransferResult, __MetadataBearer {} /** - *Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
+ *Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/ExportTransitGatewayRoutesCommand.ts b/clients/client-ec2/src/commands/ExportTransitGatewayRoutesCommand.ts index 97d7a3942a9f..5f2a482fd960 100644 --- a/clients/client-ec2/src/commands/ExportTransitGatewayRoutesCommand.ts +++ b/clients/client-ec2/src/commands/ExportTransitGatewayRoutesCommand.ts @@ -31,8 +31,8 @@ export interface ExportTransitGatewayRoutesCommandOutput extends ExportTransitGa *Exports routes from the specified transit gateway route table to the specified S3 bucket. * By default, all routes are exported. Alternatively, you can filter by CIDR range.
*The routes are saved to the specified bucket in a JSON file. For more information, see - * Export Route Tables - * to Amazon S3 in Transit Gateways.
+ * Export route tables + * to Amazon S3 in the Amazon Web Services Transit Gateways Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/GetIpamPoolAllocationsCommand.ts b/clients/client-ec2/src/commands/GetIpamPoolAllocationsCommand.ts index 52f786cc838f..3dbad62dc6ef 100644 --- a/clients/client-ec2/src/commands/GetIpamPoolAllocationsCommand.ts +++ b/clients/client-ec2/src/commands/GetIpamPoolAllocationsCommand.ts @@ -30,7 +30,7 @@ export interface GetIpamPoolAllocationsCommandOutput extends GetIpamPoolAllocati /** *Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
*If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
+ *If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
*Retrieves the encrypted administrator password for a running Windows instance.
*The Windows password is generated at boot by the EC2Config
service or
* EC2Launch
scripts (Windows Server 2016 and later). This usually only
- * happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the
+ * happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the
* Amazon EC2 User Guide.
For the EC2Config
service, the password is not generated for rebundled
* AMIs unless Ec2SetPassword
is enabled before bundling.
InstanceTypes
.
* For more information, see Spot placement score in - * the Amazon EC2 User Guide.
+ * the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/ModifyAvailabilityZoneGroupCommand.ts b/clients/client-ec2/src/commands/ModifyAvailabilityZoneGroupCommand.ts index f1c7a4220f1e..bb3bfbd3a489 100644 --- a/clients/client-ec2/src/commands/ModifyAvailabilityZoneGroupCommand.ts +++ b/clients/client-ec2/src/commands/ModifyAvailabilityZoneGroupCommand.ts @@ -28,10 +28,7 @@ export interface ModifyAvailabilityZoneGroupCommandInput extends ModifyAvailabil export interface ModifyAvailabilityZoneGroupCommandOutput extends ModifyAvailabilityZoneGroupResult, __MetadataBearer {} /** - *Changes the opt-in status of the Local Zone and Wavelength Zone group for your - * account.
- *Use
- * DescribeAvailabilityZones to view the value for GroupName
.
Changes the opt-in status of the specified zone group for your account.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/ModifyReservedInstancesCommand.ts b/clients/client-ec2/src/commands/ModifyReservedInstancesCommand.ts index b7493f8df687..8e1cbb540b3d 100644 --- a/clients/client-ec2/src/commands/ModifyReservedInstancesCommand.ts +++ b/clients/client-ec2/src/commands/ModifyReservedInstancesCommand.ts @@ -31,8 +31,8 @@ export interface ModifyReservedInstancesCommandOutput extends ModifyReservedInst *Modifies the configuration of your Reserved Instances, such as the Availability Zone, * instance count, or instance type. The Reserved Instances to be modified must be identical, * except for Availability Zone, network platform, and instance type.
- *For more information, see Modifying Reserved - * Instances in the Amazon EC2 User Guide.
+ *For more information, see Modify Reserved Instances in the + * Amazon EC2 User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/ModifyVolumeCommand.ts b/clients/client-ec2/src/commands/ModifyVolumeCommand.ts index c8dbf1962dd5..a8d29530f1c2 100644 --- a/clients/client-ec2/src/commands/ModifyVolumeCommand.ts +++ b/clients/client-ec2/src/commands/ModifyVolumeCommand.ts @@ -35,10 +35,7 @@ export interface ModifyVolumeCommandOutput extends ModifyVolumeResult, __Metadat * in the Amazon EBS User Guide. *When you complete a resize operation on your volume, you need to extend the volume's * file-system size to take advantage of the new storage capacity. For more information, see Extend the file system.
- *You can use CloudWatch Events to check the status of a modification to an EBS volume. For - * information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a - * modification using DescribeVolumesModifications. For information - * about tracking status changes using either method, see Monitor the progress of volume modifications.
+ *For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
*With previous-generation instance types, resizing an EBS volume might require detaching and * reattaching the volume or stopping and restarting the instance.
*After modifying a volume, you must wait at least six hours and ensure that the volume diff --git a/clients/client-ec2/src/commands/ProvisionByoipCidrCommand.ts b/clients/client-ec2/src/commands/ProvisionByoipCidrCommand.ts index ff2d4bba7abe..3c2400218241 100644 --- a/clients/client-ec2/src/commands/ProvisionByoipCidrCommand.ts +++ b/clients/client-ec2/src/commands/ProvisionByoipCidrCommand.ts @@ -34,7 +34,7 @@ export interface ProvisionByoipCidrCommandOutput extends ProvisionByoipCidrResul *
Amazon Web Services verifies that you own the address range and are authorized to advertise it. * You must ensure that the address range is registered to you and that you created an * RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. - * For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
+ * For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide. *Provisioning an address range is an asynchronous operation, so the call returns immediately,
* but the address range is not ready to use until its status changes from pending-provision
* to provisioned
. To monitor the status of an address range, use DescribeByoipCidrs.
diff --git a/clients/client-ec2/src/commands/PurchaseReservedInstancesOfferingCommand.ts b/clients/client-ec2/src/commands/PurchaseReservedInstancesOfferingCommand.ts
index a988966f234e..06646fee1002 100644
--- a/clients/client-ec2/src/commands/PurchaseReservedInstancesOfferingCommand.ts
+++ b/clients/client-ec2/src/commands/PurchaseReservedInstancesOfferingCommand.ts
@@ -40,9 +40,9 @@ export interface PurchaseReservedInstancesOfferingCommandOutput
* new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a * purchase time, the default is the current time.
- *For more information, see Reserved Instances and - * Reserved Instance Marketplace - * in the Amazon EC2 User Guide.
+ *For more information, see Reserved + * Instances and Sell in the Reserved Instance + * Marketplace in the Amazon EC2 User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/RegisterTransitGatewayMulticastGroupMembersCommand.ts b/clients/client-ec2/src/commands/RegisterTransitGatewayMulticastGroupMembersCommand.ts index 8031da698b97..8cab7cfed223 100644 --- a/clients/client-ec2/src/commands/RegisterTransitGatewayMulticastGroupMembersCommand.ts +++ b/clients/client-ec2/src/commands/RegisterTransitGatewayMulticastGroupMembersCommand.ts @@ -38,9 +38,9 @@ export interface RegisterTransitGatewayMulticastGroupMembersCommandOutput /** *Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated - * with a supported EC2 instance that receives multicast traffic. For information about - * supported instances, see Multicast - * Consideration in Amazon VPC Transit Gateways.
+ * with a supported EC2 instance that receives multicast traffic. For more information, see + * Multicast + * on transit gateways in the Amazon Web Services Transit Gateways Guide. *After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added * to the transit gateway multicast group.
* @example diff --git a/clients/client-ec2/src/commands/RegisterTransitGatewayMulticastGroupSourcesCommand.ts b/clients/client-ec2/src/commands/RegisterTransitGatewayMulticastGroupSourcesCommand.ts index 12ad73485703..632a1944427f 100644 --- a/clients/client-ec2/src/commands/RegisterTransitGatewayMulticastGroupSourcesCommand.ts +++ b/clients/client-ec2/src/commands/RegisterTransitGatewayMulticastGroupSourcesCommand.ts @@ -39,8 +39,8 @@ export interface RegisterTransitGatewayMulticastGroupSourcesCommandOutput /** *Registers sources (network interfaces) with the specified transit gateway multicast group.
*A multicast source is a network interface attached to a supported instance that sends - * multicast traffic. For information about supported instances, see Multicast - * Considerations in Amazon VPC Transit Gateways.
+ * multicast traffic. For more information about supported instances, see Multicast + * on transit gateways in the Amazon Web Services Transit Gateways Guide. *After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast * group.
* @example diff --git a/clients/client-ec2/src/commands/ReleaseIpamPoolAllocationCommand.ts b/clients/client-ec2/src/commands/ReleaseIpamPoolAllocationCommand.ts index 438d96d7cc04..0c1e04e1d02d 100644 --- a/clients/client-ec2/src/commands/ReleaseIpamPoolAllocationCommand.ts +++ b/clients/client-ec2/src/commands/ReleaseIpamPoolAllocationCommand.ts @@ -31,7 +31,7 @@ export interface ReleaseIpamPoolAllocationCommandOutput extends ReleaseIpamPoolA *Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. *
*All EC2 API actions follow an eventual consistency model.
+ *All EC2 API actions follow an eventual consistency model.
*Creates a Spot Instance request.
- *For more information, see Spot Instance requests in - * the Amazon EC2 User Guide for Linux Instances.
+ *For more information, see Work with Spot Instance in + * the Amazon EC2 User Guide.
*We strongly discourage using the RequestSpotInstances API because it is a legacy * API with no planned investment. For options for requesting Spot Instances, see * Which * is the best Spot request method to use? in the - * Amazon EC2 User Guide for Linux Instances.
+ * Amazon EC2 User Guide. *The sourceDestCheck
attribute controls whether source/destination
* checking is enabled. The default value is true
, which means checking is
* enabled. This value must be false
for a NAT instance to perform NAT. For
- * more information, see NAT Instances in the
+ * more information, see NAT instances in the
* Amazon VPC User Guide.
If you don't specify a security group ID, we use the default security group.
- * For more information, see Security
+ * If you don't specify a security group ID, we use the default security group
+ * for the VPC. For more information, see Security
* groups.
To ensure faster instance launches, break up large requests into smaller batches. For * example, create five separate launch requests for 100 instances each instead of one * launch request for 500 instances.
+ *
+ * RunInstances
is subject to both request rate limiting and resource rate
+ * limiting. For more information, see Request throttling.
An instance is ready for you to use when it's in the running
state. You
* can check the state of your instance using DescribeInstances. You can
* tag instances and EBS volumes during launch, after launch, or both. For more
diff --git a/clients/client-ec2/src/commands/RunScheduledInstancesCommand.ts b/clients/client-ec2/src/commands/RunScheduledInstancesCommand.ts
index b5fad1600a46..a6cbd4d5a9bf 100644
--- a/clients/client-ec2/src/commands/RunScheduledInstancesCommand.ts
+++ b/clients/client-ec2/src/commands/RunScheduledInstancesCommand.ts
@@ -34,10 +34,10 @@ export interface RunScheduledInstancesCommandOutput extends RunScheduledInstance
/**
*
Launches the specified Scheduled Instances.
*Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
- *You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, - * but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, - * you can launch it again after a few minutes. For more information, see Scheduled Instances - * in the Amazon EC2 User Guide.
+ *You must launch a Scheduled Instance during its scheduled time period. You can't stop or + * reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a + * Scheduled Instance before the current scheduled time period ends, you can launch it again + * after a few minutes.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/SendDiagnosticInterruptCommand.ts b/clients/client-ec2/src/commands/SendDiagnosticInterruptCommand.ts index 71b728c0546a..bdc21b58e721 100644 --- a/clients/client-ec2/src/commands/SendDiagnosticInterruptCommand.ts +++ b/clients/client-ec2/src/commands/SendDiagnosticInterruptCommand.ts @@ -41,8 +41,7 @@ export interface SendDiagnosticInterruptCommandOutput extends __MetadataBearer { * system is configured to perform the required diagnostic tasks. *For more information about configuring your operating system to generate a crash dump * when a kernel panic or stop error occurs, see Send a diagnostic interrupt - * (for advanced users) (Linux instances) or Send a diagnostic - * interrupt (for advanced users) (Windows instances).
+ * (for advanced users) in the Amazon EC2 User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/StartInstancesCommand.ts b/clients/client-ec2/src/commands/StartInstancesCommand.ts index be0577b97e59..43d1f56fae89 100644 --- a/clients/client-ec2/src/commands/StartInstancesCommand.ts +++ b/clients/client-ec2/src/commands/StartInstancesCommand.ts @@ -45,8 +45,8 @@ export interface StartInstancesCommandOutput extends StartInstancesResult, __Met *unlimited
CPU credit option is not supported on Dedicated Hosts. Before
* you start the instance, either change its CPU credit option to standard
, or
* change its tenancy to default
or dedicated
.
- * For more information, see Stop and start your instance - * in the Amazon EC2 User Guide.
+ *For more information, see Stop and start Amazon EC2 + * instances in the Amazon EC2 User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/StopInstancesCommand.ts b/clients/client-ec2/src/commands/StopInstancesCommand.ts index b0f536c98adb..c620edab4bbb 100644 --- a/clients/client-ec2/src/commands/StopInstancesCommand.ts +++ b/clients/client-ec2/src/commands/StopInstancesCommand.ts @@ -29,11 +29,12 @@ export interface StopInstancesCommandOutput extends StopInstancesResult, __Metad /** *Stops an Amazon EBS-backed instance. For more information, see Stop and start - * your instance in the Amazon EC2 User Guide.
- *You can use the Stop action to hibernate an instance if the instance is enabled for - * hibernation and it meets the hibernation - * prerequisites. For more information, see Hibernate your instance in the - * Amazon EC2 User Guide.
+ * Amazon EC2 instances in the Amazon EC2 User + * Guide. + *You can use the Stop action to hibernate an instance if the instance is enabled + * for hibernation and it meets the hibernation + * prerequisites. For more information, see Hibernate your Amazon EC2 + * instance in the Amazon EC2 User Guide.
*We don't charge usage for a stopped instance, or data transfer fees; however, your * root partition Amazon EBS volume remains and continues to persist your data, and you are * charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 diff --git a/clients/client-ec2/src/models/models_0.ts b/clients/client-ec2/src/models/models_0.ts index ae42aa3c98b7..5a3874778244 100644 --- a/clients/client-ec2/src/models/models_0.ts +++ b/clients/client-ec2/src/models/models_0.ts @@ -330,7 +330,7 @@ export const AddressTransferStatus = { export type AddressTransferStatus = (typeof AddressTransferStatus)[keyof typeof AddressTransferStatus]; /** - *
Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
+ *Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
* @public */ export interface AddressTransfer { @@ -3180,7 +3180,6 @@ export interface AllocateAddressRequest { *A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services * 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.
* @public */ NetworkBorderGroup?: string; @@ -3314,7 +3313,7 @@ export interface AllocateHostsRequest { * 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
+ *
Default: off
*
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -3864,8 +3863,8 @@ export interface AssignPrivateIpAddressesRequest { export interface Ipv4PrefixSpecification { /** *The IPv4 prefix. For information, see - * Assigning prefixes to Amazon EC2 network interfaces in the - * Amazon Elastic Compute Cloud User Guide.
+ * Assigning prefixes to network interfaces in the + * Amazon EC2 User Guide. * @public */ Ipv4Prefix?: string; @@ -4105,7 +4104,8 @@ export interface AssociateClientVpnTargetNetworkRequest { SubnetId: string | undefined; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + * For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -5278,8 +5278,8 @@ export interface AssociateTrunkInterfaceRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency.
+ * request. For more information, see Ensuring + * idempotency. * @public */ ClientToken?: string; @@ -5367,8 +5367,8 @@ export interface AssociateTrunkInterfaceResult { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency.
+ * request. For more information, see Ensuring + * idempotency. * @public */ ClientToken?: string; @@ -5756,7 +5756,7 @@ export interface AttachVerifiedAccessTrustProviderRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -6302,7 +6302,8 @@ export interface AuthorizeClientVpnIngressRequest { Description?: string; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + * For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -7807,7 +7808,7 @@ export interface CopyFpgaImageRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - * For more information, see Ensuring idempotency.
+ * For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -8013,7 +8014,7 @@ export interface CopySnapshotRequest { Encrypted?: boolean; /** - *The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. + *
The identifier of the KMS key to use for Amazon EBS encryption.
* If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is
* specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
@@ -8047,8 +8048,8 @@ export interface CopySnapshotRequest { *SourceSnapshotId
, and DestinationRegion
parameters. The
* PresignedUrl
must be signed using Amazon Web Services 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 (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An
+ * that is described in
+ * Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3 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.
* @public
@@ -9471,11 +9472,11 @@ export interface ReservationFleetInstanceSpecification {
InstancePlatform?: CapacityReservationInstancePlatform;
/**
- * The number of capacity units provided by the specified instance type. This value, together with the - * total target capacity that you specify for the Fleet determine the number of instances for which the - * Fleet reserves capacity. Both values are based on units that make sense for your workload. For more - * information, see Total target capacity - * in the Amazon EC2 User Guide.
+ *The number of capacity units provided by the specified instance type. This value, together + * with the total target capacity that you specify for the Fleet determine the number of + * instances for which the Fleet reserves capacity. Both values are based on units that + * make sense for your workload. For more information, see Total target + * capacity in the Amazon EC2 User Guide.
* @public */ Weight?: number; @@ -9506,10 +9507,10 @@ export interface ReservationFleetInstanceSpecification { EbsOptimized?: boolean; /** - *The priority to assign to the instance type. This value is used to determine which of the instance types - * specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more - * information, see Instance type priority - * in the Amazon EC2 User Guide.
+ *The priority to assign to the instance type. This value is used to determine which of the + * instance types specified for the Fleet should be prioritized for use. A lower value + * indicates a high priority. For more information, see Instance type + * priority in the Amazon EC2 User Guide.
* @public */ Priority?: number; @@ -9534,10 +9535,10 @@ export type FleetCapacityReservationTenancy = */ export interface CreateCapacityReservationFleetRequest { /** - *The strategy used by the Capacity Reservation Fleet to determine which of the
- * specified instance types to use. Currently, only the prioritized
- * allocation strategy is supported. For more information, see
- * Allocation strategy in the Amazon EC2 User Guide.
The strategy used by the Capacity Reservation Fleet to determine which of the specified
+ * instance types to use. Currently, only the prioritized
allocation strategy
+ * is supported. For more information, see Allocation
+ * strategy in the Amazon EC2 User Guide.
Valid values: prioritized
*
The total number of capacity units to be reserved by the Capacity Reservation Fleet. This - * value, together with the instance type weights that you assign to each instance type used by - * the Fleet determine the number of instances for which the Fleet reserves capacity. Both values - * are based on units that make sense for your workload. For more information, see - * Total target capacity in the Amazon EC2 User Guide.
+ * value, together with the instance type weights that you assign to each instance type + * used by the Fleet determine the number of instances for which the Fleet reserves + * capacity. Both values are based on units that make sense for your workload. For more + * information, see Total target + * capacity in the Amazon EC2 User Guide. * @public */ TotalTargetCapacity: number | undefined; @@ -9666,9 +9668,9 @@ export interface FleetCapacityReservation { TotalInstanceCount?: number; /** - *The number of capacity units fulfilled by the Capacity Reservation. For more information, see - * - * Total target capacity in the Amazon EC2 User Guide.
+ *The number of capacity units fulfilled by the Capacity Reservation. For more information, + * see Total target + * capacity in the Amazon EC2 User Guide.
* @public */ FulfilledCapacity?: number; @@ -9686,17 +9688,17 @@ export interface FleetCapacityReservation { CreateDate?: Date; /** - *The weight of the instance type in the Capacity Reservation Fleet. For more information, - * see - * Instance type weight in the Amazon EC2 User Guide.
+ *The weight of the instance type in the Capacity Reservation Fleet. For more information, see + * Instance type + * weight in the Amazon EC2 User Guide.
* @public */ Weight?: number; /** *The priority of the instance type in the Capacity Reservation Fleet. For more information, - * see - * Instance type priority in the Amazon EC2 User Guide.
+ * see Instance type + * priority in the Amazon EC2 User Guide. * @public */ Priority?: number; diff --git a/clients/client-ec2/src/models/models_1.ts b/clients/client-ec2/src/models/models_1.ts index 451088c0e6ca..8ebe24dc3cfc 100644 --- a/clients/client-ec2/src/models/models_1.ts +++ b/clients/client-ec2/src/models/models_1.ts @@ -56,7 +56,7 @@ export interface CreateCarrierGatewayRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to ensure + * request. For more information, see How to ensure * idempotency.
* @public */ @@ -404,7 +404,8 @@ export interface CreateClientVpnEndpointRequest { DryRun?: boolean; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + * For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -585,7 +586,8 @@ export interface CreateClientVpnRouteRequest { Description?: string; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + * For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -1440,7 +1442,7 @@ export interface CreateDhcpOptionsResult { export interface CreateEgressOnlyInternetGatewayRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see Ensuring idempotency.
+ * request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -2535,9 +2537,10 @@ export interface OnDemandOptionsRequest { SingleAvailabilityZone?: boolean; /** - *The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is - * not reached, the fleet launches no instances.
- *Supported only for fleets of type instant
.
The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't + * reached, no instances are launched.
+ *Constraints: Maximum value of 1000
. Supported only for fleets of type
+ * instant
.
At least one of the following must be specified: SingleAvailabilityZone
|
* SingleInstanceType
*
MaxTotalPrice
does not account for surplus
* credits, and, if you use surplus credits, your final cost might be higher than what you
- * specified for MaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User
- * Guide.
+ * specified for MaxTotalPrice
. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
*
* @public
*/
@@ -2694,8 +2696,12 @@ export interface SpotOptionsRequest {
* EC2 Fleet requests instances from all of the Spot Instance pools that you * specify.
* - *We don't recommend the lowest-price
allocation strategy because
+ * it has the highest risk of interruption for your Spot Instances.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that * has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances * come from the next lowest priced pool that has available capacity. If a pool runs out of @@ -2758,9 +2764,10 @@ export interface SpotOptionsRequest { SingleAvailabilityZone?: boolean; /** - *
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is - * not reached, the fleet launches no instances.
- *Supported only for fleets of type instant
.
The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't + * reached, no instances are launched.
+ *Constraints: Maximum value of 1000
. Supported only for fleets of type
+ * instant
.
At least one of the following must be specified: SingleAvailabilityZone
|
* SingleInstanceType
*
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
*If your fleet includes T instances that are configured as unlimited
,
- * and if their average CPU usage exceeds the baseline utilization, you will incur a charge
- * for surplus credits. The MaxTotalPrice
does not account for surplus
- * credits, and, if you use surplus credits, your final cost might be higher than what you
- * specified for MaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User
- * Guide.
If your fleet includes T instances that are configured as unlimited
, and
+ * if their average CPU usage exceeds the baseline utilization, you will incur a charge for
+ * surplus credits. The MaxTotalPrice
does not account for surplus credits,
+ * and, if you use surplus credits, your final cost might be higher than what you specified
+ * for MaxTotalPrice
. For more information, see Surplus credits can incur charges in the
+ * Amazon EC2 User Guide.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to ensure + * request. For more information, see How to ensure * idempotency.
* @public */ @@ -4081,7 +4088,7 @@ export interface CreateFlowLogsRequest { *The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. * The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). * This parameter must be 60 seconds for transit gateway resource types.
- *When a network interface is attached to a Nitro-based
+ * 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 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- * For more information, see Ensuring Idempotency.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -5536,7 +5543,7 @@ export interface CreateIpamPoolRequest { TagSpecifications?: TagSpecification[]; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -5797,7 +5804,7 @@ export interface IpamPool { /** *The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP
. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide.
- * By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -6531,18 +6538,15 @@ export interface CreditSpecificationRequest { /** *Amazon Elastic Graphics reached end of life on January 8, 2024. For - * workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, - * G4dn, or G5 instances.
+ *Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, + * we recommend that you use Amazon EC2 G4, G5, or G6 instances.
*A specification for an Elastic Graphics accelerator.
* @public */ export interface ElasticGpuSpecification { /** - *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.
The type of Elastic Graphics accelerator.
* @public */ Type: string | undefined; @@ -6853,7 +6857,7 @@ export type LaunchTemplateInstanceMetadataTagsState = /** *The metadata options for the instance. For more information, see Instance metadata and user data in the - * Amazon Elastic Compute Cloud User Guide.
+ * Amazon EC2 User Guide. * @public */ export interface LaunchTemplateInstanceMetadataOptionsRequest { @@ -6937,7 +6941,7 @@ export interface LaunchTemplatesMonitoringRequest { } /** - *A security group connection tracking specification request that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking specification request that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
* @public */ export interface ConnectionTrackingSpecificationRequest { @@ -7009,8 +7013,8 @@ export interface EnaSrdSpecificationRequest { export interface Ipv4PrefixSpecificationRequest { /** *The IPv4 prefix. For information, see - * Assigning prefixes to Amazon EC2 network interfaces in the - * Amazon Elastic Compute Cloud User Guide.
+ * Assigning prefixes to network interfaces in the + * Amazon EC2 User Guide. * @public */ Ipv4Prefix?: string; @@ -7113,7 +7117,7 @@ export interface LaunchTemplateInstanceNetworkInterfaceSpecificationRequest { /** *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
@@ -7217,7 +7221,10 @@ export interface LaunchTemplateInstanceNetworkInterfaceSpecificationRequest {
EnaSrdSpecification?: EnaSrdSpecificationRequest;
/**
- *
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking specification that enables you to set the timeout + * for connection tracking on an Elastic network interface. For more information, see + * Idle connection tracking timeout in the + * Amazon EC2 User Guide.
* @public */ ConnectionTrackingSpecification?: ConnectionTrackingSpecificationRequest; @@ -7356,7 +7363,7 @@ export interface RequestLaunchTemplateData { *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.
+ * kernels in the Amazon EC2 User Guide. *Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. * If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.
* - *For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
+ *For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
* @public */ ImageId?: string; /** - *The instance type. For more information, see Instance types in the - * Amazon Elastic Compute Cloud User Guide.
+ *The instance type. For more information, see Amazon EC2 instance types in + * the Amazon EC2 User Guide.
*If you specify InstanceType
, you can't specify
* InstanceRequirements
.
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.
+ * kernels in the Amazon EC2 User Guide. *The user data to make available to the instance. You must provide base64-encoded text. - * User data is limited to 16 KB. For more information, see Run commands on your Linux instance at - * launch (Linux) or Work with instance - * user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
+ * User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at + * launch in the Amazon EC2 User Guide. *If you are creating the launch template for use with Batch, the user - * data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
+ * data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide. * @public */ UserData?: string; @@ -7569,8 +7575,7 @@ export interface RequestLaunchTemplateData { CreditSpecification?: CreditSpecificationRequest; /** - *The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User - * Guide.
+ *The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
* @public */ CpuOptions?: LaunchTemplateCpuOptionsRequest; @@ -7593,22 +7598,22 @@ export interface RequestLaunchTemplateData { /** *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.
+ * prerequisites. For more information, see Hibernate your Amazon EC2 instance + * in the Amazon EC2 User Guide. * @public */ HibernationOptions?: LaunchTemplateHibernationOptionsRequest; /** *The metadata options for the instance. For more information, see Instance metadata and user data in the - * Amazon Elastic Compute Cloud User Guide.
+ * Amazon EC2 User Guide. * @public */ MetadataOptions?: LaunchTemplateInstanceMetadataOptionsRequest; /** *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more - * information, see What is Amazon Web Services Nitro Enclaves? + * information, see What is Amazon Web Services Nitro Enclaves? * in the Amazon Web Services Nitro Enclaves User Guide.
*You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
* @public @@ -7667,8 +7672,8 @@ export interface RequestLaunchTemplateData { /** *Indicates whether to enable the instance for stop protection. For more information, - * see Stop - * protection in the Amazon Elastic Compute Cloud User Guide.
+ * see Enable stop protection for your instance in the + * Amazon EC2 User Guide. * @public */ DisableApiStop?: boolean; @@ -7893,7 +7898,7 @@ export interface CreateLaunchTemplateVersionRequest { /** *If true
, and if a Systems Manager parameter is specified for ImageId
,
* the AMI ID is displayed in the response for imageID
. For more information, see Use a Systems
- * Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
Default: false
*
The metadata options for the instance. For more information, see Instance metadata and user data in the - * Amazon Elastic Compute Cloud User Guide.
+ * Amazon EC2 User Guide. * @public */ export interface LaunchTemplateInstanceMetadataOptions { @@ -8360,7 +8365,7 @@ export interface LaunchTemplatesMonitoring { } /** - *A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
* @public */ export interface ConnectionTrackingSpecification { @@ -8620,7 +8625,10 @@ export interface LaunchTemplateInstanceNetworkInterfaceSpecification { EnaSrdSpecification?: LaunchTemplateEnaSrdSpecification; /** - *A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking specification that enables you to set the timeout + * for connection tracking on an Elastic network interface. For more information, see + * Idle connection tracking timeout in the + * Amazon EC2 User Guide.
* @public */ ConnectionTrackingSpecification?: ConnectionTrackingSpecification; @@ -8787,7 +8795,7 @@ export interface ResponseLaunchTemplateData { * * *For more information, see Use a Systems - * Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
+ * Manager parameter instead of an AMI ID in the Amazon EC2 User Guide. * @public */ ImageId?: string; @@ -8903,8 +8911,7 @@ export interface ResponseLaunchTemplateData { CreditSpecification?: CreditSpecification; /** - *The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User - * Guide.
+ *The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
* @public */ CpuOptions?: LaunchTemplateCpuOptions; @@ -8924,14 +8931,14 @@ export interface ResponseLaunchTemplateData { /** *Indicates whether an instance is configured for hibernation. For more information, see * Hibernate - * your instance in the Amazon Elastic Compute Cloud User Guide.
+ * your Amazon EC2 instance in the Amazon EC2 User Guide. * @public */ HibernationOptions?: LaunchTemplateHibernationOptions; /** *The metadata options for the instance. For more information, see Instance metadata and user data in the - * Amazon Elastic Compute Cloud User Guide.
+ * Amazon EC2 User Guide. * @public */ MetadataOptions?: LaunchTemplateInstanceMetadataOptions; @@ -8965,8 +8972,8 @@ export interface ResponseLaunchTemplateData { /** *Indicates whether the instance is enabled for stop protection. For more information, - * see Stop - * protection in the Amazon Elastic Compute Cloud User Guide.
+ * see Enable stop protection for your instance in the + * Amazon EC2 User Guide. * @public */ DisableApiStop?: boolean; @@ -9660,8 +9667,8 @@ export interface CreateManagedPrefixListRequest { /** *Unique, case-sensitive identifier you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
+ * request. For more information, see Ensuring + * idempotency. *Constraints: Up to 255 UTF-8 characters in length.
* @public */ @@ -9797,7 +9804,7 @@ export interface CreateNatGatewayRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see Ensuring idempotency.
+ * request. For more information, see Ensuring idempotency. *Constraint: Maximum 64 ASCII characters.
* @public */ @@ -9844,7 +9851,8 @@ export interface CreateNatGatewayRequest { SecondaryAllocationIds?: string[]; /** - *Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
+ *Secondary private IPv4 addresses. For more information about secondary addresses, see + * Create a NAT gateway in the Amazon VPC User Guide.
* @public */ SecondaryPrivateIpAddresses?: string[]; @@ -9859,36 +9867,37 @@ export interface CreateNatGatewayRequest { } /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *Reserved. If you need to sustain traffic greater than the documented limits, + * contact Amazon Web Services Support.
* @public */ export interface ProvisionedBandwidth { /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *Reserved.
* @public */ ProvisionTime?: Date; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *Reserved.
* @public */ Provisioned?: string; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *Reserved.
* @public */ RequestTime?: Date; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *Reserved.
* @public */ Requested?: string; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *Reserved.
* @public */ Status?: string; @@ -9976,8 +9985,8 @@ export interface NatGateway { NatGatewayId?: string; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through - * the Support Center.
+ *Reserved. If you need to sustain traffic greater than the documented limits, + * contact Amazon Web Services Support.
* @public */ ProvisionedBandwidth?: ProvisionedBandwidth; @@ -10083,7 +10092,7 @@ export interface CreateNetworkAclRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see Ensuring idempotency.
+ * request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -10205,7 +10214,7 @@ export interface NetworkAclEntry { */ export interface NetworkAcl { /** - *Any associations between the network ACL and one or more subnets
+ *Any associations between the network ACL and your subnets
* @public */ Associations?: NetworkAclAssociation[]; @@ -10359,7 +10368,7 @@ export interface CreateNetworkInsightsAccessScopeRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, - * see How to ensure idempotency.
+ * see How to ensure idempotency. * @public */ ClientToken?: string; @@ -10561,7 +10570,7 @@ export interface CreateNetworkInsightsPathRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, - * see How to ensure idempotency.
+ * see How to ensure idempotency. * @public */ ClientToken?: string; @@ -10872,7 +10881,7 @@ export interface CreateNetworkInterfaceRequest { TagSpecifications?: TagSpecification[]; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -11056,7 +11065,7 @@ export interface NetworkInterfaceAttachment { } /** - *A security group connection tracking configuration that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking configuration that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
* @public */ export interface ConnectionTrackingConfiguration { diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts index 0a4bd8895f99..38e017c576fa 100644 --- a/clients/client-ec2/src/models/models_2.ts +++ b/clients/client-ec2/src/models/models_2.ts @@ -72,7 +72,8 @@ export interface NetworkInterfaceIpv6Address { Ipv6Address?: string; /** - *Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
+ *Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. + * For more information, see ModifyNetworkInterfaceAttribute.
* @public */ IsPrimaryIpv6?: boolean; @@ -161,7 +162,7 @@ export interface NetworkInterface { AvailabilityZone?: string; /** - *A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
* @public */ ConnectionTrackingConfiguration?: ConnectionTrackingConfiguration; @@ -689,7 +690,7 @@ export interface CreateReplaceRootVolumeTaskRequest { /** *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.
+ * to ensure idempotency. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -1125,7 +1126,7 @@ export interface CreateRouteTableRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see Ensuring idempotency.
+ * request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -1338,7 +1339,7 @@ export interface Route { */ export interface RouteTable { /** - *The associations between the route table and one or more subnets or a gateway.
+ *The associations between the route table and your subnets or gateways.
* @public */ Associations?: RouteTableAssociation[]; @@ -1584,7 +1585,7 @@ export interface Snapshot { Encrypted?: boolean; /** - *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the + *
The Amazon Resource Name (ARN) of the KMS key that was used to protect the * volume encryption key for the parent volume.
* @public */ @@ -1623,7 +1624,7 @@ export interface Snapshot { /** *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails - * (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error + * (for example, if the proper 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.
* @public @@ -2074,7 +2075,7 @@ export interface CreateSubnetRequest { * 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 Local Zones locations.
To create a subnet in an Outpost, set this value to the Availability Zone for the * Outpost and specify the Outpost ARN.
* @public @@ -4834,7 +4835,7 @@ export interface CreateVerifiedAccessEndpointRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -5112,7 +5113,7 @@ export interface CreateVerifiedAccessGroupRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -5227,7 +5228,7 @@ export interface CreateVerifiedAccessInstanceRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -5386,7 +5387,7 @@ export interface CreateVerifiedAccessTrustProviderRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -5460,7 +5461,7 @@ export interface CreateVolumeRequest { * * *For io2
volumes, you can achieve up to 256,000 IOPS on
- * instances
+ * instances
* built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS.
* This parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. + *
The identifier of the KMS key to use for Amazon EBS encryption.
* If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is
* specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
@@ -5587,7 +5588,7 @@ export interface CreateVolumeRequest { /** *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
+ * volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is
* supported with io1
and io2
volumes only. For more information,
* see
* Amazon EBS Multi-Attach in the Amazon EBS User Guide.
Unique, case-sensitive identifier that you provide to ensure the idempotency - * of the request. For more information, see Ensure + * of the request. For more information, see Ensure * Idempotency.
* @public */ @@ -5663,7 +5664,7 @@ export interface Volume { Encrypted?: boolean; /** - *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the + *
The Amazon Resource Name (ARN) of the KMS key that was used to protect the * volume encryption key for the volume.
* @public */ @@ -6027,7 +6028,7 @@ export interface CreateVpcEndpointRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to ensure + * request. For more information, see How to ensure * idempotency.
* @public */ @@ -6335,7 +6336,7 @@ export interface CreateVpcEndpointConnectionNotificationRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to ensure + * request. For more information, see How to ensure * idempotency.
* @public */ @@ -6483,7 +6484,7 @@ export interface CreateVpcEndpointServiceConfigurationRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - * For more information, see How to ensure + * For more information, see How to ensure * idempotency.
* @public */ diff --git a/clients/client-ec2/src/models/models_3.ts b/clients/client-ec2/src/models/models_3.ts index 3190a4c7c94a..40244a0a4a94 100644 --- a/clients/client-ec2/src/models/models_3.ts +++ b/clients/client-ec2/src/models/models_3.ts @@ -1169,7 +1169,7 @@ export interface DeleteVerifiedAccessEndpointRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -1206,7 +1206,7 @@ export interface DeleteVerifiedAccessGroupRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -1251,7 +1251,7 @@ export interface DeleteVerifiedAccessInstanceRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -1288,7 +1288,7 @@ export interface DeleteVerifiedAccessTrustProviderRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -3082,9 +3082,9 @@ export interface CapacityReservationFleet { State?: CapacityReservationFleetState; /** - *The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. - * For more information, see Total target capacity - * in the Amazon EC2 User Guide.
+ *The total number of capacity units for which the Capacity Reservation Fleet reserves + * capacity. For more information, see Total target + * capacity in the Amazon EC2 User Guide.
* @public */ TotalTargetCapacity?: number; @@ -3138,9 +3138,8 @@ export interface CapacityReservationFleet { /** *The strategy used by the Capacity Reservation Fleet to determine which of the specified - * instance types to use. For more information, see For more information, see - * - * Allocation strategy in the Amazon EC2 User Guide.
+ * instance types to use. For more information, see For more information, see Allocation + * strategy in the Amazon EC2 User Guide. * @public */ AllocationStrategy?: string; @@ -4909,8 +4908,7 @@ export interface DescribeCustomerGatewaysResult { */ export interface DescribeDhcpOptionsRequest { /** - *The IDs of one or more DHCP options sets.
- *Default: Describes all your DHCP options sets.
+ *The IDs of DHCP option sets.
* @public */ DhcpOptionsIds?: string[]; @@ -4976,7 +4974,7 @@ export interface DescribeDhcpOptionsRequest { */ export interface DescribeDhcpOptionsResult { /** - *Information about one or more DHCP options sets.
+ *Information about the DHCP options sets.
* @public */ DhcpOptions?: DhcpOptions[]; @@ -5067,8 +5065,8 @@ export interface DescribeElasticGpusRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation
.
- * Otherwise, it is UnauthorizedOperation
.
DryRunOperation
.
+ * Otherwise, it is UnauthorizedOperation
.
* @public
*/
DryRun?: boolean;
@@ -5137,9 +5135,8 @@ export type ElasticGpuStatus = (typeof ElasticGpuStatus)[keyof typeof ElasticGpu
/**
* Amazon Elastic Graphics reached end of life on January 8, 2024. For - * workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, - * G4dn, or G5 instances.
+ *Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, + * we recommend that you use Amazon EC2 G4, G5, or G6 instances.
*Describes the status of an Elastic Graphics accelerator.
* @public @@ -5167,9 +5164,8 @@ export type ElasticGpuState = (typeof ElasticGpuState)[keyof typeof ElasticGpuSt /** *Amazon Elastic Graphics reached end of life on January 8, 2024. For - * workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, - * G4dn, or G5 instances.
+ *Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, + * we recommend that you use Amazon EC2 G4, G5, or G6 instances.
*Describes an Elastic Graphics accelerator.
* @public @@ -6386,9 +6382,10 @@ export interface OnDemandOptions { SingleAvailabilityZone?: boolean; /** - *The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is - * not reached, the fleet launches no instances.
- *Supported only for fleets of type instant
.
The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't + * reached, no instances are launched.
+ *Constraints: Maximum value of 1000
. Supported only for fleets of type
+ * instant
.
At least one of the following must be specified: SingleAvailabilityZone
|
* SingleInstanceType
*
The maximum amount per hour for On-Demand Instances that you're willing to pay.
*If your fleet includes T instances that are configured as unlimited
,
- * and if their average CPU usage exceeds the baseline utilization, you will incur a charge
- * for surplus credits. The maxTotalPrice
does not account for surplus
- * credits, and, if you use surplus credits, your final cost might be higher than what you
- * specified for maxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User
- * Guide.
If your fleet includes T instances that are configured as unlimited
, and
+ * if their average CPU usage exceeds the baseline utilization, you will incur a charge for
+ * surplus credits. The maxTotalPrice
does not account for surplus credits,
+ * and, if you use surplus credits, your final cost might be higher than what you specified
+ * for maxTotalPrice
. For more information, see Surplus credits can incur charges in the
+ * Amazon EC2 User Guide.
EC2 Fleet requests instances from all of the Spot Instance pools that you * specify.
* - *EC2 Fleet requests instances from the lowest priced Spot Instance pool that - * has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances - * come from the next lowest priced pool that has available capacity. If a pool runs out of - * capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your - * request by drawing from the next lowest priced pool. To ensure that your desired capacity is - * met, you might receive Spot Instances from several pools. Because this strategy only considers instance - * price and not capacity availability, it might lead to high interruption rates.
+ *We don't recommend the lowest-price
allocation strategy because
+ * it has the highest risk of interruption for your Spot Instances.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available + * capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances + * come from the next lowest priced pool that has available capacity. If a pool runs + * out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to + * fulfill your request by drawing from the next lowest priced pool. To ensure that + * your desired capacity is met, you might receive Spot Instances from several pools. Because + * this strategy only considers instance price and not capacity availability, it + * might lead to high interruption rates.
*Default: lowest-price
@@ -6562,9 +6564,10 @@ export interface SpotOptions {
SingleAvailabilityZone?: boolean;
/**
- *
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is - * not reached, the fleet launches no instances.
- *Supported only for fleets of type instant
.
The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't + * reached, no instances are launched.
+ *Constraints: Maximum value of 1000
. Supported only for fleets of type
+ * instant
.
At least one of the following must be specified: SingleAvailabilityZone
|
* SingleInstanceType
*
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
* *If your fleet includes T instances that are configured as unlimited
,
- * and if their average CPU usage exceeds the baseline utilization, you will incur a charge
- * for surplus credits. The maxTotalPrice
does not account for surplus
- * credits, and, if you use surplus credits, your final cost might be higher than what you
- * specified for maxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User
- * Guide.
If your fleet includes T instances that are configured as unlimited
, and
+ * if their average CPU usage exceeds the baseline utilization, you will incur a charge for
+ * surplus credits. The maxTotalPrice
does not account for surplus credits,
+ * and, if you use surplus credits, your final cost might be higher than what you specified
+ * for maxTotalPrice
. For more information, see Surplus credits can incur charges in the
+ * Amazon EC2 User Guide.
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
+ * 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
diff --git a/clients/client-ec2/src/models/models_4.ts b/clients/client-ec2/src/models/models_4.ts
index 1ad5c2a991bb..3b2b31d91fae 100644
--- a/clients/client-ec2/src/models/models_4.ts
+++ b/clients/client-ec2/src/models/models_4.ts
@@ -1400,8 +1400,11 @@ export interface DescribeInstancesRequest {
*
* private-ip-address
- The private IPv4 address of the
- * instance.private-ip-address
- The private IPv4 address of the instance.
+ * This can only be used to filter by the primary IP address of the network
+ * interface attached to the instance. To filter by additional IP addresses
+ * assigned to the network interface, use the filter
+ * network-interface.addresses.private-ip-address
.
@@ -1634,9 +1637,8 @@ export type InstanceBootModeValues = (typeof InstanceBootModeValues)[keyof typeo
/**
* Amazon Elastic Graphics reached end of life on January 8, 2024. For
- * workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad,
- * G4dn, or G5 instances. Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration,
+ * we recommend that you use Amazon EC2 G4, G5, or G6 instances.
Describes the association between an instance and an Elastic Graphics accelerator.
* @public @@ -1711,8 +1713,8 @@ export interface ElasticInferenceAcceleratorAssociation { /** *Indicates whether your instance is configured for hibernation. This parameter is valid * only if the instance meets the hibernation - * prerequisites. For more information, see Hibernate your instance in the - * Amazon EC2 User Guide.
+ * prerequisites. For more information, see Hibernate your Amazon EC2 + * instance in the Amazon EC2 User Guide. * @public */ export interface HibernationOptions { @@ -2078,7 +2080,7 @@ export interface InstanceNetworkInterfaceAttachment { } /** - *A security group connection tracking specification response that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking specification response that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
* @public */ export interface ConnectionTrackingSpecificationResponse { @@ -2279,7 +2281,7 @@ export interface InstanceNetworkInterface { Ipv6Prefixes?: InstanceIpv6Prefix[]; /** - *A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
* @public */ ConnectionTrackingConfiguration?: ConnectionTrackingSpecificationResponse; @@ -3350,22 +3352,23 @@ export interface DescribeInstanceTypeOfferingsRequest { *
- * availability-zone
- The Availability Zone. When you specify a location filter, it must be
- * an Availability Zone for the current Region.
availability-zone
- The Availability Zone. When you specify a location
+ * filter, it must be an Availability Zone for the current Region.
*
- * availability-zone-id
- The AZ ID. When you specify a location filter, it must be
- * an AZ ID for the current Region.
availability-zone-id
- The AZ ID. When you specify a location filter, it must
+ * be an AZ ID for the current Region.
*
- * outpost
- The Outpost ARN. When you specify a location filter, it must be an Outpost ARN
- * for the current Region.
outpost
- The Outpost ARN. When you specify a location filter, it must be an
+ * Outpost ARN for the current Region.
*
- * region
- The current Region. If you specify a location filter, it must match the current Region.
region
- The current Region. If you specify a location filter, it must match
+ * the current Region.
*
- * instance-type
- The instance type. For a list of possible values, see
- * Instance.
instance-type
- The instance type. For a list of possible values, see Instance.
* @@ -3410,7 +3412,8 @@ export interface DescribeInstanceTypeOfferingsRequest { */ export interface InstanceTypeOffering { /** - *
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
+ *The instance type. For more information, see Instance types in the Amazon EC2 + * User Guide.
* @public */ InstanceType?: _InstanceType; @@ -3422,8 +3425,9 @@ export interface InstanceTypeOffering { LocationType?: LocationType; /** - *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
.)
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
.)
- * auto-recovery-supported
- Indicates whether Amazon CloudWatch action based recovery is supported (true
| false
).
auto-recovery-supported
- Indicates whether Amazon CloudWatch action
+ * based recovery is supported (true
| false
).
*
- * bare-metal
- Indicates whether it is a bare metal instance type (true
| false
).
bare-metal
- Indicates whether it is a bare metal instance type
+ * (true
| false
).
* @@ -3489,7 +3495,7 @@ export interface DescribeInstanceTypesRequest { *
* ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps
- The baseline
- * bandwidth performance for an EBS-optimized instance type, in Mbps.
@@ -3504,12 +3510,12 @@ export interface DescribeInstanceTypesRequest { *
* 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.
@@ -3530,7 +3536,8 @@ export interface DescribeInstanceTypesRequest { *
* ebs-info.nvme-support
- Indicates whether non-volatile memory express (NVMe)
- * is supported for EBS volumes (required
| supported
| unsupported
).
required
| supported
|
+ * unsupported
).
* @@ -3539,7 +3546,8 @@ export interface DescribeInstanceTypesRequest { *
- * hibernation-supported
- Indicates whether On-Demand hibernation is supported (true
| false
).
hibernation-supported
- Indicates whether On-Demand hibernation is supported
+ * (true
| false
).
* @@ -3551,8 +3559,8 @@ export interface DescribeInstanceTypesRequest { *
- * instance-storage-info.disk.size-in-gb
- The storage size of each instance storage disk, in
- * GB.
instance-storage-info.disk.size-in-gb
- The storage size of each instance
+ * storage disk, in GB.
* @@ -3561,19 +3569,20 @@ export interface DescribeInstanceTypesRequest { *
- * instance-storage-info.encryption-support
- Indicates whether data is encrypted at rest
- * (required
| supported
| unsupported
).
instance-storage-info.encryption-support
- Indicates whether data is
+ * encrypted at rest (required
| supported
|
+ * unsupported
).
*
* instance-storage-info.nvme-support
- Indicates whether non-volatile memory
- * express (NVMe) is supported for instance store (required
| supported
|
- * unsupported
).
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-info.total-size-in-gb
- The total amount of storage
+ * available from all local instance storage, in GB.
* @@ -3607,22 +3616,23 @@ export interface DescribeInstanceTypesRequest { *
- * network-info.encryption-in-transit-supported
- Indicates whether the instance type
- * automatically encrypts in-transit traffic between instances (true
| false
).
network-info.encryption-in-transit-supported
- Indicates whether the instance
+ * type automatically encrypts in-transit traffic between instances (true
| false
).
*
- * network-info.ipv4-addresses-per-interface
- The maximum number of private IPv4 addresses per
- * network interface.
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-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.ipv6-supported
- Indicates whether the instance type supports
+ * IPv6 (true
| false
).
* @@ -3631,7 +3641,8 @@ export interface DescribeInstanceTypesRequest { *
- * network-info.maximum-network-interfaces
- The maximum number of network interfaces per instance.
network-info.maximum-network-interfaces
- The maximum number of network
+ * interfaces per instance.
* @@ -3640,17 +3651,18 @@ export interface DescribeInstanceTypesRequest { *
- * nitro-enclaves-support
- Indicates whether Nitro Enclaves is supported (supported
|
- * unsupported
).
nitro-enclaves-support
- Indicates whether Nitro Enclaves is supported
+ * (supported
| unsupported
).
*
- * nitro-tpm-support
- Indicates whether NitroTPM is supported (supported
|
- * unsupported
).
nitro-tpm-support
- Indicates whether NitroTPM is supported
+ * (supported
| unsupported
).
*
- * nitro-tpm-info.supported-versions
- The supported NitroTPM version (2.0
).
nitro-tpm-info.supported-versions
- The supported NitroTPM version
+ * (2.0
).
* @@ -3659,11 +3671,13 @@ export interface DescribeInstanceTypesRequest { *
- * processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in GHz.
processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in
+ * GHz.
*
- * processor-info.supported-features
- The supported CPU features (amd-sev-snp
).
processor-info.supported-features
- The supported CPU features
+ * (amd-sev-snp
).
* @@ -3687,25 +3701,28 @@ export interface DescribeInstanceTypesRequest { *
- * vcpu-info.default-cores
- The default number of cores for the instance type.
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-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.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-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".
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".
* The baseline input/output storage operations per seconds for an EBS-optimized instance type.
+ *The baseline input/output storage operations per seconds for an EBS-optimized instance + * type.
* @public */ BaselineIops?: number; @@ -3763,7 +3781,8 @@ export interface EbsOptimizedInfo { MaximumThroughputInMBps?: number; /** - *The maximum input/output storage operations per second for an EBS-optimized instance type.
+ *The maximum input/output storage operations per second for an EBS-optimized instance + * type.
* @public */ MaximumIops?: number; @@ -3820,7 +3839,7 @@ export type EbsNvmeSupport = (typeof EbsNvmeSupport)[keyof typeof EbsNvmeSupport export interface EbsInfo { /** *Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized - * instances in Amazon EC2 User Guide.
+ * instances in Amazon EC2 User Guide. * @public */ EbsOptimizedSupport?: EbsOptimizedSupport; @@ -4032,7 +4051,8 @@ export interface InferenceAcceleratorInfo { Accelerators?: InferenceDeviceInfo[]; /** - *The total size of the memory for the inference accelerators for the instance type, in MiB.
+ *The total size of the memory for the inference accelerators for the instance type, in + * MiB.
* @public */ TotalInferenceMemoryInMiB?: number; @@ -4190,7 +4210,8 @@ export interface MediaAcceleratorInfo { Accelerators?: MediaDeviceInfo[]; /** - *The total size of the memory for the media accelerators for the instance type, in MiB.
+ *The total size of the memory for the media accelerators for the instance type, in + * MiB.
* @public */ TotalMediaMemoryInMiB?: number; @@ -4343,15 +4364,15 @@ export interface NetworkInfo { EfaInfo?: EfaInfo; /** - *Indicates whether the instance type automatically encrypts in-transit traffic between instances.
+ *Indicates whether the instance type automatically encrypts in-transit traffic between + * instances.
* @public */ EncryptionInTransitSupported?: boolean; /** - *Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable - * Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and - * minimize tail latency of network traffic between EC2 instances.
+ *Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream + * and minimize tail latency of network traffic between EC2 instances.
* @public */ EnaSrdSupported?: boolean; @@ -4429,7 +4450,8 @@ export interface NeuronInfo { NeuronDevices?: NeuronDeviceInfo[]; /** - *The total size of the memory for the neuron accelerators for the instance type, in MiB.
+ *The total size of the memory for the neuron accelerators for the instance type, in + * MiB.
* @public */ TotalNeuronDeviceMemoryInMiB?: number; @@ -4566,9 +4588,9 @@ export interface ProcessorInfo { /** *Indicates whether the instance type supports AMD SEV-SNP. If the request returns
- * amd-sev-snp
, AMD SEV-SNP is supported. Otherwise, it is not supported.
- * For more information, see
- * AMD SEV-SNP.
amd-sev-snp
, AMD SEV-SNP is supported. Otherwise, it is not supported. For more
+ * information, see AMD
+ * SEV-SNP.
* @public
*/
SupportedFeatures?: SupportedAdditionalProcessorFeature[];
@@ -4665,7 +4687,8 @@ export interface VCpuInfo {
*/
export interface InstanceTypeInfo {
/**
- * The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
+ *The instance type. For more information, see Instance types in the Amazon EC2 + * User Guide.
* @public */ InstanceType?: _InstanceType; @@ -4785,9 +4808,9 @@ export interface InstanceTypeInfo { HibernationSupported?: boolean; /** - *Indicates whether the instance type is a burstable performance T instance - * type. For more information, see Burstable - * performance instances.
+ *Indicates whether the instance type is a burstable performance T instance type. For more + * information, see Burstable performance + * instances.
* @public */ BurstablePerformanceSupported?: boolean; @@ -4805,8 +4828,8 @@ export interface InstanceTypeInfo { AutoRecoverySupported?: boolean; /** - *The supported boot modes. For more information, see Boot modes in the - * Amazon EC2 User Guide.
+ *The supported boot modes. For more information, see Boot modes in the Amazon EC2 User + * Guide.
* @public */ SupportedBootModes?: BootModeType[]; @@ -4940,7 +4963,7 @@ export interface DescribeInternetGatewaysRequest { */ export interface DescribeInternetGatewaysResult { /** - *Information about one or more internet gateways.
+ *Information about the internet gateways.
* @public */ InternetGateways?: InternetGateway[]; @@ -5756,7 +5779,7 @@ export interface DescribeLaunchTemplateVersionsRequest { *If false
, and if a Systems Manager parameter is specified for ImageId
,
* the parameter is displayed in the response for imageId
.
For more information, see Use a Systems - * Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
+ * Manager parameter instead of an AMI ID in the Amazon EC2 User Guide. *Default: false
*
The IDs of the network ACLs.
- *Default: Describes all your network ACLs.
* @public */ NetworkAclIds?: string[]; @@ -7040,7 +7062,7 @@ export interface DescribeNetworkAclsRequest { */ export interface DescribeNetworkAclsResult { /** - *Information about one or more network ACLs.
+ *Information about the network ACLs.
* @public */ NetworkAcls?: NetworkAcl[]; @@ -9176,9 +9198,9 @@ export interface DescribeReservedInstancesOfferingsRequest { IncludeMarketplace?: boolean; /** - *The instance type that the reservation will cover (for example, m1.small
). For more information, see
- * Instance types in the
- * Amazon EC2 User Guide.
The instance type that the reservation will cover (for example, m1.small
).
+ * For more information, see Amazon EC2 instance types in the
+ * Amazon EC2 User Guide.
The IDs of the route tables.
- *Default: Describes all your route tables.
* @public */ RouteTableIds?: string[]; @@ -9558,7 +9579,7 @@ export interface DescribeRouteTablesRequest { */ export interface DescribeRouteTablesResult { /** - *Information about one or more route tables.
+ *Information about the route tables.
* @public */ RouteTables?: RouteTable[]; @@ -10571,18 +10592,16 @@ export interface DescribeSnapshotsRequest { Filters?: Filter[]; /** - *The maximum number of snapshots to return for this request. - * This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. - * If this parameter is not used, then the request returns all snapshots. - * You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, - * see Pagination.
+ *The maximum number of items to return for this request. + * To get the next page of items, make another request with the token returned in the output. + * For more information, see Pagination.
* @public */ MaxResults?: number; /** *The token returned from a previous paginated request. - * Pagination continues from the end of the items returned by the previous request.
+ * Pagination continues from the end of the items returned by the previous request. * @public */ NextToken?: string; @@ -10627,8 +10646,8 @@ export interface DescribeSnapshotsResult { Snapshots?: Snapshot[]; /** - *The token to include in another request to return the next page of snapshots.
- * This value is null
when there are no more snapshots to return.
The token to include in another request to get the next page of items.
+ * This value is null
when there are no more items to return.
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
+ *A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
* @public */ ConnectionTrackingSpecification?: ConnectionTrackingSpecificationRequest; @@ -11682,7 +11701,8 @@ export type ReplacementStrategy = (typeof ReplacementStrategy)[keyof typeof Repl /** *The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your * Spot Instance is at an elevated risk of being interrupted. For more information, see - * Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
+ * Capacity + * rebalancing in the Amazon EC2 User Guide. * @public */ export interface SpotCapacityRebalance { @@ -11724,7 +11744,8 @@ export interface SpotMaintenanceStrategies { /** *The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your * Spot Instance is at an elevated risk of being interrupted. For more information, see - * Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
+ * Capacity + * rebalancing in the Amazon EC2 User Guide. * @public */ CapacityRebalance?: SpotCapacityRebalance; @@ -11768,15 +11789,20 @@ export interface SpotFleetRequestConfigData { *Spot Fleet requests instances from all of the Spot Instance pools that you * specify.
* - *Spot Fleet requests instances from the lowest priced Spot Instance pool that - * has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances - * come from the next lowest priced pool that has available capacity. If a pool runs out of - * capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your - * request by drawing from the next lowest priced pool. To ensure that your desired capacity is - * met, you might receive Spot Instances from several pools. Because this strategy only considers instance - * price and not capacity availability, it might lead to high interruption rates.
+ *We don't recommend the lowestPrice
allocation strategy because
+ * it has the highest risk of interruption for your Spot Instances.
Spot Fleet requests instances from the lowest priced Spot Instance pool that has available + * capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances + * come from the next lowest priced pool that has available capacity. If a pool runs + * out of capacity before fulfilling your desired capacity, Spot Fleet will continue to + * fulfill your request by drawing from the next lowest priced pool. To ensure that + * your desired capacity is met, you might receive Spot Instances from several pools. Because + * this strategy only considers instance price and not capacity availability, it + * might lead to high interruption rates.
*Default: lowestPrice
@@ -11832,13 +11858,12 @@ export interface SpotFleetRequestConfigData {
OnDemandFulfilledCapacity?: number;
/**
- *
The Amazon Resource Name (ARN) of an 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. 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
.
The Amazon Resource Name (ARN) of an 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. 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
.
onDemandMaxTotalPrice
does not account for surplus
* credits, and, if you use surplus credits, your final cost might be higher than what you
- * specified for onDemandMaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User
- * Guide.
+ * specified for onDemandMaxTotalPrice
. For more information, see Surplus credits can incur charges in the
+ * Amazon EC2 User Guide.
*
* @public
*/
@@ -11928,8 +11953,8 @@ export interface SpotFleetRequestConfigData {
* and if their average CPU usage exceeds the baseline utilization, you will incur a charge
* for surplus credits. The spotMaxTotalPrice
does not account for surplus
* credits, and, if you use surplus credits, your final cost might be higher than what you
- * specified for spotMaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User
- * Guide.
+ * specified for spotMaxTotalPrice
. For more information, see Surplus credits can incur charges in the
+ * Amazon EC2 User Guide.
*
* @public
*/
@@ -12275,7 +12300,7 @@ export interface DescribeSpotInstanceRequestsRequest {
* | 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.
+ * request status in the Amazon EC2 User Guide.
* @@ -12480,7 +12505,7 @@ export type SpotInstanceState = (typeof SpotInstanceState)[keyof typeof SpotInst */ export interface SpotInstanceStatus { /** - *
The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.
+ *The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide.
* @public */ Code?: string; @@ -12583,7 +12608,7 @@ export interface SpotInstanceRequest { /** *The state of the Spot Instance request. Spot request status information helps track your Spot * Instance requests. For more information, see Spot request status in the - * Amazon EC2 User Guide for Linux Instances.
+ * Amazon EC2 User Guide. * @public */ State?: SpotInstanceState; diff --git a/clients/client-ec2/src/models/models_5.ts b/clients/client-ec2/src/models/models_5.ts index 7f799c9cb2a6..75cf7982c878 100644 --- a/clients/client-ec2/src/models/models_5.ts +++ b/clients/client-ec2/src/models/models_5.ts @@ -703,7 +703,7 @@ export interface DescribeSubnetsRequest { */ export interface DescribeSubnetsResult { /** - *Information about one or more subnets.
+ *Information about the subnets.
* @public */ Subnets?: Subnet[]; @@ -2717,17 +2717,16 @@ export interface DescribeVolumesRequest { DryRun?: boolean; /** - *The maximum number of volumes to return for this request. - * This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. - * If this parameter is not used, then all items are returned. You cannot specify this parameter and the - * volume IDs parameter in the same request. For more information, see Pagination.
+ *The maximum number of items to return for this request. + * To get the next page of items, make another request with the token returned in the output. + * For more information, see Pagination.
* @public */ MaxResults?: number; /** *The token returned from a previous paginated request. - * Pagination continues from the end of the items returned from the previous request.
+ * Pagination continues from the end of the items returned by the previous request. * @public */ NextToken?: string; @@ -2745,7 +2744,7 @@ export interface DescribeVolumesResult { /** *The token to include in another request to get the next page of items.
- * This value is null
when there are no more items to return.
null
when there are no more items to return.
* @public
*/
NextToken?: string;
@@ -2825,8 +2824,8 @@ export interface DescribeVolumesModificationsRequest {
Filters?: Filter[];
/**
- * The token returned by a previous paginated request. - * Pagination continues from the end of the items returned by the previous request.
+ *The token returned from a previous paginated request. + * Pagination continues from the end of the items returned by the previous request.
* @public */ NextToken?: string; @@ -2971,7 +2970,7 @@ export interface DescribeVolumesModificationsResult { /** *The token to include in another request to get the next page of items.
- * This value is null
if there are no more items to return.
null
when there are no more items to return.
* @public
*/
NextToken?: string;
@@ -3049,18 +3048,16 @@ export interface DescribeVolumeStatusRequest {
Filters?: Filter[];
/**
- * The maximum number of items to return for this request. To get the next page of items, - * make another request with the token returned in the output. This value can be between 5 and 1,000; - * if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, - * then all items are returned. You cannot specify this parameter and the volume IDs parameter in the - * same request. For more information, see Pagination.
+ *The maximum number of items to return for this request. + * To get the next page of items, make another request with the token returned in the output. + * For more information, see Pagination.
* @public */ MaxResults?: number; /** *The token returned from a previous paginated request. - * Pagination continues from the end of the items returned by the previous request.
+ * Pagination continues from the end of the items returned by the previous request. * @public */ NextToken?: string; @@ -3290,7 +3287,7 @@ export interface VolumeStatusItem { export interface DescribeVolumeStatusResult { /** *The token to include in another request to get the next page of items.
- * This value is null
when there are no more items to return.
null
when there are no more items to return.
* @public
*/
NextToken?: string;
@@ -3834,7 +3831,7 @@ export interface DescribeVpcEndpointsRequest {
*/
export interface DescribeVpcEndpointsResult {
/**
- * Information about the endpoints.
+ *Information about the VPC endpoints.
* @public */ VpcEndpoints?: VpcEndpoint[]; @@ -4403,7 +4400,6 @@ export interface DescribeVpcsRequest { /** *The IDs of the VPCs.
- *Default: Describes all your VPCs.
* @public */ VpcIds?: string[]; @@ -4436,7 +4432,7 @@ export interface DescribeVpcsRequest { */ export interface DescribeVpcsResult { /** - *Information about one or more VPCs.
+ *Information about the VPCs.
* @public */ Vpcs?: Vpc[]; @@ -4758,7 +4754,7 @@ export interface DetachVerifiedAccessTrustProviderRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -6100,8 +6096,8 @@ export interface DisassociateTrunkInterfaceRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency.
+ * request. For more information, see Ensuring + * idempotency. * @public */ ClientToken?: string; @@ -6127,8 +6123,8 @@ export interface DisassociateTrunkInterfaceResult { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency.
+ * request. For more information, see Ensuring + * idempotency. * @public */ ClientToken?: string; diff --git a/clients/client-ec2/src/models/models_6.ts b/clients/client-ec2/src/models/models_6.ts index 3f98f877fd6c..37625c83a1b7 100644 --- a/clients/client-ec2/src/models/models_6.ts +++ b/clients/client-ec2/src/models/models_6.ts @@ -4347,8 +4347,8 @@ export interface ModifyAvailabilityZoneGroupRequest { GroupName: string | undefined; /** - *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 Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.
Indicates whether to opt in to the zone group. The only valid value is opted-in
.
+ * You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.
The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, - * together with the instance type weights that you assign to each instance type used by the Fleet - * determine the number of instances for which the Fleet reserves capacity. Both values are based on - * units that make sense for your workload. For more information, see Total target capacity - * in the Amazon EC2 User Guide.
+ *The total number of capacity units to be reserved by the Capacity Reservation Fleet. This + * value, together with the instance type weights that you assign to each instance type + * used by the Fleet determine the number of instances for which the Fleet reserves + * capacity. Both values are based on units that make sense for your workload. For more + * information, see Total target + * capacity in the Amazon EC2 User Guide.
* @public */ TotalTargetCapacity?: number; @@ -4708,7 +4709,7 @@ export interface ModifyDefaultCreditSpecificationResult { */ export interface ModifyEbsDefaultKmsKeyIdRequest { /** - *The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. + *
The identifier of the KMS key to use for Amazon EBS encryption.
* If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is
* specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
@@ -4957,8 +4958,8 @@ export interface ModifyHostsRequest { /** *Indicates whether to enable or disable host recovery for the Dedicated Host. For more - * information, see Host recovery - * in the Amazon EC2 User Guide.
+ * information, see Host recovery in + * the Amazon EC2 User Guide. * @public */ HostRecovery?: HostRecovery; @@ -4986,7 +4987,7 @@ export interface ModifyHostsRequest { /** *Indicates whether to enable or disable host maintenance for the Dedicated Host. For - * more information, see Host + * more information, see Host * maintenance in the Amazon EC2 User Guide.
* @public */ @@ -5400,8 +5401,8 @@ export interface ModifyInstanceAttributeRequest { /** *Indicates whether an instance is enabled for stop protection. For more information, - * see Stop - * Protection.
+ * see Enable stop + * protection for your instance. * * @public */ @@ -7768,7 +7769,7 @@ export interface ModifyVerifiedAccessEndpointRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -7817,7 +7818,7 @@ export interface ModifyVerifiedAccessEndpointPolicyRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -7884,7 +7885,7 @@ export interface ModifyVerifiedAccessGroupRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -7933,7 +7934,7 @@ export interface ModifyVerifiedAccessGroupPolicyRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -8002,7 +8003,7 @@ export interface ModifyVerifiedAccessInstanceRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -8149,7 +8150,7 @@ export interface ModifyVerifiedAccessInstanceLoggingConfigurationRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -8265,7 +8266,7 @@ export interface ModifyVerifiedAccessTrustProviderRequest { /** *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring Idempotency.
+ * modification request. For more information, see Ensuring idempotency. * @public */ ClientToken?: string; @@ -8362,7 +8363,7 @@ export interface ModifyVolumeRequest { *For io2
volumes, you can achieve up to 256,000 IOPS on
- * instances
+ * instances
* built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
Default: The existing value is retained if you keep the same volume type. If you change
* the volume type to io1
, io2
, or gp3
, the default is 3,000.
Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the
- * volume to up to 16
+ * volume to up to 16
* Nitro-based instances in the same Availability Zone. This parameter is
* supported with Provides authorization for Amazon to bring a specific IP address range to a specific
- * Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.io1
and io2
volumes only. For more information, see
*
@@ -9513,7 +9514,7 @@ export interface MoveByoipCidrToIpamResult {
/**
*
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
* @public */ ClientToken?: string; @@ -453,7 +453,7 @@ export interface PurchaseReservedInstancesOfferingResult { /** *The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted * pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing - * pricing tiers in the Amazon Elastic Compute Cloud User Guide.
+ * pricing tiers in the Amazon EC2 User Guide. * @public */ ReservedInstancesId?: string; @@ -1844,8 +1844,8 @@ export interface RequestSpotInstancesRequest { /** *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.
+ * request. For more information, see Ensuring idempotency in + * Amazon EC2 API requests in the Amazon EC2 User Guide. * @public */ ClientToken?: string; @@ -2764,8 +2764,8 @@ export interface EnclaveOptionsRequest { /** *Indicates whether your instance is configured for hibernation. This parameter is valid * only if the instance meets the hibernation - * prerequisites. For more information, see Hibernate your instance in the - * Amazon EC2 User Guide.
+ * prerequisites. For more information, see Hibernate your Amazon EC2 + * instance in the Amazon EC2 User Guide. * @public */ export interface HibernationOptionsRequest { @@ -3064,8 +3064,8 @@ export interface RunInstancesRequest { ImageId?: string; /** - *The instance type. For more information, see Instance types in the - * Amazon EC2 User Guide.
+ *The instance type. For more information, see Amazon EC2 instance + * types in the Amazon EC2 User Guide.
* @public */ InstanceType?: _InstanceType; @@ -3116,25 +3116,22 @@ export interface RunInstancesRequest { KeyName?: string; /** - *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.
+ *The maximum number of instances to launch. If you specify a value that is more + * capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 + * launches the largest possible number of instances above the specified minimum + * count.
+ *Constraints: Between 1 and the quota for the specified instance type for your account for this Region. + * For more information, see Amazon EC2 instance type quotas.
* @public */ MaxCount: number | undefined; /** - *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.
+ *The minimum number of instances to launch. If you specify a value that is more + * capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does + * not launch any instances.
+ *Constraints: Between 1 and the quota for the specified instance type for your account for this Region. + * For more information, see Amazon EC2 instance type quotas.
* @public */ MinCount: number | undefined; @@ -3193,10 +3190,10 @@ export interface RunInstancesRequest { /** *The user data script to make available to the instance. For more information, see * Run - * commands on your Linux instance at launch and Run commands on your - * Windows instance at launch. 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.
+ * commands on your Amazon EC2 instance at launch in the Amazon EC2 User + * Guide. 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. * @public */ UserData?: string; @@ -3374,8 +3371,8 @@ export interface RunInstancesRequest { /** *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 EC2 User Guide.
+ * prerequisites. For more information, see Hibernate your Amazon EC2 + * instance in the Amazon EC2 User Guide. *You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same * instance.
* @public @@ -4304,7 +4301,7 @@ export interface StartNetworkInsightsAccessScopeAnalysisRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, - * see How to ensure idempotency.
+ * see How to ensure idempotency. * @public */ ClientToken?: string; @@ -4359,7 +4356,7 @@ export interface StartNetworkInsightsAnalysisRequest { /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, - * see How to ensure idempotency.
+ * see How to ensure idempotency. * @public */ ClientToken?: string; diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 351f3bb3aab2..079ae5cbbcae 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -288,7 +288,7 @@ "target": "com.amazonaws.ec2#AcceptAddressTransferResult" }, "traits": { - "smithy.api#documentation": "Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.
" } }, "com.amazonaws.ec2#AcceptAddressTransferRequest": { @@ -1415,7 +1415,7 @@ } }, "traits": { - "smithy.api#documentation": "Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
" } }, "com.amazonaws.ec2#AddressTransferList": { @@ -1538,7 +1538,7 @@ "target": "com.amazonaws.ec2#AllocateAddressResult" }, "traits": { - "smithy.api#documentation": "Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different Amazon Web Services account.
\nYou can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
\nIf you release an Elastic IP address, you might be able to recover it. You cannot recover\n an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify\n it in this operation.
\nFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nYou can allocate a carrier IP address which is a public IP address from a telecommunication carrier, \n to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
", + "smithy.api#documentation": "Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different Amazon Web Services account.
\nYou can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide.
\nIf you release an Elastic IP address, you might be able to recover it. You cannot recover\n an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify\n it in this operation.
\nFor more information, see Elastic IP Addresses in the Amazon EC2 User Guide.
\nYou can allocate a carrier IP address which is a public IP address from a telecommunication carrier, \n to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
", "smithy.api#examples": [ { "title": "To allocate an Elastic IP address", @@ -1578,7 +1578,7 @@ "NetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.
\nUse DescribeAvailabilityZones to view the network border groups.
" + "smithy.api#documentation": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.
" } }, "CustomerOwnedIpv4Pool": { @@ -1698,7 +1698,7 @@ "target": "com.amazonaws.ec2#AutoPlacement", "traits": { "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.
\nDefault: on
\n
Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.
\nDefault: off
\n
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -5888,7 +5888,7 @@ "target": "com.amazonaws.ec2#AssignIpv6AddressesResult" }, "traits": { - "smithy.api#documentation": "Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.
\nYou must specify either the IPv6 addresses or the IPv6 address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type.
\nYou must specify either the IPv6 addresses or the IPv6 address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#AssignIpv6AddressesRequest": { @@ -5979,7 +5979,7 @@ "target": "com.amazonaws.ec2#AssignPrivateIpAddressesResult" }, "traits": { - "smithy.api#documentation": "Assigns one or more secondary private IP addresses to the specified network interface.
\nYou can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nWhen you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.
\nRemapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s
in the instance\n metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Assigns one or more secondary private IP addresses to the specified network interface.
\nYou can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.
\nWhen you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.
\nRemapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s
in the instance\n metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To assign a specific secondary private IP address to an interface", @@ -6097,7 +6097,7 @@ "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddressResult" }, "traits": { - "smithy.api#documentation": "Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see \n Work with NAT gateways in the Amazon VPC User Guide.
" + "smithy.api#documentation": "Assigns private IPv4 addresses to a private NAT gateway. For more information, see \n Work with NAT gateways in the Amazon VPC User Guide.
" } }, "com.amazonaws.ec2#AssignPrivateNatGatewayAddressRequest": { @@ -6328,7 +6328,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \nFor more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -6376,7 +6376,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
\nAfter you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
\nFor more information, see DHCP options sets\n in the Amazon VPC User Guide.
", + "smithy.api#documentation": "Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
\nAfter you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
\nFor more information, see DHCP option sets\n in the Amazon VPC User Guide.
", "smithy.api#examples": [ { "title": "To associate a DHCP options set with a VPC", @@ -6775,7 +6775,7 @@ "target": "com.amazonaws.ec2#AssociateNatGatewayAddressResult" }, "traits": { - "smithy.api#documentation": "Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, \n see Work with NAT gateways in the Amazon VPC User Guide.
\nBy default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
\nWhen you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. \n
\nAssociates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, \n see Work with NAT gateways in the Amazon VPC User Guide.
\nBy default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. \n For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
\nWhen you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. \n
\nAssociates a branch network interface with a trunk network interface.
\nBefore you create the association, run the create-network-interface command and set\n --interface-type
to trunk
. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
Associates a branch network interface with a trunk network interface.
\nBefore you create the association, use CreateNetworkInterface command and set the interface type\n to trunk
. You must also create a network interface for \n each branch network interface that you want to associate with the trunk \n network interface.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -7261,7 +7261,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
", "smithy.api#xmlName": "clientToken" } } @@ -7279,7 +7279,7 @@ "target": "com.amazonaws.ec2#AssociateVpcCidrBlockResult" }, "traits": { - "smithy.api#documentation": "Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP).
\nYou must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.
\nFor more information about associating CIDR blocks with your VPC and applicable\n restrictions, see IP addressing for your VPCs and subnets \n in the Amazon VPC User Guide.
" + "smithy.api#documentation": "Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP).
\nYou must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.
\nFor more information about associating CIDR blocks with your VPC and applicable\n restrictions, see IP addressing for your VPCs and subnets \n in the Amazon VPC User Guide.
" } }, "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { @@ -7875,7 +7875,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -8264,7 +8264,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \nFor more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -10062,7 +10062,7 @@ "target": "com.amazonaws.ec2#CancelReservedInstancesListingResult" }, "traits": { - "smithy.api#documentation": "Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
\nFor more information, see \n Reserved Instance Marketplace \n in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CancelReservedInstancesListingRequest": { @@ -10810,7 +10810,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "TotalTargetCapacity", - "smithy.api#documentation": "The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. \n\t\t\tFor more information, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The total number of capacity units for which the Capacity Reservation Fleet reserves\n\t\t\tcapacity. For more information, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "totalTargetCapacity" } }, @@ -10858,7 +10858,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "The strategy used by the Capacity Reservation Fleet to determine which of the specified \n\t\t\tinstance types to use. For more information, see For more information, see \n\t\t\t\n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The strategy used by the Capacity Reservation Fleet to determine which of the specified\n\t\t\tinstance types to use. For more information, see For more information, see Allocation\n\t\t\t\tstrategy in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "allocationStrategy" } }, @@ -11554,7 +11554,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides authorization for Amazon to bring a specific IP address range to a specific\n Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Provides authorization for Amazon to bring a specific IP address range to a specific\n Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CidrBlock": { @@ -13174,7 +13174,7 @@ } }, "traits": { - "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ConnectionTrackingSpecification": { @@ -13206,7 +13206,7 @@ } }, "traits": { - "smithy.api#documentation": "A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest": { @@ -13232,7 +13232,7 @@ } }, "traits": { - "smithy.api#documentation": "A security group connection tracking specification request that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification request that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ConnectionTrackingSpecificationResponse": { @@ -13264,7 +13264,7 @@ } }, "traits": { - "smithy.api#documentation": "A security group connection tracking specification response that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification response that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ConnectivityType": { @@ -13464,7 +13464,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see Ensuring idempotency.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n \tFor more information, see Ensuring idempotency.
" } } }, @@ -13629,7 +13629,7 @@ "target": "com.amazonaws.ec2#CopySnapshotResult" }, "traits": { - "smithy.api#documentation": "Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.
\nYou can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
\nWhen copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.
\nSnapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t snapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
\nSnapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.
\nFor more information, see Copy an Amazon EBS snapshot in the\n Amazon EBS User Guide.
", + "smithy.api#documentation": "Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.
\nYou can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
\nWhen copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default KMS key; \n \thowever, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.
\nSnapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t snapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
\nSnapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.
\nFor more information, see Copy an Amazon EBS snapshot in the\n Amazon EBS User Guide.
", "smithy.api#examples": [ { "title": "To copy a snapshot", @@ -13682,7 +13682,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is\n specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.
", + "smithy.api#documentation": "The identifier of the KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is\n specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.
", "smithy.api#xmlName": "kmsKeyId" } }, @@ -13690,7 +13690,7 @@ "target": "com.amazonaws.ec2#CopySnapshotRequestPSU", "traits": { "aws.protocols#ec2QueryName": "PresignedUrl", - "smithy.api#documentation": "When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a\n pre-signed URL. This parameter is optional for unencrypted snapshots. For more information,\n see Query\n requests.
\nThe PresignedUrl
should use the snapshot source endpoint, the\n CopySnapshot
action, and include the SourceRegion
,\n SourceSnapshotId
, and DestinationRegion
parameters. The\n PresignedUrl
must be signed using Amazon Web Services Signature Version 4. Because EBS\n snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic\n that is described in Authenticating Requests: Using Query\n Parameters (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An\n invalid or improperly signed PresignedUrl
will cause the copy operation to fail\n asynchronously, and the snapshot will move to an error
state.
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a\n pre-signed URL. This parameter is optional for unencrypted snapshots. For more information,\n see Query\n requests.
\nThe PresignedUrl
should use the snapshot source endpoint, the\n CopySnapshot
action, and include the SourceRegion
,\n SourceSnapshotId
, and DestinationRegion
parameters. The\n PresignedUrl
must be signed using Amazon Web Services Signature Version 4. Because EBS\n snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic\n that is described in \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference. An\n invalid or improperly signed PresignedUrl
will cause the copy operation to fail\n asynchronously, and the snapshot will move to an error
state.
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity \n\t\t\tReservation Fleet in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a Capacity Reservation Fleet. For more information, see Create a\n\t\t\t\tCapacity Reservation Fleet in the\n\t\t\tAmazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateCapacityReservationFleetRequest": { @@ -13909,7 +13909,7 @@ "AllocationStrategy": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The strategy used by the Capacity Reservation Fleet to determine which of the \n\t\t\tspecified instance types to use. Currently, only the prioritized
\n\t\t\tallocation strategy is supported. For more information, see \n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.
Valid values: prioritized
\n
The strategy used by the Capacity Reservation Fleet to determine which of the specified\n\t\t\tinstance types to use. Currently, only the prioritized
allocation strategy\n\t\t\tis supported. For more information, see Allocation\n\t\t\t\tstrategy in the Amazon EC2 User Guide.
Valid values: prioritized
\n
The total number of capacity units to be reserved by the Capacity Reservation Fleet. This \n\t\t\tvalue, together with the instance type weights that you assign to each instance type used by \n\t\t\tthe Fleet determine the number of instances for which the Fleet reserves capacity. Both values \n\t\t\tare based on units that make sense for your workload. For more information, see \n\t\t\t\tTotal target capacity in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The total number of capacity units to be reserved by the Capacity Reservation Fleet. This\n\t\t\tvalue, together with the instance type weights that you assign to each instance type\n\t\t\tused by the Fleet determine the number of instances for which the Fleet reserves\n\t\t\tcapacity. Both values are based on units that make sense for your workload. For more\n\t\t\tinformation, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.
", "smithy.api#required": {} } }, @@ -14233,7 +14233,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -14345,7 +14345,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \nFor more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -14478,7 +14478,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \nFor more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -14848,7 +14848,7 @@ "target": "com.amazonaws.ec2#CreateDhcpOptionsResult" }, "traits": { - "smithy.api#documentation": "Creates a custom set of DHCP options. After you create a DHCP option set, you associate\n\t it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly \n\t launched instances in the VPC use this set of DHCP options.
\nThe following are the individual DHCP options you can specify. For more information, see \n DHCP options sets \n in the Amazon VPC User Guide.
\n\n domain-name
- If you're using AmazonProvidedDNS in us-east-1
, \n specify ec2.internal
. If you're using AmazonProvidedDNS in any other Region, \n specify region.compute.internal
. Otherwise, specify a custom domain name.\n This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces.\n However, Windows and other Linux operating systems treat the value as a single\n domain, which results in unexpected behavior. If your DHCP option set is\n associated with a VPC that has instances running operating systems that treat\n the value as a single domain, specify only one domain name.
\n\n domain-name-servers
- The IP addresses of up to four DNS servers,\n or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, \n separate the IP addresses using commas. To have your instances receive custom DNS \n hostnames as specified in domain-name
, you must specify a custom DNS\n server.
\n ntp-servers
- The IP addresses of up to eight Network Time Protocol (NTP)\n servers (four IPv4 addresses and four IPv6 addresses).
\n netbios-name-servers
- The IP addresses of up to four NetBIOS name\n servers.
\n netbios-node-type
- The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2. Broadcast and multicast are not supported. For more information about \n NetBIOS node types, see RFC 2132.
\n ipv6-address-preferred-lease-time
- A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. \n Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent \n lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Creates a custom set of DHCP options. After you create a DHCP option set, you associate\n\t it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly \n\t launched instances in the VPC use this set of DHCP options.
\nThe following are the individual DHCP options you can specify. For more information, see \n DHCP option sets \n in the Amazon VPC User Guide.
\n\n domain-name
- If you're using AmazonProvidedDNS in us-east-1
, \n specify ec2.internal
. If you're using AmazonProvidedDNS in any other Region, \n specify region.compute.internal
. Otherwise, specify a custom domain name.\n This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces.\n However, Windows and other Linux operating systems treat the value as a single\n domain, which results in unexpected behavior. If your DHCP option set is\n associated with a VPC that has instances running operating systems that treat\n the value as a single domain, specify only one domain name.
\n\n domain-name-servers
- The IP addresses of up to four DNS servers,\n or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, \n separate the IP addresses using commas. To have your instances receive custom DNS \n hostnames as specified in domain-name
, you must specify a custom DNS\n server.
\n ntp-servers
- The IP addresses of up to eight Network Time Protocol (NTP)\n servers (four IPv4 addresses and four IPv6 addresses).
\n netbios-name-servers
- The IP addresses of up to four NetBIOS name\n servers.
\n netbios-node-type
- The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2. Broadcast and multicast are not supported. For more information about \n NetBIOS node types, see RFC 2132.
\n ipv6-address-preferred-lease-time
- A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. \n Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent \n lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see Ensuring idempotency.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see Ensuring idempotency.
" } }, "DryRun": { @@ -15259,7 +15259,7 @@ "target": "com.amazonaws.ec2#CreateFlowLogsResult" }, "traits": { - "smithy.api#documentation": "Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.
\nFlow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon Virtual Private Cloud User Guide.
\nWhen publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.
\nFor more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.
\nFlow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon VPC User Guide.
\nWhen publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.
\nFor more information, see VPC Flow Logs \n in the Amazon VPC User Guide.
" } }, "com.amazonaws.ec2#CreateFlowLogsRequest": { @@ -15274,7 +15274,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.
" } }, "DeliverLogsPermissionArn": { @@ -15346,7 +15346,7 @@ "MaxAggregationInterval": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.
\nDefault: 600
" + "smithy.api#documentation": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.
\nDefault: 600
" } }, "DestinationOptions": { @@ -15442,7 +15442,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see Ensuring Idempotency.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n \tFor more information, see Ensuring Idempotency.
" } }, "TagSpecifications": { @@ -15585,7 +15585,7 @@ "target": "com.amazonaws.ec2#CreateInstanceConnectEndpointResult" }, "traits": { - "smithy.api#documentation": "Creates an EC2 Instance Connect Endpoint.
\nAn EC2 Instance Connect Endpoint allows you to connect to an instance, without\n requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2\n Instance Connect Endpoint in the Amazon EC2 User\n Guide.
" + "smithy.api#documentation": "Creates an EC2 Instance Connect Endpoint.
\nAn EC2 Instance Connect Endpoint allows you to connect to an instance, without\n requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2\n Instance Connect Endpoint in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateInstanceConnectEndpointRequest": { @@ -15988,7 +15988,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -16063,7 +16063,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -16208,7 +16208,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -16306,7 +16306,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.
\nTo clone an existing launch template as the basis for a new launch template, use the \n Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more \n information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon EC2 User Guide.
\nTo clone an existing launch template as the basis for a new launch template, use the \n Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more \n information, see Create a launch template from an existing launch template in the\n Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To create a launch template", @@ -16434,7 +16434,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionResult" }, "traits": { - "smithy.api#documentation": "Creates a new version of a launch template. You must specify an existing launch\n template, either by name or ID. You can determine whether the new version inherits \n parameters from a source version, and add or overwrite parameters as needed.
\nLaunch template versions are numbered in the order in which they are created. You\n can't specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes the\n changes that you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Creates a new version of a launch template. You must specify an existing launch\n template, either by name or ID. You can determine whether the new version inherits \n parameters from a source version, and add or overwrite parameters as needed.
\nLaunch template versions are numbered in the order in which they are created. You\n can't specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes the\n changes that you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To create a launch template version", @@ -16528,7 +16528,7 @@ "ResolveAlias": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "If true
, and if a Systems Manager parameter is specified for ImageId
,\n the AMI ID is displayed in the response for imageID
. For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
Default: false
\n
If true
, and if a Systems Manager parameter is specified for ImageId
,\n the AMI ID is displayed in the response for imageID
. For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
Default: false
\n
Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.
\nConstraints: Up to 255 UTF-8 characters in length.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraints: Up to 255 UTF-8 characters in length.
", "smithy.api#idempotencyToken": {} } } @@ -16962,7 +16962,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see Ensuring idempotency.
\nConstraint: Maximum 64 ASCII characters.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see Ensuring idempotency.
\nConstraint: Maximum 64 ASCII characters.
", "smithy.api#idempotencyToken": {} } }, @@ -17009,7 +17009,7 @@ "SecondaryPrivateIpAddresses": { "target": "com.amazonaws.ec2#IpList", "traits": { - "smithy.api#documentation": "Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
", + "smithy.api#documentation": "Secondary private IPv4 addresses. For more information about secondary addresses, see \n Create a NAT gateway in the Amazon VPC User Guide.
", "smithy.api#xmlName": "SecondaryPrivateIpAddress" } }, @@ -17252,7 +17252,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -17318,7 +17318,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -17437,7 +17437,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -17484,7 +17484,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfaceResult" }, "traits": { - "smithy.api#documentation": "Creates a network interface in the specified subnet.
\nThe number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.
\nFor more information about network interfaces, see Elastic network interfaces \n in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a network interface in the specified subnet.
\nThe number of IP addresses you can assign to a network interface varies by instance\n type.
\nFor more information about network interfaces, see Elastic network interfaces \n in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermission": { @@ -17677,7 +17677,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -17870,7 +17870,7 @@ "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTaskResult" }, "traits": { - "smithy.api#documentation": "Replaces the EBS-backed root volume for a running
instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Replaces the EBS-backed root volume for a running
instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest": { @@ -17893,7 +17893,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. \n If you do not specify a client token, a randomly generated token is used for the request \n to ensure idempotency. For more information, see Ensuring idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. \n If you do not specify a client token, a randomly generated token is used for the request \n to ensure idempotency. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -17952,7 +17952,7 @@ "target": "com.amazonaws.ec2#CreateReservedInstancesListingResult" }, "traits": { - "smithy.api#documentation": "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.
\nOnly Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.
\nThe Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nTo sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.
\nFor more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.
\nOnly Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.
\nThe Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nTo sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { @@ -18325,7 +18325,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -18463,7 +18463,7 @@ "target": "com.amazonaws.ec2#Snapshot" }, "traits": { - "smithy.api#documentation": "Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.
\nYou can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.
\nWhen a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.
\nYou can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending
.
When you create a snapshot for an EBS volume that serves as a root device, we recommend \n that you stop the instance before taking the snapshot.
\nSnapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.
\nYou can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon EBS User Guide.
", + "smithy.api#documentation": "Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.
\nYou can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.
\nWhen a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.
\nYou can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending
.
When you create a snapshot for an EBS volume that serves as a root device, we recommend \n that you stop the instance before taking the snapshot.
\nSnapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.
\nYou can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon EC2 User Guide.
\nFor more information, see Amazon EBS and Amazon EBS encryption in the Amazon EBS User Guide.
", "smithy.api#examples": [ { "title": "To create a snapshot", @@ -18613,7 +18613,7 @@ "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionResult" }, "traits": { - "smithy.api#documentation": "Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.\n You can create one data feed per Amazon Web Services account. For more information, see\n Spot Instance data feed \n in the Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.\n You can create one data feed per Amazon Web Services account. For more information, see\n Spot Instance data feed \n in the Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To create a Spot Instance datafeed", @@ -18792,7 +18792,7 @@ "target": "com.amazonaws.ec2#CreateSubnetCidrReservationResult" }, "traits": { - "smithy.api#documentation": "Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations \n in the Amazon Virtual Private Cloud User Guide and Assign prefixes \n to network interfaces in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations \n in the Amazon VPC User Guide and Assign prefixes \n to network interfaces in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateSubnetCidrReservationRequest": { @@ -18875,7 +18875,7 @@ "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Availability Zone or Local Zone for the subnet.
\nDefault: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we \n do not necessarily select a different zone for each subnet.
\nTo create a subnet in a Local Zone, set this value to the Local Zone ID, for example\n us-west-2-lax-1a
. For information about the Regions that support Local Zones, \n see Local Zones locations.
To create a subnet in an Outpost, set this value to the Availability Zone for the\n Outpost and specify the Outpost ARN.
" + "smithy.api#documentation": "The Availability Zone or Local Zone for the subnet.
\nDefault: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we \n do not necessarily select a different zone for each subnet.
\nTo create a subnet in a Local Zone, set this value to the Local Zone ID, for example\n us-west-2-lax-1a
. For information about the Regions that support Local Zones, \n see Available Local Zones.
To create a subnet in an Outpost, set this value to the Availability Zone for the\n Outpost and specify the Outpost ARN.
" } }, "AvailabilityZoneId": { @@ -19471,7 +19471,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult" }, "traits": { - "smithy.api#documentation": "Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.
\nThe peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
\nFor more information, see Connect peers in the Transit Gateways Guide.
" + "smithy.api#documentation": "Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.
\nThe peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
\nFor more information, see Connect peers\n in the Amazon Web Services Transit Gateways Guide.
" } }, "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest": { @@ -20445,7 +20445,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -20536,7 +20536,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -20604,7 +20604,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -20782,7 +20782,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -20828,7 +20828,7 @@ "target": "com.amazonaws.ec2#Volume" }, "traits": { - "smithy.api#documentation": "Creates an EBS volume that can be attached to an instance in the same Availability Zone.
\nYou can create a new empty volume or restore a volume from an EBS snapshot.\n Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
\nYou can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.
\nYou can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Create an Amazon EBS volume in the\n Amazon EBS User Guide.
", + "smithy.api#documentation": "Creates an EBS volume that can be attached to an instance in the same Availability Zone.
\nYou can create a new empty volume or restore a volume from an EBS snapshot.\n Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
\nYou can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.
\nYou can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon EC2 User Guide.
\nFor more information, see Create an Amazon EBS volume in the\n Amazon EBS User Guide.
", "smithy.api#examples": [ { "title": "To create a new volume", @@ -20950,13 +20950,13 @@ "Iops": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline \n 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:
\n\n gp3
: 3,000 - 16,000 IOPS
\n io1
: 100 - 64,000 IOPS
\n io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS.\n This parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline \n 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:
\n\n gp3
: 3,000 - 16,000 IOPS
\n io1
: 100 - 64,000 IOPS
\n io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS.\n This parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is\n specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.
" + "smithy.api#documentation": "The identifier of the KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is\n specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.
" } }, "OutpostArn": { @@ -21001,7 +21001,7 @@ "MultiAttachEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n \tvolume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is \n \tsupported with io1
and io2
volumes only. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon EBS User Guide.
Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is \n \tsupported with io1
and io2
volumes only. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon EBS User Guide.
Unique, case-sensitive identifier that you provide to ensure the idempotency \n of the request. For more information, see Ensure \n Idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency \n of the request. For more information, see Ensure \n Idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -21073,7 +21073,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult" }, "traits": { - "smithy.api#documentation": "Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Create a Topic in\n the Amazon Simple Notification Service Developer Guide.
\nYou can create a connection notification for interface endpoints only.
" + "smithy.api#documentation": "Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in\n the Amazon SNS Developer Guide.
\nYou can create a connection notification for interface endpoints only.
" } }, "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest": { @@ -21116,7 +21116,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.
" } } }, @@ -21221,7 +21221,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.
" } }, "PrivateDnsEnabled": { @@ -21330,7 +21330,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n For more information, see How to ensure\n idempotency.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n For more information, see How to ensure\n idempotency.
" } }, "TagSpecifications": { @@ -21378,7 +21378,7 @@ "target": "com.amazonaws.ec2#CreateVpcPeeringConnectionResult" }, "traits": { - "smithy.api#documentation": "Requests a VPC peering connection between two VPCs: a requester VPC that you own and\n\t\t an accepter VPC with which to create the connection. The accepter VPC can belong to\n\t\t another Amazon Web Services account and can be in a different Region to the requester VPC. \n The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
\nLimitations and rules apply to a VPC peering connection. For more information, see \n the limitations section in the VPC Peering Guide.
\nThe owner of the accepter VPC must accept the peering request to activate the peering\n connection. The VPC peering connection request expires after 7 days, after which it\n cannot be accepted or rejected.
\nIf you create a VPC peering connection request between VPCs with overlapping CIDR\n blocks, the VPC peering connection has a status of failed
.
Requests a VPC peering connection between two VPCs: a requester VPC that you own and\n\t\t an accepter VPC with which to create the connection. The accepter VPC can belong to\n\t\t another Amazon Web Services account and can be in a different Region to the requester VPC. \n The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
\nLimitations and rules apply to a VPC peering connection. For more information, see \n the VPC peering limitations in the VPC Peering Guide.
\nThe owner of the accepter VPC must accept the peering request to activate the peering\n connection. The VPC peering connection request expires after 7 days, after which it\n cannot be accepted or rejected.
\nIf you create a VPC peering connection request between VPCs with overlapping CIDR\n blocks, the VPC peering connection has a status of failed
.
Deletes one or more versions of a launch template.
\nYou can't delete the default version of a launch template; you must first assign a\n different version as the default. If the default version is the only version for the\n launch template, you must delete the entire launch template using DeleteLaunchTemplate.
\nYou can delete up to 200 launch template versions in a single request. To delete more\n than 200 versions in a single request, use DeleteLaunchTemplate, which\n deletes the launch template and all of its versions.
\nFor more information, see Delete a launch template version in the EC2 User\n Guide.
", + "smithy.api#documentation": "Deletes one or more versions of a launch template.
\nYou can't delete the default version of a launch template; you must first assign a\n different version as the default. If the default version is the only version for the\n launch template, you must delete the entire launch template using DeleteLaunchTemplate.
\nYou can delete up to 200 launch template versions in a single request. To delete more\n than 200 versions in a single request, use DeleteLaunchTemplate, which\n deletes the launch template and all of its versions.
\nFor more information, see Delete a launch template version in the\n Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To delete a launch template version", @@ -25749,7 +25749,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -25806,7 +25806,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -25869,7 +25869,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -25926,7 +25926,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -26971,7 +26971,7 @@ "target": "com.amazonaws.ec2#DescribeAddressTransfersResult" }, "traits": { - "smithy.api#documentation": "Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
\nWhen you transfer an Elastic IP address, there is a two-step handshake\n between the source and transfer Amazon Web Services accounts. When the source account starts the transfer,\n the transfer account has seven days to accept the Elastic IP address\n transfer. During those seven days, the source account can view the\n pending transfer by using this action. After seven days, the\n transfer expires and ownership of the Elastic IP\n address returns to the source\n account. Accepted transfers are visible to the source account for three days\n after the transfers have been accepted.
", + "smithy.api#documentation": "Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
\nWhen you transfer an Elastic IP address, there is a two-step handshake\n between the source and transfer Amazon Web Services accounts. When the source account starts the transfer,\n the transfer account has seven days to accept the Elastic IP address\n transfer. During those seven days, the source account can view the\n pending transfer by using this action. After seven days, the\n transfer expires and ownership of the Elastic IP\n address returns to the source\n account. Accepted transfers are visible to the source account for three days\n after the transfers have been accepted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -27276,7 +27276,7 @@ "target": "com.amazonaws.ec2#DescribeAvailabilityZonesResult" }, "traits": { - "smithy.api#documentation": "Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to\n you. If there is an event impacting a zone, you can use this request to view the state and any\n provided messages for that zone.
\nFor more information about Availability Zones, Local Zones, and Wavelength Zones, see\n Regions and zones \n in the Amazon Elastic Compute Cloud User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the Availability Zones, Local Zones, and Wavelength Zones that are available to\n you. If there is an event impacting a zone, you can use this request to view the state and any\n provided messages for that zone.
\nFor more information about Availability Zones, Local Zones, and Wavelength Zones, see\n Regions and zones \n in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nThis action is deprecated.
\nDescribes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.
", + "smithy.api#documentation": "This action is deprecated.
\nDescribes your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28886,7 +28886,7 @@ "target": "com.amazonaws.ec2#DescribeDhcpOptionsResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your DHCP options sets.
\nFor more information, see DHCP options sets in the\n\t\t\t\tAmazon VPC User Guide.
", + "smithy.api#documentation": "Describes your DHCP option sets. The default is to describe all your DHCP option sets. \n\t\t Alternatively, you can specify specific DHCP option set IDs or filter the results to\n\t\t include only the DHCP option sets that match specific criteria.
\nFor more information, see DHCP option sets in the\n\t\t\t\tAmazon VPC User Guide.
", "smithy.api#examples": [ { "title": "To describe a DHCP options set", @@ -28939,7 +28939,7 @@ "DhcpOptionsIds": { "target": "com.amazonaws.ec2#DhcpOptionsIdStringList", "traits": { - "smithy.api#documentation": "The IDs of one or more DHCP options sets.
\nDefault: Describes all your DHCP options sets.
", + "smithy.api#documentation": "The IDs of DHCP option sets.
", "smithy.api#xmlName": "DhcpOptionsId" } }, @@ -28982,7 +28982,7 @@ "target": "com.amazonaws.ec2#DhcpOptionsList", "traits": { "aws.protocols#ec2QueryName": "DhcpOptionsSet", - "smithy.api#documentation": "Information about one or more DHCP options sets.
", + "smithy.api#documentation": "Information about the DHCP options sets.
", "smithy.api#xmlName": "dhcpOptionsSet" } }, @@ -29008,7 +29008,7 @@ "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your egress-only internet gateways.
", + "smithy.api#documentation": "Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. \n Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to\n include only the egress-only internet gateways that match specific criteria.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29099,7 +29099,7 @@ "target": "com.amazonaws.ec2#DescribeElasticGpusResult" }, "traits": { - "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.
\nDescribes the Elastic Graphics accelerator associated with your instances. For more information\n about Elastic Graphics, see Amazon Elastic Graphics.
" + "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.
\nDescribes the Elastic Graphics accelerator associated with your instances.
" } }, "com.amazonaws.ec2#DescribeElasticGpusMaxResults": { @@ -29124,7 +29124,7 @@ "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation
. \n Otherwise, it is UnauthorizedOperation
.
Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation
. \n Otherwise, it is UnauthorizedOperation
.
Lists the instance types that are offered for the specified location. If no location is specified, the default\n is to list the instance types that are offered in the current Region.
", + "smithy.api#documentation": "Lists the instance types that are offered for the specified location. If no location is\n specified, the default is to list the instance types that are offered in the current\n Region.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31954,13 +31954,13 @@ "LocationType": { "target": "com.amazonaws.ec2#LocationType", "traits": { - "smithy.api#documentation": "The location type.
\n\n availability-zone
- The Availability Zone. When you specify a location filter, it must be\n an Availability Zone for the current Region.
\n availability-zone-id
- The AZ ID. When you specify a location filter, it must be\n an AZ ID for the current Region.
\n outpost
- The Outpost ARN. When you specify a location filter, it must be an Outpost ARN\n for the current Region.
\n region
- The current Region. If you specify a location filter, it must match the current Region.
The location type.
\n\n availability-zone
- The Availability Zone. When you specify a location\n filter, it must be an Availability Zone for the current Region.
\n availability-zone-id
- The AZ ID. When you specify a location filter, it must\n be an AZ ID for the current Region.
\n outpost
- The Outpost ARN. When you specify a location filter, it must be an\n Outpost ARN for the current Region.
\n region
- The current Region. If you specify a location filter, it must match\n the current Region.
One or more filters. Filter names and values are case-sensitive.
\n\n instance-type
- The instance type. For a list of possible values, see \n Instance.
\n location
- The location. For a list of possible identifiers, see Regions and Zones.
One or more filters. Filter names and values are case-sensitive.
\n\n instance-type
- The instance type. For a list of possible values, see Instance.
\n location
- The location. For a list of possible identifiers, see Regions and Zones.
Describes the specified instance types. By default, all instance types for the current Region are described.\n Alternatively, you can filter the results.
", + "smithy.api#documentation": "Describes the specified instance types. By default, all instance types for the current\n Region are described. Alternatively, you can filter the results.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32042,7 +32042,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported
- Indicates whether Amazon CloudWatch action based recovery is supported (true
| false
).
\n bare-metal
- Indicates whether it is a bare metal instance type (true
| false
).
\n burstable-performance-supported
- Indicates whether the instance type is a \n burstable performance T instance type (true
| false
).
\n current-generation
- Indicates whether this instance type is the latest\n generation instance type of an instance family (true
| false
).
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps
- The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops
- The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps
- The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps
- The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops
- The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps
- The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support
- Indicates whether the instance type is\n EBS-optimized (supported
| unsupported
|\n default
).
\n ebs-info.encryption-support
- Indicates whether EBS encryption is supported\n (supported
| unsupported
).
\n ebs-info.nvme-support
- Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required
| supported
| unsupported
).
\n free-tier-eligible
- Indicates whether the instance type is eligible to use\n in the free tier (true
| false
).
\n hibernation-supported
- Indicates whether On-Demand hibernation is supported (true
| false
).
\n hypervisor
- The hypervisor (nitro
| xen
).
\n instance-storage-info.disk.count
- The number of local disks.
\n instance-storage-info.disk.size-in-gb
- The storage size of each instance storage disk, in\n GB.
\n instance-storage-info.disk.type
- The storage technology for the local\n instance storage disks (hdd
| ssd
).
\n instance-storage-info.encryption-support
- Indicates whether data is encrypted at rest \n (required
| supported
| unsupported
).
\n instance-storage-info.nvme-support
- Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required
| supported
|\n unsupported
).
\n instance-storage-info.total-size-in-gb
- The total amount of storage available from all local\n instance storage, in GB.
\n instance-storage-supported
- Indicates whether the instance type has local\n instance storage (true
| false
).
\n instance-type
- The instance type (for example c5.2xlarge
or\n c5*).
\n memory-info.size-in-mib
- The memory size.
\n network-info.efa-info.maximum-efa-interfaces
- The maximum number of Elastic \n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported
- Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true
| false
).
\n network-info.ena-support
- Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required
| supported
|\n unsupported
).
\n network-info.encryption-in-transit-supported
- Indicates whether the instance type \n automatically encrypts in-transit traffic between instances (true
| false
).
\n network-info.ipv4-addresses-per-interface
- The maximum number of private IPv4 addresses per\n network interface.
\n network-info.ipv6-addresses-per-interface
- The maximum number of private IPv6 addresses per\n network interface.
\n network-info.ipv6-supported
- Indicates whether the instance type supports IPv6 (true
| false
).
\n network-info.maximum-network-cards
- The maximum number of network cards per\n instance.
\n network-info.maximum-network-interfaces
- The maximum number of network interfaces per instance.
\n network-info.network-performance
- The network performance (for example, \"25\n Gigabit\").
\n nitro-enclaves-support
- Indicates whether Nitro Enclaves is supported (supported
|\n unsupported
).
\n nitro-tpm-support
- Indicates whether NitroTPM is supported (supported
|\n unsupported
).
\n nitro-tpm-info.supported-versions
- The supported NitroTPM version (2.0
).
\n processor-info.supported-architecture
- The CPU architecture\n (arm64
| i386
| x86_64
).
\n processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in GHz.
\n processor-info.supported-features
- The supported CPU features (amd-sev-snp
).
\n supported-boot-mode
- The boot mode (legacy-bios
|\n uefi
).
\n supported-root-device-type
- The root device type (ebs
|\n instance-store
).
\n supported-usage-class
- The usage class (on-demand
|\n spot
).
\n supported-virtualization-type
- The virtualization type (hvm
|\n paravirtual
).
\n vcpu-info.default-cores
- The default number of cores for the instance type.
\n vcpu-info.default-threads-per-core
- The default number of threads per core for the instance\n type.
\n vcpu-info.default-vcpus
- The default number of vCPUs for the instance type.
\n vcpu-info.valid-cores
- The number of cores that can be configured for the instance type.
\n vcpu-info.valid-threads-per-core
- The number of threads per core that can be configured for the instance type.\n For example, \"1\" or \"1,2\".
One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported
- Indicates whether Amazon CloudWatch action\n based recovery is supported (true
| false
).
\n bare-metal
- Indicates whether it is a bare metal instance type\n (true
| false
).
\n burstable-performance-supported
- Indicates whether the instance type is a\n burstable performance T instance type (true
| false
).
\n current-generation
- Indicates whether this instance type is the latest\n generation instance type of an instance family (true
| false
).
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps
- The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops
- The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps
- The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps
- The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops
- The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps
- The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support
- Indicates whether the instance type is\n EBS-optimized (supported
| unsupported
|\n default
).
\n ebs-info.encryption-support
- Indicates whether EBS encryption is supported\n (supported
| unsupported
).
\n ebs-info.nvme-support
- Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required
| supported
|\n unsupported
).
\n free-tier-eligible
- Indicates whether the instance type is eligible to use\n in the free tier (true
| false
).
\n hibernation-supported
- Indicates whether On-Demand hibernation is supported\n (true
| false
).
\n hypervisor
- The hypervisor (nitro
| xen
).
\n instance-storage-info.disk.count
- The number of local disks.
\n instance-storage-info.disk.size-in-gb
- The storage size of each instance\n storage disk, in GB.
\n instance-storage-info.disk.type
- The storage technology for the local\n instance storage disks (hdd
| ssd
).
\n instance-storage-info.encryption-support
- Indicates whether data is\n encrypted at rest (required
| supported
|\n unsupported
).
\n instance-storage-info.nvme-support
- Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required
| supported
\n | unsupported
).
\n instance-storage-info.total-size-in-gb
- The total amount of storage\n available from all local instance storage, in GB.
\n instance-storage-supported
- Indicates whether the instance type has local\n instance storage (true
| false
).
\n instance-type
- The instance type (for example c5.2xlarge
or\n c5*).
\n memory-info.size-in-mib
- The memory size.
\n network-info.efa-info.maximum-efa-interfaces
- The maximum number of Elastic\n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported
- Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true
| false
).
\n network-info.ena-support
- Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required
| supported
|\n unsupported
).
\n network-info.encryption-in-transit-supported
- Indicates whether the instance\n type automatically encrypts in-transit traffic between instances (true
| false
).
\n network-info.ipv4-addresses-per-interface
- The maximum number of private\n IPv4 addresses per network interface.
\n network-info.ipv6-addresses-per-interface
- The maximum number of private\n IPv6 addresses per network interface.
\n network-info.ipv6-supported
- Indicates whether the instance type supports\n IPv6 (true
| false
).
\n network-info.maximum-network-cards
- The maximum number of network cards per\n instance.
\n network-info.maximum-network-interfaces
- The maximum number of network\n interfaces per instance.
\n network-info.network-performance
- The network performance (for example, \"25\n Gigabit\").
\n nitro-enclaves-support
- Indicates whether Nitro Enclaves is supported\n (supported
| unsupported
).
\n nitro-tpm-support
- Indicates whether NitroTPM is supported\n (supported
| unsupported
).
\n nitro-tpm-info.supported-versions
- The supported NitroTPM version\n (2.0
).
\n processor-info.supported-architecture
- The CPU architecture\n (arm64
| i386
| x86_64
).
\n processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in\n GHz.
\n processor-info.supported-features
- The supported CPU features\n (amd-sev-snp
).
\n supported-boot-mode
- The boot mode (legacy-bios
|\n uefi
).
\n supported-root-device-type
- The root device type (ebs
|\n instance-store
).
\n supported-usage-class
- The usage class (on-demand
|\n spot
).
\n supported-virtualization-type
- The virtualization type (hvm
|\n paravirtual
).
\n vcpu-info.default-cores
- The default number of cores for the instance\n type.
\n vcpu-info.default-threads-per-core
- The default number of threads per core\n for the instance type.
\n vcpu-info.default-vcpus
- The default number of vCPUs for the instance\n type.
\n vcpu-info.valid-cores
- The number of cores that can be configured for the\n instance type.
\n vcpu-info.valid-threads-per-core
- The number of threads per core that can be\n configured for the instance type. For example, \"1\" or \"1,2\".
The filters.
\n\n affinity
- The affinity setting for an instance running on a\n Dedicated Host (default
| host
).
\n architecture
- The instance architecture (i386
|\n x86_64
| arm64
).
\n availability-zone
- The Availability Zone of the instance.
\n block-device-mapping.attach-time
- The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z
.
\n block-device-mapping.delete-on-termination
- A Boolean that\n indicates whether the EBS volume is deleted on instance termination.
\n block-device-mapping.device-name
- The device name specified in\n the block device mapping (for example, /dev/sdh
or\n xvdh
).
\n block-device-mapping.status
- The status for the EBS volume\n (attaching
| attached
| detaching
|\n detached
).
\n block-device-mapping.volume-id
- The volume ID of the EBS\n volume.
\n boot-mode
- The boot mode that was specified by the AMI\n (legacy-bios
| uefi
|\n uefi-preferred
).
\n capacity-reservation-id
- The ID of the Capacity Reservation into which the\n instance was launched.
\n capacity-reservation-specification.capacity-reservation-preference
\n - The instance's Capacity Reservation preference (open
| none
).
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id
\n - The ID of the targeted Capacity Reservation.
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
\n - The ARN of the targeted Capacity Reservation group.
\n client-token
- The idempotency token you provided when you\n launched the instance.
\n current-instance-boot-mode
- The boot mode that is used to launch\n the instance at launch or start (legacy-bios
|\n uefi
).
\n dns-name
- The public DNS name of the instance.
\n ebs-optimized
- A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.
\n ena-support
- A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.
\n enclave-options.enabled
- A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.
\n hibernation-options.configured
- A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true
means that\n the instance is enabled for hibernation.
\n host-id
- The ID of the Dedicated Host on which the instance is\n running, if applicable.
\n hypervisor
- The hypervisor type of the instance\n (ovm
| xen
). The value xen
is used\n for both Xen and Nitro hypervisors.
\n iam-instance-profile.arn
- The instance profile associated with\n the instance. Specified as an ARN.
\n iam-instance-profile.id
- The instance profile associated with\n the instance. Specified as an ID.
\n iam-instance-profile.name
- The instance profile associated with\n the instance. Specified as an name.
\n image-id
- The ID of the image used to launch the\n instance.
\n instance-id
- The ID of the instance.
\n instance-lifecycle
- Indicates whether this is a Spot Instance, a Scheduled Instance, or\n a Capacity Block (spot
| scheduled
| capacity-block
).
\n instance-state-code
- The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name
- The state of the instance\n (pending
| running
| shutting-down
|\n terminated
| stopping
|\n stopped
).
\n instance-type
- The type of instance (for example,\n t2.micro
).
\n instance.group-id
- The ID of the security group for the\n instance.
\n instance.group-name
- The name of the security group for the\n instance.
\n ip-address
- The public IPv4 address of the instance.
\n ipv6-address
- The IPv6 address of the instance.
\n kernel-id
- The kernel ID.
\n key-name
- The name of the key pair used when the instance was\n launched.
\n launch-index
- When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n
\n launch-time
- The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z
. You can use a wildcard\n (*
), for example, 2021-09-29T*
, which matches an\n entire day.
\n maintenance-options.auto-recovery
- The current automatic\n recovery behavior of the instance (disabled
| default
).
\n metadata-options.http-endpoint
- The status of access to the HTTP\n metadata endpoint on your instance (enabled
|\n disabled
)
\n metadata-options.http-protocol-ipv4
- Indicates whether the IPv4\n endpoint is enabled (disabled
| enabled
).
\n metadata-options.http-protocol-ipv6
- Indicates whether the IPv6\n endpoint is enabled (disabled
| enabled
).
\n metadata-options.http-put-response-hop-limit
- The HTTP metadata\n request put response hop limit (integer, possible values 1
to\n 64
)
\n metadata-options.http-tokens
- The metadata request authorization\n state (optional
| required
)
\n metadata-options.instance-metadata-tags
- The status of access to\n instance tags from the instance metadata (enabled
|\n disabled
)
\n metadata-options.state
- The state of the metadata option changes\n (pending
| applied
).
\n monitoring-state
- Indicates whether detailed monitoring is\n enabled (disabled
| enabled
).
\n network-interface.addresses.association.allocation-id
- The allocation ID.
\n network-interface.addresses.association.association-id
- The association ID.
\n network-interface.addresses.association.carrier-ip
- The carrier IP address.
\n network-interface.addresses.association.customer-owned-ip
- The customer-owned IP address.
\n network-interface.addresses.association.ip-owner-id
- The owner\n ID of the private IPv4 address associated with the network interface.
\n network-interface.addresses.association.public-dns-name
- The public DNS name.
\n network-interface.addresses.association.public-ip
- The ID of the\n association of an Elastic IP address (IPv4) with a network interface.
\n network-interface.addresses.primary
- Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.
\n network-interface.addresses.private-dns-name
- The private DNS name.
\n network-interface.addresses.private-ip-address
- The private IPv4\n address associated with the network interface.
\n network-interface.association.allocation-id
- The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.
\n network-interface.association.association-id
- The association ID\n returned when the network interface was associated with an IPv4 address.
\n network-interface.association.carrier-ip
- The customer-owned IP address.
\n network-interface.association.customer-owned-ip
- The customer-owned IP address.
\n network-interface.association.ip-owner-id
- The owner of the\n Elastic IP address (IPv4) associated with the network interface.
\n network-interface.association.public-dns-name
- The public DNS name.
\n network-interface.association.public-ip
- The address of the\n Elastic IP address (IPv4) bound to the network interface.
\n network-interface.attachment.attach-time
- The time that the\n network interface was attached to an instance.
\n network-interface.attachment.attachment-id
- The ID of the\n interface attachment.
\n network-interface.attachment.delete-on-termination
- Specifies\n whether the attachment is deleted when an instance is terminated.
\n network-interface.attachment.device-index
- The device index to\n which the network interface is attached.
\n network-interface.attachment.instance-id
- The ID of the instance\n to which the network interface is attached.
\n network-interface.attachment.instance-owner-id
- The owner ID of\n the instance to which the network interface is attached.
\n network-interface.attachment.network-card-index
- The index of the network card.
\n network-interface.attachment.status
- The status of the\n attachment (attaching
| attached
|\n detaching
| detached
).
\n network-interface.availability-zone
- The Availability Zone for\n the network interface.
\n network-interface.deny-all-igw-traffic
- A Boolean that indicates whether \n a network interface with an IPv6 address is unreachable from the public internet.
\n network-interface.description
- The description of the network\n interface.
\n network-interface.group-id
- The ID of a security group\n associated with the network interface.
\n network-interface.group-name
- The name of a security group\n associated with the network interface.
\n network-interface.ipv4-prefixes.ipv4-prefix
- The IPv4 prefixes that are assigned to the network interface.
\n network-interface.ipv6-address
- The IPv6 address associated with the network interface.
\n network-interface.ipv6-addresses.ipv6-address
- The IPv6 address\n associated with the network interface.
\n network-interface.ipv6-addresses.is-primary-ipv6
- A Boolean that indicates whether this\n is the primary IPv6 address.
\n network-interface.ipv6-native
- A Boolean that indicates whether this is\n an IPv6 only network interface.
\n network-interface.ipv6-prefixes.ipv6-prefix
- The IPv6 prefix assigned to the network interface.
\n network-interface.mac-address
- The MAC address of the network\n interface.
\n network-interface.network-interface-id
- The ID of the network\n interface.
\n network-interface.outpost-arn
- The ARN of the Outpost.
\n network-interface.owner-id
- The ID of the owner of the network\n interface.
\n network-interface.private-dns-name
- The private DNS name of the\n network interface.
\n network-interface.private-ip-address
- The private IPv4 address.
\n network-interface.public-dns-name
- The public DNS name.
\n network-interface.requester-id
- The requester ID for the network\n interface.
\n network-interface.requester-managed
- Indicates whether the\n network interface is being managed by Amazon Web Services.
\n network-interface.status
- The status of the network interface\n (available
) | in-use
).
\n network-interface.source-dest-check
- Whether the network\n interface performs source/destination checking. A value of true
\n means that checking is enabled, and false
means that checking is\n disabled. The value must be false
for the network interface to\n perform network address translation (NAT) in your VPC.
\n network-interface.subnet-id
- The ID of the subnet for the\n network interface.
\n network-interface.tag-key
- The key of a tag assigned to the network interface.
\n network-interface.tag-value
- The value of a tag assigned to the network interface.
\n network-interface.vpc-id
- The ID of the VPC for the network\n interface.
\n outpost-arn
- The Amazon Resource Name (ARN) of the\n Outpost.
\n owner-id
- The Amazon Web Services account ID of the instance\n owner.
\n placement-group-name
- The name of the placement group for the\n instance.
\n placement-partition-number
- The partition in which the instance is\n located.
\n platform
- The platform. To list only Windows instances, use\n windows
.
\n platform-details
- The platform (Linux/UNIX
|\n Red Hat BYOL Linux
| Red Hat Enterprise Linux
|\n Red Hat Enterprise Linux with HA
| Red Hat Enterprise\n Linux with SQL Server Standard and HA
| Red Hat Enterprise\n Linux with SQL Server Enterprise and HA
| Red Hat Enterprise\n Linux with SQL Server Standard
| Red Hat Enterprise Linux with\n SQL Server Web
| Red Hat Enterprise Linux with SQL Server\n Enterprise
| SQL Server Enterprise
| SQL Server\n Standard
| SQL Server Web
| SUSE Linux
|\n Ubuntu Pro
| Windows
| Windows BYOL
|\n Windows with SQL Server Enterprise
| Windows with SQL\n Server Standard
| Windows with SQL Server Web
).
\n private-dns-name
- The private IPv4 DNS name of the\n instance.
\n private-dns-name-options.enable-resource-name-dns-a-record
- A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.
\n private-dns-name-options.enable-resource-name-dns-aaaa-record
- A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.
\n private-dns-name-options.hostname-type
- The type of hostname\n (ip-name
| resource-name
).
\n private-ip-address
- The private IPv4 address of the\n instance.
\n product-code
- The product code associated with the AMI used to\n launch the instance.
\n product-code.type
- The type of product code (devpay
\n | marketplace
).
\n ramdisk-id
- The RAM disk ID.
\n reason
- The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.
\n requester-id
- The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).
\n reservation-id
- The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.
\n root-device-name
- The device name of the root device volume (for\n example, /dev/sda1
).
\n root-device-type
- The type of the root device volume\n (ebs
| instance-store
).
\n source-dest-check
- Indicates whether the instance performs\n source/destination checking. A value of true
means that checking is\n enabled, and false
means that checking is disabled. The value must\n be false
for the instance to perform network address translation\n (NAT) in your VPC.
\n spot-instance-request-id
- The ID of the Spot Instance\n request.
\n state-reason-code
- The reason code for the state change.
\n state-reason-message
- A message that describes the state\n change.
\n subnet-id
- The ID of the subnet for the instance.
\n tag:
- 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.\n 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.
\n 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.
\n tenancy
- The tenancy of an instance (dedicated
|\n default
| host
).
\n tpm-support
- Indicates if the instance is configured for\n NitroTPM support (v2.0
).
\n usage-operation
- The usage operation value for the instance\n (RunInstances
| RunInstances:00g0
|\n RunInstances:0010
| RunInstances:1010
|\n RunInstances:1014
| RunInstances:1110
|\n RunInstances:0014
| RunInstances:0210
|\n RunInstances:0110
| RunInstances:0100
|\n RunInstances:0004
| RunInstances:0200
|\n RunInstances:000g
| RunInstances:0g00
|\n RunInstances:0002
| RunInstances:0800
|\n RunInstances:0102
| RunInstances:0006
|\n RunInstances:0202
).
\n usage-operation-update-time
- The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z
.
\n virtualization-type
- The virtualization type of the instance\n (paravirtual
| hvm
).
\n vpc-id
- The ID of the VPC that the instance is running in.
The filters.
\n\n affinity
- The affinity setting for an instance running on a\n Dedicated Host (default
| host
).
\n architecture
- The instance architecture (i386
|\n x86_64
| arm64
).
\n availability-zone
- The Availability Zone of the instance.
\n block-device-mapping.attach-time
- The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z
.
\n block-device-mapping.delete-on-termination
- A Boolean that\n indicates whether the EBS volume is deleted on instance termination.
\n block-device-mapping.device-name
- The device name specified in\n the block device mapping (for example, /dev/sdh
or\n xvdh
).
\n block-device-mapping.status
- The status for the EBS volume\n (attaching
| attached
| detaching
|\n detached
).
\n block-device-mapping.volume-id
- The volume ID of the EBS\n volume.
\n boot-mode
- The boot mode that was specified by the AMI\n (legacy-bios
| uefi
|\n uefi-preferred
).
\n capacity-reservation-id
- The ID of the Capacity Reservation into which the\n instance was launched.
\n capacity-reservation-specification.capacity-reservation-preference
\n - The instance's Capacity Reservation preference (open
| none
).
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id
\n - The ID of the targeted Capacity Reservation.
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
\n - The ARN of the targeted Capacity Reservation group.
\n client-token
- The idempotency token you provided when you\n launched the instance.
\n current-instance-boot-mode
- The boot mode that is used to launch\n the instance at launch or start (legacy-bios
|\n uefi
).
\n dns-name
- The public DNS name of the instance.
\n ebs-optimized
- A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.
\n ena-support
- A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.
\n enclave-options.enabled
- A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.
\n hibernation-options.configured
- A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true
means that\n the instance is enabled for hibernation.
\n host-id
- The ID of the Dedicated Host on which the instance is\n running, if applicable.
\n hypervisor
- The hypervisor type of the instance\n (ovm
| xen
). The value xen
is used\n for both Xen and Nitro hypervisors.
\n iam-instance-profile.arn
- The instance profile associated with\n the instance. Specified as an ARN.
\n iam-instance-profile.id
- The instance profile associated with\n the instance. Specified as an ID.
\n iam-instance-profile.name
- The instance profile associated with\n the instance. Specified as an name.
\n image-id
- The ID of the image used to launch the\n instance.
\n instance-id
- The ID of the instance.
\n instance-lifecycle
- Indicates whether this is a Spot Instance, a Scheduled Instance, or\n a Capacity Block (spot
| scheduled
| capacity-block
).
\n instance-state-code
- The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name
- The state of the instance\n (pending
| running
| shutting-down
|\n terminated
| stopping
|\n stopped
).
\n instance-type
- The type of instance (for example,\n t2.micro
).
\n instance.group-id
- The ID of the security group for the\n instance.
\n instance.group-name
- The name of the security group for the\n instance.
\n ip-address
- The public IPv4 address of the instance.
\n ipv6-address
- The IPv6 address of the instance.
\n kernel-id
- The kernel ID.
\n key-name
- The name of the key pair used when the instance was\n launched.
\n launch-index
- When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n
\n launch-time
- The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z
. You can use a wildcard\n (*
), for example, 2021-09-29T*
, which matches an\n entire day.
\n maintenance-options.auto-recovery
- The current automatic\n recovery behavior of the instance (disabled
| default
).
\n metadata-options.http-endpoint
- The status of access to the HTTP\n metadata endpoint on your instance (enabled
|\n disabled
)
\n metadata-options.http-protocol-ipv4
- Indicates whether the IPv4\n endpoint is enabled (disabled
| enabled
).
\n metadata-options.http-protocol-ipv6
- Indicates whether the IPv6\n endpoint is enabled (disabled
| enabled
).
\n metadata-options.http-put-response-hop-limit
- The HTTP metadata\n request put response hop limit (integer, possible values 1
to\n 64
)
\n metadata-options.http-tokens
- The metadata request authorization\n state (optional
| required
)
\n metadata-options.instance-metadata-tags
- The status of access to\n instance tags from the instance metadata (enabled
|\n disabled
)
\n metadata-options.state
- The state of the metadata option changes\n (pending
| applied
).
\n monitoring-state
- Indicates whether detailed monitoring is\n enabled (disabled
| enabled
).
\n network-interface.addresses.association.allocation-id
- The allocation ID.
\n network-interface.addresses.association.association-id
- The association ID.
\n network-interface.addresses.association.carrier-ip
- The carrier IP address.
\n network-interface.addresses.association.customer-owned-ip
- The customer-owned IP address.
\n network-interface.addresses.association.ip-owner-id
- The owner\n ID of the private IPv4 address associated with the network interface.
\n network-interface.addresses.association.public-dns-name
- The public DNS name.
\n network-interface.addresses.association.public-ip
- The ID of the\n association of an Elastic IP address (IPv4) with a network interface.
\n network-interface.addresses.primary
- Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.
\n network-interface.addresses.private-dns-name
- The private DNS name.
\n network-interface.addresses.private-ip-address
- The private IPv4\n address associated with the network interface.
\n network-interface.association.allocation-id
- The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.
\n network-interface.association.association-id
- The association ID\n returned when the network interface was associated with an IPv4 address.
\n network-interface.association.carrier-ip
- The customer-owned IP address.
\n network-interface.association.customer-owned-ip
- The customer-owned IP address.
\n network-interface.association.ip-owner-id
- The owner of the\n Elastic IP address (IPv4) associated with the network interface.
\n network-interface.association.public-dns-name
- The public DNS name.
\n network-interface.association.public-ip
- The address of the\n Elastic IP address (IPv4) bound to the network interface.
\n network-interface.attachment.attach-time
- The time that the\n network interface was attached to an instance.
\n network-interface.attachment.attachment-id
- The ID of the\n interface attachment.
\n network-interface.attachment.delete-on-termination
- Specifies\n whether the attachment is deleted when an instance is terminated.
\n network-interface.attachment.device-index
- The device index to\n which the network interface is attached.
\n network-interface.attachment.instance-id
- The ID of the instance\n to which the network interface is attached.
\n network-interface.attachment.instance-owner-id
- The owner ID of\n the instance to which the network interface is attached.
\n network-interface.attachment.network-card-index
- The index of the network card.
\n network-interface.attachment.status
- The status of the\n attachment (attaching
| attached
|\n detaching
| detached
).
\n network-interface.availability-zone
- The Availability Zone for\n the network interface.
\n network-interface.deny-all-igw-traffic
- A Boolean that indicates whether \n a network interface with an IPv6 address is unreachable from the public internet.
\n network-interface.description
- The description of the network\n interface.
\n network-interface.group-id
- The ID of a security group\n associated with the network interface.
\n network-interface.group-name
- The name of a security group\n associated with the network interface.
\n network-interface.ipv4-prefixes.ipv4-prefix
- The IPv4 prefixes that are assigned to the network interface.
\n network-interface.ipv6-address
- The IPv6 address associated with the network interface.
\n network-interface.ipv6-addresses.ipv6-address
- The IPv6 address\n associated with the network interface.
\n network-interface.ipv6-addresses.is-primary-ipv6
- A Boolean that indicates whether this\n is the primary IPv6 address.
\n network-interface.ipv6-native
- A Boolean that indicates whether this is\n an IPv6 only network interface.
\n network-interface.ipv6-prefixes.ipv6-prefix
- The IPv6 prefix assigned to the network interface.
\n network-interface.mac-address
- The MAC address of the network\n interface.
\n network-interface.network-interface-id
- The ID of the network\n interface.
\n network-interface.outpost-arn
- The ARN of the Outpost.
\n network-interface.owner-id
- The ID of the owner of the network\n interface.
\n network-interface.private-dns-name
- The private DNS name of the\n network interface.
\n network-interface.private-ip-address
- The private IPv4 address.
\n network-interface.public-dns-name
- The public DNS name.
\n network-interface.requester-id
- The requester ID for the network\n interface.
\n network-interface.requester-managed
- Indicates whether the\n network interface is being managed by Amazon Web Services.
\n network-interface.status
- The status of the network interface\n (available
) | in-use
).
\n network-interface.source-dest-check
- Whether the network\n interface performs source/destination checking. A value of true
\n means that checking is enabled, and false
means that checking is\n disabled. The value must be false
for the network interface to\n perform network address translation (NAT) in your VPC.
\n network-interface.subnet-id
- The ID of the subnet for the\n network interface.
\n network-interface.tag-key
- The key of a tag assigned to the network interface.
\n network-interface.tag-value
- The value of a tag assigned to the network interface.
\n network-interface.vpc-id
- The ID of the VPC for the network\n interface.
\n outpost-arn
- The Amazon Resource Name (ARN) of the\n Outpost.
\n owner-id
- The Amazon Web Services account ID of the instance\n owner.
\n placement-group-name
- The name of the placement group for the\n instance.
\n placement-partition-number
- The partition in which the instance is\n located.
\n platform
- The platform. To list only Windows instances, use\n windows
.
\n platform-details
- The platform (Linux/UNIX
|\n Red Hat BYOL Linux
| Red Hat Enterprise Linux
|\n Red Hat Enterprise Linux with HA
| Red Hat Enterprise\n Linux with SQL Server Standard and HA
| Red Hat Enterprise\n Linux with SQL Server Enterprise and HA
| Red Hat Enterprise\n Linux with SQL Server Standard
| Red Hat Enterprise Linux with\n SQL Server Web
| Red Hat Enterprise Linux with SQL Server\n Enterprise
| SQL Server Enterprise
| SQL Server\n Standard
| SQL Server Web
| SUSE Linux
|\n Ubuntu Pro
| Windows
| Windows BYOL
|\n Windows with SQL Server Enterprise
| Windows with SQL\n Server Standard
| Windows with SQL Server Web
).
\n private-dns-name
- The private IPv4 DNS name of the\n instance.
\n private-dns-name-options.enable-resource-name-dns-a-record
- A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.
\n private-dns-name-options.enable-resource-name-dns-aaaa-record
- A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.
\n private-dns-name-options.hostname-type
- The type of hostname\n (ip-name
| resource-name
).
\n private-ip-address
- The private IPv4 address of the instance.\n This can only be used to filter by the primary IP address of the network\n interface attached to the instance. To filter by additional IP addresses\n assigned to the network interface, use the filter\n network-interface.addresses.private-ip-address
.
\n product-code
- The product code associated with the AMI used to\n launch the instance.
\n product-code.type
- The type of product code (devpay
\n | marketplace
).
\n ramdisk-id
- The RAM disk ID.
\n reason
- The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.
\n requester-id
- The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).
\n reservation-id
- The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.
\n root-device-name
- The device name of the root device volume (for\n example, /dev/sda1
).
\n root-device-type
- The type of the root device volume\n (ebs
| instance-store
).
\n source-dest-check
- Indicates whether the instance performs\n source/destination checking. A value of true
means that checking is\n enabled, and false
means that checking is disabled. The value must\n be false
for the instance to perform network address translation\n (NAT) in your VPC.
\n spot-instance-request-id
- The ID of the Spot Instance\n request.
\n state-reason-code
- The reason code for the state change.
\n state-reason-message
- A message that describes the state\n change.
\n subnet-id
- The ID of the subnet for the instance.
\n tag:
- 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.\n 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.
\n 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.
\n tenancy
- The tenancy of an instance (dedicated
|\n default
| host
).
\n tpm-support
- Indicates if the instance is configured for\n NitroTPM support (v2.0
).
\n usage-operation
- The usage operation value for the instance\n (RunInstances
| RunInstances:00g0
|\n RunInstances:0010
| RunInstances:1010
|\n RunInstances:1014
| RunInstances:1110
|\n RunInstances:0014
| RunInstances:0210
|\n RunInstances:0110
| RunInstances:0100
|\n RunInstances:0004
| RunInstances:0200
|\n RunInstances:000g
| RunInstances:0g00
|\n RunInstances:0002
| RunInstances:0800
|\n RunInstances:0102
| RunInstances:0006
|\n RunInstances:0202
).
\n usage-operation-update-time
- The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z
.
\n virtualization-type
- The virtualization type of the instance\n (paravirtual
| hvm
).
\n vpc-id
- The ID of the VPC that the instance is running in.
Describes one or more of your internet gateways.
", + "smithy.api#documentation": "Describes your internet gateways. The default is to describe all your internet gateways. \n Alternatively, you can specify specific internet gateway IDs or filter the results to\n include only the internet gateways that match specific criteria.
", "smithy.api#examples": [ { "title": "To describe the Internet gateway for a VPC", @@ -32500,7 +32500,7 @@ "target": "com.amazonaws.ec2#InternetGatewayList", "traits": { "aws.protocols#ec2QueryName": "InternetGatewaySet", - "smithy.api#documentation": "Information about one or more internet gateways.
", + "smithy.api#documentation": "Information about the internet gateways.
", "smithy.api#xmlName": "internetGatewaySet" } }, @@ -33328,7 +33328,7 @@ "ResolveAlias": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "If true
, and if a Systems Manager parameter is specified for ImageId
,\n the AMI ID is displayed in the response for imageId
.
If false
, and if a Systems Manager parameter is specified for ImageId
,\n the parameter is displayed in the response for imageId
.
For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
\nDefault: false
\n
If true
, and if a Systems Manager parameter is specified for ImageId
,\n the AMI ID is displayed in the response for imageId
.
If false
, and if a Systems Manager parameter is specified for ImageId
,\n the parameter is displayed in the response for imageId
.
For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
\nDefault: false
\n
Describes one or more of your NAT gateways.
", + "smithy.api#documentation": "Describes your NAT gateways. The default is to describe all your NAT gateways. \n Alternatively, you can specify specific NAT gateway IDs or filter the results to\n include only the NAT gateways that match specific criteria.
", "smithy.api#examples": [ { "title": "To describe a NAT gateway", @@ -34543,7 +34543,7 @@ "target": "com.amazonaws.ec2#DescribeNetworkAclsResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your network ACLs.
\nFor more information, see Network ACLs in the\n\t\t\t\tAmazon VPC User Guide.
", + "smithy.api#documentation": "Describes your network ACLs. The default is to describe all your network ACLs. \n Alternatively, you can specify specific network ACL IDs or filter the results to\n include only the network ACLs that match specific criteria.
\nFor more information, see Network ACLs in the\n\t\t\t\tAmazon VPC User Guide.
", "smithy.api#examples": [ { "title": "To describe a network ACL", @@ -34624,7 +34624,7 @@ "NetworkAclIds": { "target": "com.amazonaws.ec2#NetworkAclIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the network ACLs.
\nDefault: Describes all your network ACLs.
", + "smithy.api#documentation": "The IDs of the network ACLs.
", "smithy.api#xmlName": "NetworkAclId" } }, @@ -34652,7 +34652,7 @@ "target": "com.amazonaws.ec2#NetworkAclList", "traits": { "aws.protocols#ec2QueryName": "NetworkAclSet", - "smithy.api#documentation": "Information about one or more network ACLs.
", + "smithy.api#documentation": "Information about the network ACLs.
", "smithy.api#xmlName": "networkAclSet" } }, @@ -35789,7 +35789,7 @@ "target": "com.amazonaws.ec2#DescribeRegionsResult" }, "traits": { - "smithy.api#documentation": "Describes the Regions that are enabled for your account, or all Regions.
\nFor a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.
\nFor information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nDescribes the Regions that are enabled for your account, or all Regions.
\nFor a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints.
\nFor information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions \n your account can use in the Amazon Web Services Account Management Reference Guide.
\nThe order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.
\nDescribes a root volume replacement task. For more information, see \n Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Describes a root volume replacement task. For more information, see \n Replace a root volume in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -36023,7 +36023,7 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsResult" }, "traits": { - "smithy.api#documentation": "Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\nThe Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nAs a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
\nAs a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
\nFor more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\nThe Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
\nAs a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
\nAs a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\nFor more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\nFor more information, see Modify Reserved Instances in the\n Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
\nIf you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nDescribes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
\nIf you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
\nFor more information, see Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
\nThe order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.
\nThe instance type that the reservation will cover (for example, m1.small
). For more information, see \n Instance types in the\n Amazon EC2 User Guide.
The instance type that the reservation will cover (for example, m1.small
).\n For more information, see Amazon EC2 instance types in the\n Amazon EC2 User Guide.
Describes one or more of your route tables.
\nEach subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
\nFor more information, see Route tables in the\n\t\t\t\tAmazon VPC User Guide.
", + "smithy.api#documentation": "Describes your route tables. The default is to describe all your route tables. \n Alternatively, you can specify specific route table IDs or filter the results to\n include only the route tables that match specific criteria.
\nEach subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
\nFor more information, see Route tables in the\n\t\t\t\tAmazon VPC User Guide.
", "smithy.api#examples": [ { "title": "To describe a route table", @@ -36445,7 +36445,7 @@ "RouteTableIds": { "target": "com.amazonaws.ec2#RouteTableIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the route tables.
\nDefault: Describes all your route tables.
", + "smithy.api#documentation": "The IDs of the route tables.
", "smithy.api#xmlName": "RouteTableId" } }, @@ -36473,7 +36473,7 @@ "target": "com.amazonaws.ec2#RouteTableList", "traits": { "aws.protocols#ec2QueryName": "RouteTableSet", - "smithy.api#documentation": "Information about one or more route tables.
", + "smithy.api#documentation": "Information about the route tables.
", "smithy.api#xmlName": "routeTableSet" } }, @@ -37279,13 +37279,13 @@ "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The maximum number of snapshots to return for this request.\n This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. \n If this parameter is not used, then the request returns all snapshots. \n You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, \n see Pagination.
" + "smithy.api#documentation": "The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.
" } }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
" + "smithy.api#documentation": "The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
" } }, "OwnerIds": { @@ -37337,7 +37337,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to include in another request to return the next page of snapshots. \n This value is null
when there are no more snapshots to return.
The token to include in another request to get the next page of items. \n This value is null
when there are no more items to return.
Describes the data feed for Spot Instances. For more information, see Spot\n Instance data feed in the Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "Describes the data feed for Spot Instances. For more information, see Spot\n Instance data feed in the Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To describe the datafeed for your AWS account", @@ -37984,7 +37984,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n availability-zone-group
- The Availability Zone group.
\n create-time
- The time stamp when the Spot Instance request was\n created.
\n fault-code
- The fault code related to the request.
\n fault-message
- The fault message related to the request.
\n instance-id
- The ID of the instance that fulfilled the\n request.
\n launch-group
- The Spot Instance launch group.
\n launch.block-device-mapping.delete-on-termination
- Indicates\n whether the EBS volume is deleted on instance termination.
\n launch.block-device-mapping.device-name
- The device name for the\n volume in the block device mapping (for example, /dev/sdh
or\n xvdh
).
\n launch.block-device-mapping.snapshot-id
- The ID of the snapshot\n for the EBS volume.
\n launch.block-device-mapping.volume-size
- The size of the EBS\n volume, in GiB.
\n launch.block-device-mapping.volume-type
- The type of EBS volume:\n gp2
or gp3
for General Purpose SSD, io1
\n or io2
for Provisioned IOPS SSD, st1
for Throughput\n Optimized HDD, sc1
for Cold HDD, or standard
for\n Magnetic.
\n launch.group-id
- The ID of the security group for the\n instance.
\n launch.group-name
- The name of the security group for the\n instance.
\n launch.image-id
- The ID of the AMI.
\n launch.instance-type
- The type of instance (for example,\n m3.medium
).
\n launch.kernel-id
- The kernel ID.
\n launch.key-name
- The name of the key pair the instance launched\n with.
\n launch.monitoring-enabled
- Whether detailed monitoring is\n enabled for the Spot Instance.
\n launch.ramdisk-id
- The RAM disk ID.
\n launched-availability-zone
- The Availability Zone in which the\n request is launched.
\n network-interface.addresses.primary
- Indicates whether the IP\n address is the primary private IP address.
\n network-interface.delete-on-termination
- Indicates whether the\n network interface is deleted when the instance is terminated.
\n network-interface.description
- A description of the network\n interface.
\n network-interface.device-index
- The index of the device for the\n network interface attachment on the instance.
\n network-interface.group-id
- The ID of the security group\n associated with the network interface.
\n network-interface.network-interface-id
- The ID of the network\n interface.
\n network-interface.private-ip-address
- The primary private IP\n address of the network interface.
\n network-interface.subnet-id
- The ID of the subnet for the\n instance.
\n product-description
- The product description associated with the\n instance (Linux/UNIX
| Windows
).
\n spot-instance-request-id
- The Spot Instance request ID.
\n spot-price
- The maximum hourly price for any Spot Instance\n launched to fulfill the request.
\n state
- The state of the Spot Instance request (open
\n | active
| closed
| cancelled
|\n failed
). Spot request status information can help you track\n your Amazon EC2 Spot Instance requests. For more information, see Spot\n request status in the Amazon EC2 User Guide for Linux Instances.
\n status-code
- The short code describing the most recent\n evaluation of your Spot Instance request.
\n status-message
- The message explaining the status of the Spot\n Instance request.
\n tag:
- 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.\n 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.
\n 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.
\n type
- The type of Spot Instance request (one-time
|\n persistent
).
\n valid-from
- The start date of the request.
\n valid-until
- The end date of the request.
The filters.
\n\n availability-zone-group
- The Availability Zone group.
\n create-time
- The time stamp when the Spot Instance request was\n created.
\n fault-code
- The fault code related to the request.
\n fault-message
- The fault message related to the request.
\n instance-id
- The ID of the instance that fulfilled the\n request.
\n launch-group
- The Spot Instance launch group.
\n launch.block-device-mapping.delete-on-termination
- Indicates\n whether the EBS volume is deleted on instance termination.
\n launch.block-device-mapping.device-name
- The device name for the\n volume in the block device mapping (for example, /dev/sdh
or\n xvdh
).
\n launch.block-device-mapping.snapshot-id
- The ID of the snapshot\n for the EBS volume.
\n launch.block-device-mapping.volume-size
- The size of the EBS\n volume, in GiB.
\n launch.block-device-mapping.volume-type
- The type of EBS volume:\n gp2
or gp3
for General Purpose SSD, io1
\n or io2
for Provisioned IOPS SSD, st1
for Throughput\n Optimized HDD, sc1
for Cold HDD, or standard
for\n Magnetic.
\n launch.group-id
- The ID of the security group for the\n instance.
\n launch.group-name
- The name of the security group for the\n instance.
\n launch.image-id
- The ID of the AMI.
\n launch.instance-type
- The type of instance (for example,\n m3.medium
).
\n launch.kernel-id
- The kernel ID.
\n launch.key-name
- The name of the key pair the instance launched\n with.
\n launch.monitoring-enabled
- Whether detailed monitoring is\n enabled for the Spot Instance.
\n launch.ramdisk-id
- The RAM disk ID.
\n launched-availability-zone
- The Availability Zone in which the\n request is launched.
\n network-interface.addresses.primary
- Indicates whether the IP\n address is the primary private IP address.
\n network-interface.delete-on-termination
- Indicates whether the\n network interface is deleted when the instance is terminated.
\n network-interface.description
- A description of the network\n interface.
\n network-interface.device-index
- The index of the device for the\n network interface attachment on the instance.
\n network-interface.group-id
- The ID of the security group\n associated with the network interface.
\n network-interface.network-interface-id
- The ID of the network\n interface.
\n network-interface.private-ip-address
- The primary private IP\n address of the network interface.
\n network-interface.subnet-id
- The ID of the subnet for the\n instance.
\n product-description
- The product description associated with the\n instance (Linux/UNIX
| Windows
).
\n spot-instance-request-id
- The Spot Instance request ID.
\n spot-price
- The maximum hourly price for any Spot Instance\n launched to fulfill the request.
\n state
- The state of the Spot Instance request (open
\n | active
| closed
| cancelled
|\n failed
). Spot request status information can help you track\n your Amazon EC2 Spot Instance requests. For more information, see Spot\n request status in the Amazon EC2 User Guide.
\n status-code
- The short code describing the most recent\n evaluation of your Spot Instance request.
\n status-message
- The message explaining the status of the Spot\n Instance request.
\n tag:
- 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.\n 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.
\n 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.
\n type
- The type of Spot Instance request (one-time
|\n persistent
).
\n valid-from
- The start date of the request.
\n valid-until
- The end date of the request.
Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide for Linux Instances.
\nWhen you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.
", + "smithy.api#documentation": "Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide.
\nWhen you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.
", "smithy.api#examples": [ { "title": "To describe Spot price history for Linux/UNIX (Amazon VPC)", @@ -38428,7 +38428,7 @@ "target": "com.amazonaws.ec2#DescribeSubnetsResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your subnets.
\nFor more information, see Subnets in the\n\t\t\t\tAmazon VPC User Guide.
", + "smithy.api#documentation": "Describes your subnets. The default is to describe all your subnets. \n Alternatively, you can specify specific subnet IDs or filter the results to\n include only the subnets that match specific criteria.
\nFor more information, see Subnets in the\n\t\t\t\tAmazon VPC User Guide.
", "smithy.api#examples": [ { "title": "To describe the subnets for a VPC", @@ -38540,7 +38540,7 @@ "target": "com.amazonaws.ec2#SubnetList", "traits": { "aws.protocols#ec2QueryName": "SubnetSet", - "smithy.api#documentation": "Information about one or more subnets.
", + "smithy.api#documentation": "Information about the subnets.
", "smithy.api#xmlName": "subnetSet" } }, @@ -40540,13 +40540,13 @@ "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. This value can be between 5 and 1,000;\n if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, \n then all items are returned. You cannot specify this parameter and the volume IDs parameter in the \n same request. For more information, see Pagination.
" + "smithy.api#documentation": "The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.
" } }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
" + "smithy.api#documentation": "The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
" } }, "VolumeIds": { @@ -40576,7 +40576,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to include in another request to get the next page of items. \n This value is null
when there are no more items to return.
The token to include in another request to get the next page of items. \n This value is null
when there are no more items to return.
Describes the most recent volume modification request for the specified EBS volumes.
\nIf a volume has never been modified, some information in the output will be null.\n If a volume has been modified more than once, the output includes only the most \n recent modification request.
\nYou can also use CloudWatch Events to check the status of a modification to an EBS\n volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see\n Monitor the progress of volume modifications in the Amazon EBS User Guide.
", + "smithy.api#documentation": "Describes the most recent volume modification request for the specified EBS volumes.
\nIf a volume has never been modified, some information in the output will be null.\n If a volume has been modified more than once, the output includes only the most \n recent modification request.
\nFor more information, see \n Monitor the progress of volume modifications in the Amazon EBS User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -40798,7 +40798,7 @@ "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The token returned by a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
" + "smithy.api#documentation": "The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
" } }, "MaxResults": { @@ -40827,7 +40827,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to include in another request to get the next page of items. \n This value is null
if there are no more items to return.
The token to include in another request to get the next page of items. \n This value is null
when there are no more items to return.
The maximum number of volumes to return for this request. \n This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. \n If this parameter is not used, then all items are returned. You cannot specify this parameter and the\n volume IDs parameter in the same request. For more information, see Pagination.
", + "smithy.api#documentation": "The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.
", "smithy.api#xmlName": "maxResults" } }, @@ -40873,7 +40873,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token returned from a previous paginated request. \n Pagination continues from the end of the items returned from the previous request.
", + "smithy.api#documentation": "The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
", "smithy.api#xmlName": "nextToken" } } @@ -40897,7 +40897,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to include in another request to get the next page of items. \n This value is null
when there are no more items to return.
The token to include in another request to get the next page of items. \n This value is null
when there are no more items to return.
Describes your VPC endpoints.
", + "smithy.api#documentation": "Describes your VPC endpoints. The default is to describe all your VPC endpoints. \n Alternatively, you can specify specific VPC endpoint IDs or filter the results to\n include only the VPC endpoints that match specific criteria.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -41639,7 +41639,7 @@ "target": "com.amazonaws.ec2#VpcEndpointSet", "traits": { "aws.protocols#ec2QueryName": "VpcEndpointSet", - "smithy.api#documentation": "Information about the endpoints.
", + "smithy.api#documentation": "Information about the VPC endpoints.
", "smithy.api#xmlName": "vpcEndpointSet" } }, @@ -41665,7 +41665,7 @@ "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your VPC peering connections.
", + "smithy.api#documentation": "Describes your VPC peering connections. The default is to describe all your VPC peering connections. \n Alternatively, you can specify specific VPC peering connection IDs or filter the results to\n include only the VPC peering connections that match specific criteria.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -41799,7 +41799,7 @@ "target": "com.amazonaws.ec2#DescribeVpcsResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your VPCs.
", + "smithy.api#documentation": "Describes your VPCs. The default is to describe all your VPCs. \n Alternatively, you can specify specific VPC IDs or filter the results to\n include only the VPCs that match specific criteria.
", "smithy.api#examples": [ { "title": "To describe a VPC", @@ -41892,7 +41892,7 @@ "VpcIds": { "target": "com.amazonaws.ec2#VpcIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the VPCs.
\nDefault: Describes all your VPCs.
", + "smithy.api#documentation": "The IDs of the VPCs.
", "smithy.api#xmlName": "VpcId" } }, @@ -41928,7 +41928,7 @@ "target": "com.amazonaws.ec2#VpcList", "traits": { "aws.protocols#ec2QueryName": "VpcSet", - "smithy.api#documentation": "Information about one or more VPCs.
", + "smithy.api#documentation": "Information about the VPCs.
", "smithy.api#xmlName": "vpcSet" } }, @@ -42414,7 +42414,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -42774,7 +42774,7 @@ "target": "com.amazonaws.ec2#DisableAddressTransferResult" }, "traits": { - "smithy.api#documentation": "Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
" } }, "com.amazonaws.ec2#DisableAddressTransferRequest": { @@ -44629,7 +44629,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -44659,7 +44659,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
", "smithy.api#xmlName": "clientToken" } } @@ -45276,7 +45276,7 @@ "target": "com.amazonaws.ec2#EbsOptimizedSupport", "traits": { "aws.protocols#ec2QueryName": "EbsOptimizedSupport", - "smithy.api#documentation": "Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized\n instances in Amazon EC2 User Guide.
", + "smithy.api#documentation": "Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized\n instances in Amazon EC2 User Guide.
", "smithy.api#xmlName": "ebsOptimizedSupport" } }, @@ -45435,7 +45435,7 @@ "target": "com.amazonaws.ec2#BaselineIops", "traits": { "aws.protocols#ec2QueryName": "BaselineIops", - "smithy.api#documentation": "The baseline input/output storage operations per seconds for an EBS-optimized instance type.
", + "smithy.api#documentation": "The baseline input/output storage operations per seconds for an EBS-optimized instance\n type.
", "smithy.api#xmlName": "baselineIops" } }, @@ -45459,7 +45459,7 @@ "target": "com.amazonaws.ec2#MaximumIops", "traits": { "aws.protocols#ec2QueryName": "MaximumIops", - "smithy.api#documentation": "The maximum input/output storage operations per second for an EBS-optimized instance type.
", + "smithy.api#documentation": "The maximum input/output storage operations per second for an EBS-optimized instance\n type.
", "smithy.api#xmlName": "maximumIops" } } @@ -45821,7 +45821,7 @@ } }, "traits": { - "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.
\nDescribes the association between an instance and an Elastic Graphics accelerator.
" + "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.
\nDescribes the association between an instance and an Elastic Graphics accelerator.
" } }, "com.amazonaws.ec2#ElasticGpuAssociationList": { @@ -45846,7 +45846,7 @@ } }, "traits": { - "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.
\nDescribes the status of an Elastic Graphics accelerator.
" + "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.
\nDescribes the status of an Elastic Graphics accelerator.
" } }, "com.amazonaws.ec2#ElasticGpuId": { @@ -45877,13 +45877,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of Elastic Graphics accelerator. For more information about the values to specify for\n Type
, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the \n Amazon Elastic Compute Cloud User Guide for Windows Instances.
The type of Elastic Graphics accelerator.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.
\nA specification for an Elastic Graphics accelerator.
" + "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.
\nA specification for an Elastic Graphics accelerator.
" } }, "com.amazonaws.ec2#ElasticGpuSpecificationList": { @@ -46018,7 +46018,7 @@ } }, "traits": { - "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.
\nDescribes an Elastic Graphics accelerator.
" + "smithy.api#documentation": "Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.
\nDescribes an Elastic Graphics accelerator.
" } }, "com.amazonaws.ec2#ElasticInferenceAccelerator": { @@ -46215,7 +46215,7 @@ "target": "com.amazonaws.ec2#EnableAddressTransferResult" }, "traits": { - "smithy.api#documentation": "Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
" } }, "com.amazonaws.ec2#EnableAddressTransferRequest": { @@ -48746,7 +48746,7 @@ "target": "com.amazonaws.ec2#ExportTransitGatewayRoutesResult" }, "traits": { - "smithy.api#documentation": "Exports routes from the specified transit gateway route table to the specified S3 bucket.\n By default, all routes are exported. Alternatively, you can filter by CIDR range.
\nThe routes are saved to the specified bucket in a JSON file. For more information, see\n Export Route Tables\n to Amazon S3 in Transit Gateways.
" + "smithy.api#documentation": "Exports routes from the specified transit gateway route table to the specified S3 bucket.\n By default, all routes are exported. Alternatively, you can filter by CIDR range.
\nThe routes are saved to the specified bucket in a JSON file. For more information, see\n Export route tables\n to Amazon S3 in the Amazon Web Services Transit Gateways Guide.
" } }, "com.amazonaws.ec2#ExportTransitGatewayRoutesRequest": { @@ -49406,7 +49406,7 @@ "target": "com.amazonaws.ec2#Double", "traits": { "aws.protocols#ec2QueryName": "FulfilledCapacity", - "smithy.api#documentation": "The number of capacity units fulfilled by the Capacity Reservation. For more information, see \n\t\t\t\n\t\t\t\tTotal target capacity in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The number of capacity units fulfilled by the Capacity Reservation. For more information,\n\t\t\tsee Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "fulfilledCapacity" } }, @@ -49430,7 +49430,7 @@ "target": "com.amazonaws.ec2#DoubleWithConstraints", "traits": { "aws.protocols#ec2QueryName": "Weight", - "smithy.api#documentation": "The weight of the instance type in the Capacity Reservation Fleet. For more information, \n\t\t\tsee \n\t\t\t\tInstance type weight in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The weight of the instance type in the Capacity Reservation Fleet. For more information, see\n\t\t\t\tInstance type\n\t\t\t\tweight in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "weight" } }, @@ -49438,7 +49438,7 @@ "target": "com.amazonaws.ec2#IntegerWithConstraints", "traits": { "aws.protocols#ec2QueryName": "Priority", - "smithy.api#documentation": "The priority of the instance type in the Capacity Reservation Fleet. For more information, \n\t\t\tsee \n\t\t\t\tInstance type priority in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The priority of the instance type in the Capacity Reservation Fleet. For more information,\n\t\t\tsee Instance type\n\t\t\t\tpriority in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "priority" } } @@ -50309,7 +50309,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "MaxAggregationInterval", - "smithy.api#documentation": "The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.
\nValid Values: 60
| 600
\n
The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.
\nValid Values: 60
| 600
\n
Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
\nIf you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
\nGet a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
\nIf you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
\nRetrieves the encrypted administrator password for a running Windows instance.
\nThe Windows password is generated at boot by the EC2Config
service or\n EC2Launch
scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.
For the EC2Config
service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword
is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.
\nWhen you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.
", + "smithy.api#documentation": "Retrieves the encrypted administrator password for a running Windows instance.
\nThe Windows password is generated at boot by the EC2Config
service or\n EC2Launch
scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.
For the EC2Config
service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword
is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.
\nWhen you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.
", "smithy.waiters#waitable": { "PasswordDataAvailable": { "acceptors": [ @@ -53596,7 +53596,7 @@ "target": "com.amazonaws.ec2#GetSpotPlacementScoresResult" }, "traits": { - "smithy.api#documentation": "Calculates the Spot placement score for a Region or Availability Zone based on the\n specified target capacity and compute requirements.
\nYou can specify your compute requirements either by using\n InstanceRequirementsWithMetadata
and letting Amazon EC2 choose the optimal\n instance types to fulfill your Spot request, or you can specify the instance types by using\n InstanceTypes
.
For more information, see Spot placement score in\n the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Calculates the Spot placement score for a Region or Availability Zone based on the\n specified target capacity and compute requirements.
\nYou can specify your compute requirements either by using\n InstanceRequirementsWithMetadata
and letting Amazon EC2 choose the optimal\n instance types to fulfill your Spot request, or you can specify the instance types by using\n InstanceTypes
.
For more information, see Spot placement score in\n the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -54888,7 +54888,7 @@ } }, "traits": { - "smithy.api#documentation": "Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#HibernationOptionsRequest": { @@ -54902,7 +54902,7 @@ } }, "traits": { - "smithy.api#documentation": "Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Indicates whether your instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#HistoryRecord": { @@ -57804,7 +57804,7 @@ "target": "com.amazonaws.ec2#totalInferenceMemory", "traits": { "aws.protocols#ec2QueryName": "TotalInferenceMemoryInMiB", - "smithy.api#documentation": "The total size of the memory for the inference accelerators for the instance type, in MiB.
", + "smithy.api#documentation": "The total size of the memory for the inference accelerators for the instance type, in\n MiB.
", "smithy.api#xmlName": "totalInferenceMemoryInMiB" } } @@ -59999,7 +59999,7 @@ "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationResponse", "traits": { "aws.protocols#ec2QueryName": "ConnectionTrackingConfiguration", - "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "connectionTrackingConfiguration" } } @@ -60286,7 +60286,7 @@ "ConnectionTrackingSpecification": { "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", "traits": { - "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" } } }, @@ -66099,7 +66099,7 @@ "target": "com.amazonaws.ec2#InstanceType", "traits": { "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The instance type. For more information, see Instance types in the Amazon EC2\n User Guide.
", "smithy.api#xmlName": "instanceType" } }, @@ -66259,7 +66259,7 @@ "target": "com.amazonaws.ec2#BurstablePerformanceFlag", "traits": { "aws.protocols#ec2QueryName": "BurstablePerformanceSupported", - "smithy.api#documentation": "Indicates whether the instance type is a burstable performance T instance \n type. For more information, see Burstable \n performance instances.
", + "smithy.api#documentation": "Indicates whether the instance type is a burstable performance T instance type. For more\n information, see Burstable performance\n instances.
", "smithy.api#xmlName": "burstablePerformanceSupported" } }, @@ -66283,7 +66283,7 @@ "target": "com.amazonaws.ec2#BootModeTypeList", "traits": { "aws.protocols#ec2QueryName": "SupportedBootModes", - "smithy.api#documentation": "The supported boot modes. For more information, see Boot modes in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "The supported boot modes. For more information, see Boot modes in the Amazon EC2 User\n Guide.
", "smithy.api#xmlName": "supportedBootModes" } }, @@ -66387,7 +66387,7 @@ "target": "com.amazonaws.ec2#InstanceType", "traits": { "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The instance type. For more information, see Instance types in the Amazon EC2\n User Guide.
", "smithy.api#xmlName": "instanceType" } }, @@ -66403,7 +66403,7 @@ "target": "com.amazonaws.ec2#Location", "traits": { "aws.protocols#ec2QueryName": "Location", - "smithy.api#documentation": "The identifier for the location. This depends on the location type. For example, if the location type is\n region
, the location is the Region code (for example, us-east-2
.)
The identifier for the location. This depends on the location type. For example, if the\n location type is region
, the location is the Region code (for example,\n us-east-2
.)
The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP
. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP
. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. \n By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
The IPv4 prefix. For information, see \n Assigning prefixes to Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "The IPv4 prefix. For information, see \n Assigning prefixes to network interfaces in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "ipv4Prefix" } } @@ -69391,7 +69391,7 @@ "Ipv4Prefix": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The IPv4 prefix. For information, see \n Assigning prefixes to Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The IPv4 prefix. For information, see \n Assigning prefixes to network interfaces in the\n Amazon EC2 User Guide.
" } } }, @@ -70995,7 +70995,7 @@ } }, "traits": { - "smithy.api#documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest": { @@ -71033,7 +71033,7 @@ } }, "traits": { - "smithy.api#documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState": { @@ -71262,7 +71262,7 @@ "target": "com.amazonaws.ec2#ConnectionTrackingSpecification", "traits": { "aws.protocols#ec2QueryName": "ConnectionTrackingSpecification", - "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Idle connection tracking timeout in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "connectionTrackingSpecification" } } @@ -71323,7 +71323,7 @@ "InterfaceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa
. For more information, see Elastic Fabric Adapter in the\n Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA, specify interface
or omit this\n parameter.
Valid values: interface
| efa
\n
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa
. For more information, see Elastic Fabric Adapter in the\n Amazon EC2 User Guide.
If you are not creating an EFA, specify interface
or omit this\n parameter.
Valid values: interface
| efa
\n
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "A security group connection tracking specification that enables you to set the timeout\n for connection tracking on an Elastic network interface. For more information, see\n Idle connection tracking timeout in the\n Amazon EC2 User Guide.
" } } }, @@ -73772,7 +73772,7 @@ "target": "com.amazonaws.ec2#TotalMediaMemory", "traits": { "aws.protocols#ec2QueryName": "TotalMediaMemoryInMiB", - "smithy.api#documentation": "The total size of the memory for the media accelerators for the instance type, in MiB.
", + "smithy.api#documentation": "The total size of the memory for the media accelerators for the instance type, in\n MiB.
", "smithy.api#xmlName": "totalMediaMemoryInMiB" } } @@ -74134,7 +74134,7 @@ "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroupResult" }, "traits": { - "smithy.api#documentation": "Changes the opt-in status of the Local Zone and Wavelength Zone group for your\n account.
\nUse \n \t\tDescribeAvailabilityZones to view the value for GroupName
.
Changes the opt-in status of the specified zone group for your account.
" } }, "com.amazonaws.ec2#ModifyAvailabilityZoneGroupRequest": { @@ -74152,7 +74152,7 @@ "target": "com.amazonaws.ec2#ModifyAvailabilityZoneOptInStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The\n only valid value is opted-in
. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.
Indicates whether to opt in to the zone group. The only valid value is opted-in
. \n You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.
The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, \n\t\t\ttogether with the instance type weights that you assign to each instance type used by the Fleet \n\t\t\tdetermine the number of instances for which the Fleet reserves capacity. Both values are based on \n\t\t\tunits that make sense for your workload. For more information, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The total number of capacity units to be reserved by the Capacity Reservation Fleet. This\n\t\t\tvalue, together with the instance type weights that you assign to each instance type\n\t\t\tused by the Fleet determine the number of instances for which the Fleet reserves\n\t\t\tcapacity. Both values are based on units that make sense for your workload. For more\n\t\t\tinformation, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.
" } }, "EndDate": { @@ -74548,7 +74548,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is\n specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.
\nAmazon EBS does not support asymmetric KMS keys.
", + "smithy.api#documentation": "The identifier of the KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId
is\n specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
\nKey ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
\nKey alias. For example, alias/ExampleAlias.
\nKey ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
\nAlias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
\nAmazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.
\nAmazon EBS does not support asymmetric KMS keys.
", "smithy.api#required": {} } }, @@ -74791,7 +74791,7 @@ "HostRecovery": { "target": "com.amazonaws.ec2#HostRecovery", "traits": { - "smithy.api#documentation": "Indicates whether to enable or disable host recovery for the Dedicated Host. For more\n information, see Host recovery\n in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Indicates whether to enable or disable host recovery for the Dedicated Host. For more\n information, see Host recovery in\n the Amazon EC2 User Guide.
" } }, "InstanceType": { @@ -74809,7 +74809,7 @@ "HostMaintenance": { "target": "com.amazonaws.ec2#HostMaintenance", "traits": { - "smithy.api#documentation": "Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.
" } } }, @@ -75236,7 +75236,7 @@ "DisableApiStop": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n Protection.
\n " + "smithy.api#documentation": "Indicates whether an instance is enabled for stop protection. For more information,\n see Enable stop\n protection for your instance.
\n " } } }, @@ -76659,7 +76659,7 @@ "target": "com.amazonaws.ec2#ModifyReservedInstancesResult" }, "traits": { - "smithy.api#documentation": "Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.
\nFor more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.
\nFor more information, see Modify Reserved Instances in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#ModifyReservedInstancesRequest": { @@ -77798,7 +77798,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -77889,7 +77889,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -77979,7 +77979,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -78058,7 +78058,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -78141,7 +78141,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -78192,7 +78192,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -78331,7 +78331,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -78371,7 +78371,7 @@ "target": "com.amazonaws.ec2#ModifyVolumeResult" }, "traits": { - "smithy.api#documentation": "You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes \n in the Amazon EBS User Guide.
\nWhen you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend the file system.
\nYou can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitor the progress of volume modifications.
\nWith previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.
\nAfter modifying a volume, you must wait at least six hours and ensure that the volume \n is in the in-use
or available
state before you can modify the same \n volume. This is sometimes referred to as a cooldown period.
You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes \n in the Amazon EBS User Guide.
\nWhen you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend the file system.
\nFor more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
\nWith previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.
\nAfter modifying a volume, you must wait at least six hours and ensure that the volume \n is in the in-use
or available
state before you can modify the same \n volume. This is sometimes referred to as a cooldown period.
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:
\n\n gp3
: 3,000 - 16,000 IOPS
\n io1
: 100 - 64,000 IOPS
\n io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
Default: The existing value is retained if you keep the same volume type. If you change\n the volume type to io1
, io2
, or gp3
, the default is 3,000.
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:
\n\n gp3
: 3,000 - 16,000 IOPS
\n io1
: 100 - 64,000 IOPS
\n io2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
Default: The existing value is retained if you keep the same volume type. If you change\n the volume type to io1
, io2
, or gp3
, the default is 3,000.
Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n\t\tvolume to up to 16 \n\t\t\tNitro-based instances in the same Availability Zone. This parameter is \n\t\tsupported with io1
and io2
volumes only. For more information, see \n\t \n\t\t\tAmazon EBS Multi-Attach in the Amazon EBS User Guide.
Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n\t volume to up to 16 \n\t\t\tNitro-based instances in the same Availability Zone. This parameter is \n\t\tsupported with io1
and io2
volumes only. For more information, see \n\t \n\t\t\tAmazon EBS Multi-Attach in the Amazon EBS User Guide.
Reserved. If you need to sustain traffic greater than the documented limits, contact us through \n the Support Center.
", + "smithy.api#documentation": "Reserved. If you need to sustain traffic greater than the documented limits, \n contact Amazon Web Services Support.
", "smithy.api#xmlName": "provisionedBandwidth" } }, @@ -80130,7 +80130,7 @@ "target": "com.amazonaws.ec2#NetworkAclAssociationList", "traits": { "aws.protocols#ec2QueryName": "AssociationSet", - "smithy.api#documentation": "Any associations between the network ACL and one or more subnets
", + "smithy.api#documentation": "Any associations between the network ACL and your subnets
", "smithy.api#xmlName": "associationSet" } }, @@ -80532,7 +80532,7 @@ "target": "com.amazonaws.ec2#EncryptionInTransitSupported", "traits": { "aws.protocols#ec2QueryName": "EncryptionInTransitSupported", - "smithy.api#documentation": "Indicates whether the instance type automatically encrypts in-transit traffic between instances.
", + "smithy.api#documentation": "Indicates whether the instance type automatically encrypts in-transit traffic between\n instances.
", "smithy.api#xmlName": "encryptionInTransitSupported" } }, @@ -80540,7 +80540,7 @@ "target": "com.amazonaws.ec2#EnaSrdSupported", "traits": { "aws.protocols#ec2QueryName": "EnaSrdSupported", - "smithy.api#documentation": "Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable \n Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and \n minimize tail latency of network traffic between EC2 instances.
", + "smithy.api#documentation": "Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream\n and minimize tail latency of network traffic between EC2 instances.
", "smithy.api#xmlName": "enaSrdSupported" } } @@ -81108,7 +81108,7 @@ "target": "com.amazonaws.ec2#ConnectionTrackingConfiguration", "traits": { "aws.protocols#ec2QueryName": "ConnectionTrackingConfiguration", - "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "connectionTrackingConfiguration" } }, @@ -81610,7 +81610,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "IsPrimaryIpv6", - "smithy.api#documentation": "Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
", + "smithy.api#documentation": "Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. \n For more information, see ModifyNetworkInterfaceAttribute.
", "smithy.api#xmlName": "isPrimaryIpv6" } } @@ -82086,7 +82086,7 @@ "target": "com.amazonaws.ec2#TotalNeuronMemory", "traits": { "aws.protocols#ec2QueryName": "TotalNeuronDeviceMemoryInMiB", - "smithy.api#documentation": "The total size of the memory for the neuron accelerators for the instance type, in MiB.
", + "smithy.api#documentation": "The total size of the memory for the neuron accelerators for the instance type, in\n MiB.
", "smithy.api#xmlName": "totalNeuronDeviceMemoryInMiB" } } @@ -82391,7 +82391,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "MinTargetCapacity", - "smithy.api#documentation": "The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
\nSupported only for fleets of type instant
.
At least one of the following must be specified: SingleAvailabilityZone
|\n SingleInstanceType
\n
The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't\n reached, no instances are launched.
\nConstraints: Maximum value of 1000
. Supported only for fleets of type\n instant
.
At least one of the following must be specified: SingleAvailabilityZone
|\n SingleInstanceType
\n
The maximum amount per hour for On-Demand Instances that you're willing to pay.
\nIf your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The maxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for maxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for On-Demand Instances that you're willing to pay.
\nIf your fleet includes T instances that are configured as unlimited
, and\n if their average CPU usage exceeds the baseline utilization, you will incur a charge for\n surplus credits. The maxTotalPrice
does not account for surplus credits,\n and, if you use surplus credits, your final cost might be higher than what you specified\n for maxTotalPrice
. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
\nSupported only for fleets of type instant
.
At least one of the following must be specified: SingleAvailabilityZone
|\n SingleInstanceType
\n
The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't\n reached, no instances are launched.
\nConstraints: Maximum value of 1000
. Supported only for fleets of type\n instant
.
At least one of the following must be specified: SingleAvailabilityZone
|\n SingleInstanceType
\n
The maximum amount per hour for On-Demand Instances that you're willing to pay.
\nIf your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The MaxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for MaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for On-Demand Instances that you're willing to pay.
\nIf your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The MaxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for MaxTotalPrice
. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
Indicates whether the instance type supports AMD SEV-SNP. If the request returns \n amd-sev-snp
, AMD SEV-SNP is supported. Otherwise, it is not supported. \n For more information, see \n AMD SEV-SNP.
Indicates whether the instance type supports AMD SEV-SNP. If the request returns\n amd-sev-snp
, AMD SEV-SNP is supported. Otherwise, it is not supported. For more\n information, see AMD\n SEV-SNP.
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised using AdvertiseByoipCidr.
\nAmazon Web Services verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
\nProvisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision
\n to provisioned
. To monitor the status of an address range, use DescribeByoipCidrs. \n To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress \n with either the specific address from the address pool or the ID of the address pool.
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised using AdvertiseByoipCidr.
\nAmazon Web Services verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
\nProvisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision
\n to provisioned
. To monitor the status of an address range, use DescribeByoipCidrs. \n To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress \n with either the specific address from the address pool or the ID of the address pool.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -85055,7 +85055,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ProvisionTime", - "smithy.api#documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", + "smithy.api#documentation": "Reserved.
", "smithy.api#xmlName": "provisionTime" } }, @@ -85063,7 +85063,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Provisioned", - "smithy.api#documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", + "smithy.api#documentation": "Reserved.
", "smithy.api#xmlName": "provisioned" } }, @@ -85071,7 +85071,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "RequestTime", - "smithy.api#documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", + "smithy.api#documentation": "Reserved.
", "smithy.api#xmlName": "requestTime" } }, @@ -85079,7 +85079,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Requested", - "smithy.api#documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", + "smithy.api#documentation": "Reserved.
", "smithy.api#xmlName": "requested" } }, @@ -85087,13 +85087,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", + "smithy.api#documentation": "Reserved.
", "smithy.api#xmlName": "status" } } }, "traits": { - "smithy.api#documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
" + "smithy.api#documentation": "Reserved. If you need to sustain traffic greater than the documented limits, \n contact Amazon Web Services Support.
" } }, "com.amazonaws.ec2#PtrUpdateStatus": { @@ -85564,7 +85564,7 @@ "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult" }, "traits": { - "smithy.api#documentation": "Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.
\nUse DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.
\nTo queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.
\nFor more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.
\nUse DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.
\nTo queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.
\nFor more information, see Reserved\n Instances and Sell in the Reserved Instance\n Marketplace in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest": { @@ -85621,7 +85621,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted\n pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing\n pricing tiers in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted\n pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing\n pricing tiers in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "reservedInstancesId" } } @@ -86202,7 +86202,7 @@ "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult" }, "traits": { - "smithy.api#documentation": "Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For information about\n supported instances, see Multicast\n Consideration in Amazon VPC Transit Gateways.
\nAfter you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.
" + "smithy.api#documentation": "Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For more information, see\n Multicast\n on transit gateways in the Amazon Web Services Transit Gateways Guide.
\nAfter you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.
" } }, "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest": { @@ -86266,7 +86266,7 @@ "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult" }, "traits": { - "smithy.api#documentation": "Registers sources (network interfaces) with the specified transit gateway multicast group.
\nA multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For information about supported instances, see Multicast\n Considerations in Amazon VPC Transit Gateways.
\nAfter you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.
" + "smithy.api#documentation": "Registers sources (network interfaces) with the specified transit gateway multicast group.
\nA multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For more information about supported instances, see Multicast\n on transit gateways in the Amazon Web Services Transit Gateways Guide.
\nAfter you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.
" } }, "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest": { @@ -86712,7 +86712,7 @@ "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult" }, "traits": { - "smithy.api#documentation": "Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.\n
\nAll EC2 API actions follow an eventual consistency model.
\nRelease an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.\n
\nAll EC2 API actions follow an eventual consistency model.
\nThe ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide.
\nThe ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which\n will resolve to an AMI ID on launch.
\nValid formats:
\n\n ami-17characters00000
\n
\n resolve:ssm:parameter-name
\n
\n resolve:ssm:parameter-name:version-number
\n
\n resolve:ssm:parameter-name:label
\n
\n resolve:ssm:public-parameter
\n
Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. \n If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.
\nFor more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which\n will resolve to an AMI ID on launch.
\nValid formats:
\n\n ami-17characters00000
\n
\n resolve:ssm:parameter-name
\n
\n resolve:ssm:parameter-name:version-number
\n
\n resolve:ssm:parameter-name:label
\n
\n resolve:ssm:public-parameter
\n
Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. \n If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.
\nFor more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
" } }, "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you specify InstanceType
, you can't specify\n InstanceRequirements
.
The instance type. For more information, see Amazon EC2 instance types in\n the Amazon EC2 User Guide.
\nIf you specify InstanceType
, you can't specify\n InstanceRequirements
.
The ID of the RAM disk.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the RAM disk.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide.
\nThe user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Linux instance at\n launch (Linux) or Work with instance\n user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
\nIf you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
" + "smithy.api#documentation": "The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at\n launch in the Amazon EC2 User Guide.
\nIf you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
" } }, "TagSpecifications": { @@ -87988,7 +87988,7 @@ "CpuOptions": { "target": "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest", "traits": { - "smithy.api#documentation": "The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User\n Guide.
" + "smithy.api#documentation": "The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
" } }, "CapacityReservationSpecification": { @@ -88007,19 +88007,19 @@ "HibernationOptions": { "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest", "traits": { - "smithy.api#documentation": "Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2 instance\n in the Amazon EC2 User Guide.
" } }, "MetadataOptions": { "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest", "traits": { - "smithy.api#documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.
" } }, "EnclaveOptions": { "target": "com.amazonaws.ec2#LaunchTemplateEnclaveOptionsRequest", "traits": { - "smithy.api#documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.
\nYou can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
" + "smithy.api#documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.
\nYou can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
" } }, "InstanceRequirements": { @@ -88043,7 +88043,7 @@ "DisableApiStop": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether to enable the instance for stop protection. For more information,\n see Stop\n protection in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Indicates whether to enable the instance for stop protection. For more information,\n see Enable stop protection for your instance in the\n Amazon EC2 User Guide.
" } } }, @@ -88244,7 +88244,7 @@ "target": "com.amazonaws.ec2#RequestSpotInstancesResult" }, "traits": { - "smithy.api#documentation": "Creates a Spot Instance request.
\nFor more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.
\nWe strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.
\nCreates a Spot Instance request.
\nFor more information, see Work with Spot Instance in\n the Amazon EC2 User Guide.
\nWe strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.
\nUnique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency in the Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency in\n Amazon EC2 API requests in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "clientToken" } }, @@ -88630,7 +88630,7 @@ "Weight": { "target": "com.amazonaws.ec2#DoubleWithConstraints", "traits": { - "smithy.api#documentation": "The number of capacity units provided by the specified instance type. This value, together with the \n\t\t\ttotal target capacity that you specify for the Fleet determine the number of instances for which the \n\t\t\tFleet reserves capacity. Both values are based on units that make sense for your workload. For more \n\t\t\tinformation, see Total target capacity \n\t\t\tin the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The number of capacity units provided by the specified instance type. This value, together\n\t\t\twith the total target capacity that you specify for the Fleet determine the number of\n\t\t\tinstances for which the Fleet reserves capacity. Both values are based on units that\n\t\t\tmake sense for your workload. For more information, see Total target\n\t\t\t\tcapacity in the Amazon EC2 User Guide.
" } }, "AvailabilityZone": { @@ -88654,7 +88654,7 @@ "Priority": { "target": "com.amazonaws.ec2#IntegerWithConstraints", "traits": { - "smithy.api#documentation": "The priority to assign to the instance type. This value is used to determine which of the instance types \n\t\t\tspecified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more \n\t\t\tinformation, see Instance type priority \n\t\t\tin the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The priority to assign to the instance type. This value is used to determine which of the\n\t\t\tinstance types specified for the Fleet should be prioritized for use. A lower value\n\t\t\tindicates a high priority. For more information, see Instance type\n\t\t\t\tpriority in the Amazon EC2 User Guide.
" } } }, @@ -89723,7 +89723,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Resets an attribute of an instance to its default value. To reset the\n kernel
or ramdisk
, the instance must be in a stopped\n state. To reset the sourceDestCheck
, the instance can be either running or\n stopped.
The sourceDestCheck
attribute controls whether source/destination\n checking is enabled. The default value is true
, which means checking is\n enabled. This value must be false
for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.
Resets an attribute of an instance to its default value. To reset the\n kernel
or ramdisk
, the instance must be in a stopped\n state. To reset the sourceDestCheck
, the instance can be either running or\n stopped.
The sourceDestCheck
attribute controls whether source/destination\n checking is enabled. The default value is true
, which means checking is\n enabled. This value must be false
for a NAT instance to perform NAT. For\n more information, see NAT instances in the\n Amazon VPC User Guide.
The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will\n resolve to the ID of the AMI at instance launch.
\nThe value depends on what you specified in the request. The possible values are:
\nIf an AMI ID was specified in the request, then this is the AMI ID.
\nIf a Systems Manager parameter was specified in the request, and\n ResolveAlias
was configured as true
, then this is\n the AMI ID that the parameter is mapped to in the Parameter Store.
If a Systems Manager parameter was specified in the request, and ResolveAlias
was configured\n as false
, then this is the parameter value.
For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will\n resolve to the ID of the AMI at instance launch.
\nThe value depends on what you specified in the request. The possible values are:
\nIf an AMI ID was specified in the request, then this is the AMI ID.
\nIf a Systems Manager parameter was specified in the request, and\n ResolveAlias
was configured as true
, then this is\n the AMI ID that the parameter is mapped to in the Parameter Store.
If a Systems Manager parameter was specified in the request, and ResolveAlias
was configured\n as false
, then this is the parameter value.
For more information, see Use a Systems \n Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "imageId" } }, @@ -90689,7 +90689,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateCpuOptions", "traits": { "aws.protocols#ec2QueryName": "CpuOptions", - "smithy.api#documentation": "The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User\n Guide.
", + "smithy.api#documentation": "The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "cpuOptions" } }, @@ -90713,7 +90713,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptions", "traits": { "aws.protocols#ec2QueryName": "HibernationOptions", - "smithy.api#documentation": "Indicates whether an instance is configured for hibernation. For more information, see\n Hibernate\n your instance in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Indicates whether an instance is configured for hibernation. For more information, see\n Hibernate\n your Amazon EC2 instance in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "hibernationOptions" } }, @@ -90721,7 +90721,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions", "traits": { "aws.protocols#ec2QueryName": "MetadataOptions", - "smithy.api#documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "metadataOptions" } }, @@ -90761,7 +90761,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DisableApiStop", - "smithy.api#documentation": "Indicates whether the instance is enabled for stop protection. For more information,\n see Stop\n protection in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Indicates whether the instance is enabled for stop protection. For more information,\n see Enable stop protection for your instance in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "disableApiStop" } } @@ -91726,7 +91726,7 @@ "target": "com.amazonaws.ec2#RouteTableAssociationList", "traits": { "aws.protocols#ec2QueryName": "AssociationSet", - "smithy.api#documentation": "The associations between the route table and one or more subnets or a gateway.
", + "smithy.api#documentation": "The associations between the route table and your subnets or gateways.
", "smithy.api#xmlName": "associationSet" } }, @@ -92056,7 +92056,7 @@ "target": "com.amazonaws.ec2#Reservation" }, "traits": { - "smithy.api#documentation": "Launches the specified number of instances using an AMI for which you have\n permissions.
\nYou can specify a number of options, or leave the default options. The following rules\n apply:
\nIf you don't specify a subnet ID, we choose a default subnet from\n your default VPC for you. If you don't have a default VPC, you must specify a\n subnet ID in the request.
\nAll instances have a network interface with a primary private IPv4\n address. If you don't specify this address, we choose one from the IPv4 range of\n your subnet.
\nNot all instance types support IPv6 addresses. For more information, see\n Instance\n types.
\nIf you don't specify a security group ID, we use the default security group.\n For more information, see Security\n groups.
\nIf any of the AMIs have a product code attached for which the user has not\n subscribed, the request fails.
\nYou can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.
\nTo ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.
\nAn instance is ready for you to use when it's in the running
state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.
Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.
\nFor troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.
", + "smithy.api#documentation": "Launches the specified number of instances using an AMI for which you have\n permissions.
\nYou can specify a number of options, or leave the default options. The following rules\n apply:
\nIf you don't specify a subnet ID, we choose a default subnet from\n your default VPC for you. If you don't have a default VPC, you must specify a\n subnet ID in the request.
\nAll instances have a network interface with a primary private IPv4\n address. If you don't specify this address, we choose one from the IPv4 range of\n your subnet.
\nNot all instance types support IPv6 addresses. For more information, see\n Instance\n types.
\nIf you don't specify a security group ID, we use the default security group\n for the VPC. For more information, see Security\n groups.
\nIf any of the AMIs have a product code attached for which the user has not\n subscribed, the request fails.
\nYou can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.
\nTo ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.
\n\n RunInstances
is subject to both request rate limiting and resource rate\n limiting. For more information, see Request throttling.
An instance is ready for you to use when it's in the running
state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.
Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.
\nFor troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.
", "smithy.api#examples": [ { "title": "To launch an instance", @@ -92131,7 +92131,7 @@ "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "The instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "The instance type. For more information, see Amazon EC2 instance\n types in the Amazon EC2 User Guide.
" } }, "Ipv6AddressCount": { @@ -92163,7 +92163,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount
.
Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.
", + "smithy.api#documentation": "The maximum number of instances to launch. If you specify a value that is more\n capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 \n launches the largest possible number of instances above the specified minimum\n count.
\nConstraints: Between 1 and the quota for the specified instance type for your account for this Region. \n For more information, see Amazon EC2 instance type quotas.
", "smithy.api#required": {} } }, @@ -92171,7 +92171,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The minimum number of instances to launch. If you specify a minimum that is more\n instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2\n launches no instances.
\nConstraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 General FAQ.
", + "smithy.api#documentation": "The minimum number of instances to launch. If you specify a value that is more\n capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does\n not launch any instances.
\nConstraints: Between 1 and the quota for the specified instance type for your account for this Region.\n For more information, see Amazon EC2 instance type quotas.
", "smithy.api#required": {} } }, @@ -92216,7 +92216,7 @@ "UserData": { "target": "com.amazonaws.ec2#RunInstancesUserData", "traits": { - "smithy.api#documentation": "The user data script to make available to the instance. For more information, see\n Run\n commands on your Linux instance at launch and Run commands on your\n Windows instance at launch. If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.
" + "smithy.api#documentation": "The user data script to make available to the instance. For more information, see\n Run\n commands on your Amazon EC2 instance at launch in the Amazon EC2 User\n Guide. If you are using a command line tool, base64-encoding is performed\n for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" } }, "AdditionalInfo": { @@ -92345,7 +92345,7 @@ "HibernationOptions": { "target": "com.amazonaws.ec2#HibernationOptionsRequest", "traits": { - "smithy.api#documentation": "Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.
\nYou can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.
" + "smithy.api#documentation": "Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.
\nYou can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.
" } }, "LicenseSpecifications": { @@ -92411,7 +92411,7 @@ "target": "com.amazonaws.ec2#RunScheduledInstancesResult" }, "traits": { - "smithy.api#documentation": "Launches the specified Scheduled Instances.
\nBefore you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
\nYou must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, \n but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, \n you can launch it again after a few minutes. For more information, see Scheduled Instances\n in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Launches the specified Scheduled Instances.
\nBefore you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
\nYou must launch a Scheduled Instance during its scheduled time period. You can't stop or\n reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a\n Scheduled Instance before the current scheduled time period ends, you can launch it again\n after a few minutes.
" } }, "com.amazonaws.ec2#RunScheduledInstancesRequest": { @@ -94124,7 +94124,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).
\nIn general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.
\nBefore sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.
\nFor more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).
" + "smithy.api#documentation": "Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).
\nIn general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.
\nBefore sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.
\nFor more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#SendDiagnosticInterruptRequest": { @@ -94627,7 +94627,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the\n volume encryption key for the parent volume.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that was used to protect the\n volume encryption key for the parent volume.
", "smithy.api#xmlName": "kmsKeyId" } }, @@ -94675,7 +94675,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails\n (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error\n state details to help you diagnose why the error occurred. This parameter is only returned by\n DescribeSnapshots.
", + "smithy.api#documentation": "Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails\n (for example, if the proper KMS permissions are not obtained) this field displays error\n state details to help you diagnose why the error occurred. This parameter is only returned by\n DescribeSnapshots.
", "smithy.api#xmlName": "statusMessage" } }, @@ -95399,7 +95399,7 @@ } }, "traits": { - "smithy.api#documentation": "The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity\n rebalancing in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#SpotDatafeedSubscription": { @@ -95689,7 +95689,7 @@ "target": "com.amazonaws.ec2#AllocationStrategy", "traits": { "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.
\nSpot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
\nSpot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.
Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nSpot Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowestPrice
\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.
\nSpot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
\nSpot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.
Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nWe don't recommend the lowestPrice
allocation strategy because\n it has the highest risk of interruption for your Spot Instances.
Spot Fleet requests instances from the lowest priced Spot Instance pool that has available\n capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs\n out of capacity before fulfilling your desired capacity, Spot Fleet will continue to\n fulfill your request by drawing from the next lowest priced pool. To ensure that\n your desired capacity is met, you might receive Spot Instances from several pools. Because\n this strategy only considers instance price and not capacity availability, it\n might lead to high interruption rates.
\nDefault: lowestPrice
\n
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n grants the Spot Fleet the permission to request, launch, terminate, and tag instances on\n your behalf. For more information, see Spot\n Fleet prerequisites in the Amazon EC2 User Guide. Spot Fleet\n can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using\n CancelSpotFleetRequests or when the Spot Fleet request expires, if you set\n TerminateInstancesWithExpiration
.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that grants the Spot Fleet the permission to request, launch, terminate, and tag instances\n on your behalf. For more information, see Spot\n Fleet prerequisites in the Amazon EC2 User Guide. Spot Fleet can\n 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\n TerminateInstancesWithExpiration
.
The maximum amount per hour for On-Demand Instances that you're willing to pay. You\n can use the onDemandMaxTotalPrice
parameter, the\n spotMaxTotalPrice
parameter, or both parameters to ensure that your\n fleet cost does not exceed your budget. If you set a maximum price per hour for the\n On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\n maximum amount you're willing to pay. When the maximum amount you're willing to pay is\n reached, the fleet stops launching instances even if it hasn’t met the target\n capacity.
If your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The onDemandMaxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for onDemandMaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for On-Demand Instances that you're willing to pay. You\n can use the onDemandMaxTotalPrice
parameter, the\n spotMaxTotalPrice
parameter, or both parameters to ensure that your\n fleet cost does not exceed your budget. If you set a maximum price per hour for the\n On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\n maximum amount you're willing to pay. When the maximum amount you're willing to pay is\n reached, the fleet stops launching instances even if it hasn’t met the target\n capacity.
If your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The onDemandMaxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for onDemandMaxTotalPrice
. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.
The maximum amount per hour for Spot Instances that you're willing to pay. You can use\n the spotMaxTotalPrice
parameter, the onDemandMaxTotalPrice
\n parameter, or both parameters to ensure that your fleet cost does not exceed your budget.\n If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will\n launch instances until it reaches the maximum amount you're willing to pay. When the\n maximum amount you're willing to pay is reached, the fleet stops launching instances even\n if it hasn’t met the target capacity.
If your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The spotMaxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for spotMaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for Spot Instances that you're willing to pay. You can use\n the spotMaxTotalPrice
parameter, the onDemandMaxTotalPrice
\n parameter, or both parameters to ensure that your fleet cost does not exceed your budget.\n If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will\n launch instances until it reaches the maximum amount you're willing to pay. When the\n maximum amount you're willing to pay is reached, the fleet stops launching instances even\n if it hasn’t met the target capacity.
If your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The spotMaxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for spotMaxTotalPrice
. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.
The state of the Spot Instance request. Spot request status information helps track your Spot\n Instance requests. For more information, see Spot request status in the\n Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "The state of the Spot Instance request. Spot request status information helps track your Spot\n Instance requests. For more information, see Spot request status in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "state" } }, @@ -96231,7 +96231,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "code" } }, @@ -96280,7 +96280,7 @@ "target": "com.amazonaws.ec2#SpotCapacityRebalance", "traits": { "aws.protocols#ec2QueryName": "CapacityRebalance", - "smithy.api#documentation": "The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity\n rebalancing in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "capacityRebalance" } } @@ -96334,7 +96334,7 @@ "target": "com.amazonaws.ec2#SpotAllocationStrategy", "traits": { "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized
is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nEC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowest-price
\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized
is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nWe don't recommend the lowest-price
allocation strategy because\n it has the highest risk of interruption for your Spot Instances.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available\n capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs\n out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to\n fulfill your request by drawing from the next lowest priced pool. To ensure that\n your desired capacity is met, you might receive Spot Instances from several pools. Because\n this strategy only considers instance price and not capacity availability, it\n might lead to high interruption rates.
\nDefault: lowest-price
\n
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
\nSupported only for fleets of type instant
.
At least one of the following must be specified: SingleAvailabilityZone
|\n SingleInstanceType
\n
The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't\n reached, no instances are launched.
\nConstraints: Maximum value of 1000
. Supported only for fleets of type\n instant
.
At least one of the following must be specified: SingleAvailabilityZone
|\n SingleInstanceType
\n
The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
\nIf your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The maxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for maxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
\nIf your fleet includes T instances that are configured as unlimited
, and\n if their average CPU usage exceeds the baseline utilization, you will incur a charge for\n surplus credits. The maxTotalPrice
does not account for surplus credits,\n and, if you use surplus credits, your final cost might be higher than what you specified\n for maxTotalPrice
. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized
is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nEC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowest-price
\n
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
\nEC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized
is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.
\nWe don't recommend the lowest-price
allocation strategy because\n it has the highest risk of interruption for your Spot Instances.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.
\nDefault: lowest-price
\n
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.
\nSupported only for fleets of type instant
.
At least one of the following must be specified: SingleAvailabilityZone
|\n SingleInstanceType
\n
The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't\n reached, no instances are launched.
\nConstraints: Maximum value of 1000
. Supported only for fleets of type\n instant
.
At least one of the following must be specified: SingleAvailabilityZone
|\n SingleInstanceType
\n
The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
\nIf your fleet includes T instances that are configured as unlimited
,\n and if their average CPU usage exceeds the baseline utilization, you will incur a charge\n for surplus credits. The MaxTotalPrice
does not account for surplus\n credits, and, if you use surplus credits, your final cost might be higher than what you\n specified for MaxTotalPrice
. For more information, see Surplus credits can incur charges in the EC2 User\n Guide.
The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend\n using this parameter because it can lead to increased interruptions. If you do not specify\n this parameter, you will pay the current Spot price.
\nIf you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
\nIf your fleet includes T instances that are configured as unlimited
, and\n if their average CPU usage exceeds the baseline utilization, you will incur a charge for\n surplus credits. The MaxTotalPrice
does not account for surplus credits,\n and, if you use surplus credits, your final cost might be higher than what you specified\n for MaxTotalPrice
. For more information, see Surplus credits can incur charges in the\n Amazon EC2 User Guide.
Starts an Amazon EBS-backed instance that you've previously stopped.
\nInstances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nBefore stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.
\nPerforming this operation on an instance that uses an instance store as its root\n device returns an error.
\nIf you attempt to start a T3 instance with host
tenancy and the\n unlimited
CPU credit option, the request fails. The\n unlimited
CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard
, or\n change its tenancy to default
or dedicated
.
For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Starts an Amazon EBS-backed instance that you've previously stopped.
\nInstances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nBefore stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.
\nPerforming this operation on an instance that uses an instance store as its root\n device returns an error.
\nIf you attempt to start a T3 instance with host
tenancy and the\n unlimited
CPU credit option, the request fails. The\n unlimited
CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard
, or\n change its tenancy to default
or dedicated
.
For more information, see Stop and start Amazon EC2\n instances in the Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To start a stopped EC2 instance", @@ -96875,7 +96875,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -96955,7 +96955,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, \n see How to ensure idempotency.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -97208,7 +97208,7 @@ "target": "com.amazonaws.ec2#StopInstancesResult" }, "traits": { - "smithy.api#documentation": "Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.
\nYou can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.
\nWe don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nYou can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.
\nWhen you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.
\nStopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
\nWhen you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Stops an Amazon EBS-backed instance. For more information, see Stop and start\n Amazon EC2 instances in the Amazon EC2 User\n Guide.
\nYou can use the Stop action to hibernate an instance if the instance is enabled\n for hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.
\nWe don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nYou can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.
\nWhen you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.
\nStopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
\nWhen you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To stop a running EC2 instance", @@ -105131,7 +105131,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the\n volume encryption key for the volume.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that was used to protect the\n volume encryption key for the volume.
", "smithy.api#xmlName": "kmsKeyId" } },