Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon Virtual Private Cloud User Guide.
" }, "AcceptReservedInstancesExchangeQuote": { "name": "AcceptReservedInstancesExchangeQuote", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AcceptReservedInstancesExchangeQuoteRequest" }, "output": { "shape": "AcceptReservedInstancesExchangeQuoteResult" }, "documentation": "Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
" }, "AcceptTransitGatewayMulticastDomainAssociations": { "name": "AcceptTransitGatewayMulticastDomainAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AcceptTransitGatewayMulticastDomainAssociationsRequest" }, "output": { "shape": "AcceptTransitGatewayMulticastDomainAssociationsResult" }, "documentation": "Accepts a request to associate subnets with a transit gateway multicast domain.
" }, "AcceptTransitGatewayPeeringAttachment": { "name": "AcceptTransitGatewayPeeringAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AcceptTransitGatewayPeeringAttachmentRequest" }, "output": { "shape": "AcceptTransitGatewayPeeringAttachmentResult" }, "documentation": "Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
Accepts connection requests to your VPC endpoint service.
" }, "AcceptVpcPeeringConnection": { "name": "AcceptVpcPeeringConnection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AcceptVpcPeeringConnectionRequest" }, "output": { "shape": "AcceptVpcPeeringConnectionResult" }, "documentation": "Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
" }, "AdvertiseByoipCidr": { "name": "AdvertiseByoipCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AdvertiseByoipCidrRequest" }, "output": { "shape": "AdvertiseByoipCidrResult" }, "documentation": "Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
" }, "AllocateAddress": { "name": "AllocateAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AllocateAddressRequest" }, "output": { "shape": "AllocateAddressResult" }, "documentation": "Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
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.
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.
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).
" }, "AllocateHosts": { "name": "AllocateHosts", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AllocateHostsRequest" }, "output": { "shape": "AllocateHostsResult" }, "documentation": "Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
" }, "AllocateIpamPoolCidr": { "name": "AllocateIpamPoolCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AllocateIpamPoolCidrRequest" }, "output": { "shape": "AllocateIpamPoolCidrResult" }, "documentation": "Allocate a CIDR from 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.
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.
Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
" }, "AssignIpv6Addresses": { "name": "AssignIpv6Addresses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssignIpv6AddressesRequest" }, "output": { "shape": "AssignIpv6AddressesResult" }, "documentation": "Assigns one or more IPv6 addresses to the specified network interface. You can 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.
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.
" }, "AssignPrivateIpAddresses": { "name": "AssignPrivateIpAddresses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssignPrivateIpAddressesRequest" }, "output": { "shape": "AssignPrivateIpAddressesResult" }, "documentation": "Assigns one or more secondary private IP addresses to the specified network interface.
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.
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 interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
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.
" }, "AssignPrivateNatGatewayAddress": { "name": "AssignPrivateNatGatewayAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssignPrivateNatGatewayAddressRequest" }, "output": { "shape": "AssignPrivateNatGatewayAddressResult" }, "documentation": "Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
" }, "AssociateAddress": { "name": "AssociateAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateAddressRequest" }, "output": { "shape": "AssociateAddressResult" }, "documentation": "Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
" }, "AssociateDhcpOptions": { "name": "AssociateDhcpOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateDhcpOptionsRequest" }, "documentation": "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 in the Amazon VPC User Guide.
" }, "AssociateEnclaveCertificateIamRole": { "name": "AssociateEnclaveCertificateIamRole", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateEnclaveCertificateIamRoleRequest" }, "output": { "shape": "AssociateEnclaveCertificateIamRoleResult" }, "documentation": "Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
" }, "AssociateInstanceEventWindow": { "name": "AssociateInstanceEventWindow", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateInstanceEventWindowRequest" }, "output": { "shape": "AssociateInstanceEventWindowResult" }, "documentation": "Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
" }, "AssociateIpamByoasn": { "name": "AssociateIpamByoasn", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateIpamByoasnRequest" }, "output": { "shape": "AssociateIpamByoasnResult" }, "documentation": "Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.
" }, "AssociateIpamResourceDiscovery": { "name": "AssociateIpamResourceDiscovery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateIpamResourceDiscoveryRequest" }, "output": { "shape": "AssociateIpamResourceDiscoveryResult" }, "documentation": "Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
" }, "AssociateNatGatewayAddress": { "name": "AssociateNatGatewayAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateNatGatewayAddressRequest" }, "output": { "shape": "AssociateNatGatewayAddressResult" }, "documentation": "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.
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.
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon VPC User Guide.
" }, "AssociateSubnetCidrBlock": { "name": "AssociateSubnetCidrBlock", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateSubnetCidrBlockRequest" }, "output": { "shape": "AssociateSubnetCidrBlockResult" }, "documentation": "Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet.
" }, "AssociateTransitGatewayMulticastDomain": { "name": "AssociateTransitGatewayMulticastDomain", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateTransitGatewayMulticastDomainRequest" }, "output": { "shape": "AssociateTransitGatewayMulticastDomainResult" }, "documentation": "Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
" }, "AssociateTransitGatewayPolicyTable": { "name": "AssociateTransitGatewayPolicyTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateTransitGatewayPolicyTableRequest" }, "output": { "shape": "AssociateTransitGatewayPolicyTableResult" }, "documentation": "Associates the specified transit gateway attachment with a transit gateway policy table.
" }, "AssociateTransitGatewayRouteTable": { "name": "AssociateTransitGatewayRouteTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateTransitGatewayRouteTableRequest" }, "output": { "shape": "AssociateTransitGatewayRouteTableResult" }, "documentation": "Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
" }, "AssociateTrunkInterface": { "name": "AssociateTrunkInterface", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssociateTrunkInterfaceRequest" }, "output": { "shape": "AssociateTrunkInterfaceResult" }, "documentation": "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.
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 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 restrictions, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
" }, "AttachClassicLinkVpc": { "name": "AttachClassicLinkVpc", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AttachClassicLinkVpcRequest" }, "output": { "shape": "AttachClassicLinkVpcResult" }, "documentation": "This action is deprecated.
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
" }, "AttachInternetGateway": { "name": "AttachInternetGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AttachInternetGatewayRequest" }, "documentation": "Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the Amazon VPC User Guide.
" }, "AttachNetworkInterface": { "name": "AttachNetworkInterface", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AttachNetworkInterfaceRequest" }, "output": { "shape": "AttachNetworkInterfaceResult" }, "documentation": "Attaches a network interface to an instance.
" }, "AttachVerifiedAccessTrustProvider": { "name": "AttachVerifiedAccessTrustProvider", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AttachVerifiedAccessTrustProviderRequest" }, "output": { "shape": "AttachVerifiedAccessTrustProviderResult" }, "documentation": "Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
" }, "AttachVolume": { "name": "AttachVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AttachVolumeRequest" }, "output": { "shape": "VolumeAttachment" }, "documentation": "Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attach an Amazon EBS volume to an instance in the Amazon EBS User Guide.
" }, "AttachVpnGateway": { "name": "AttachVpnGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AttachVpnGatewayRequest" }, "output": { "shape": "AttachVpnGatewayResult" }, "documentation": "Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "AuthorizeClientVpnIngress": { "name": "AuthorizeClientVpnIngress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AuthorizeClientVpnIngressRequest" }, "output": { "shape": "AuthorizeClientVpnIngressResult" }, "documentation": "Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
" }, "AuthorizeSecurityGroupEgress": { "name": "AuthorizeSecurityGroupEgress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AuthorizeSecurityGroupEgressRequest" }, "output": { "shape": "AuthorizeSecurityGroupEgressResult" }, "documentation": "Adds the specified outbound (egress) rules to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address ranges specified by a prefix list, or the instances that are associated with a source security group. For more information, see Security group rules.
You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
" }, "AuthorizeSecurityGroupIngress": { "name": "AuthorizeSecurityGroupIngress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AuthorizeSecurityGroupIngressRequest" }, "output": { "shape": "AuthorizeSecurityGroupIngressResult" }, "documentation": "Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see Security group rules.
You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For more information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
" }, "BundleInstance": { "name": "BundleInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BundleInstanceRequest" }, "output": { "shape": "BundleInstanceResult" }, "documentation": "Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
Cancels a bundling operation for an instance store-backed Windows instance.
" }, "CancelCapacityReservation": { "name": "CancelCapacityReservation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelCapacityReservationRequest" }, "output": { "shape": "CancelCapacityReservationResult" }, "documentation": "Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
" }, "CancelCapacityReservationFleets": { "name": "CancelCapacityReservationFleets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelCapacityReservationFleetsRequest" }, "output": { "shape": "CancelCapacityReservationFleetsResult" }, "documentation": "Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet's status changes to cancelled.
The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
" }, "CancelExportTask": { "name": "CancelExportTask", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelExportTaskRequest" }, "documentation": "Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
" }, "CancelImageLaunchPermission": { "name": "CancelImageLaunchPermission", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelImageLaunchPermissionRequest" }, "output": { "shape": "CancelImageLaunchPermissionResult" }, "documentation": "Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
" }, "CancelImportTask": { "name": "CancelImportTask", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelImportTaskRequest" }, "output": { "shape": "CancelImportTaskResult" }, "documentation": "Cancels an in-process import virtual machine or import snapshot task.
" }, "CancelReservedInstancesListing": { "name": "CancelReservedInstancesListing", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelReservedInstancesListingRequest" }, "output": { "shape": "CancelReservedInstancesListingResult" }, "documentation": "Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
" }, "CancelSpotFleetRequests": { "name": "CancelSpotFleetRequests", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelSpotFleetRequestsRequest" }, "output": { "shape": "CancelSpotFleetRequestsResponse" }, "documentation": "Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Restrictions
You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
" }, "CopyFpgaImage": { "name": "CopyFpgaImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CopyFpgaImageRequest" }, "output": { "shape": "CopyFpgaImageResult" }, "documentation": "Copies the specified Amazon FPGA Image (AFI) to the current Region.
" }, "CopyImage": { "name": "CopyImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CopyImageRequest" }, "output": { "shape": "CopyImageResult" }, "documentation": "Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
" }, "CopySnapshot": { "name": "CopySnapshot", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CopySnapshotRequest" }, "output": { "shape": "CopySnapshotResult" }, "documentation": "Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
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 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 encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.
" }, "CreateCapacityReservation": { "name": "CreateCapacityReservation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateCapacityReservationRequest" }, "output": { "shape": "CreateCapacityReservationResult" }, "documentation": "Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
" }, "CreateCapacityReservationFleet": { "name": "CreateCapacityReservationFleet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateCapacityReservationFleetRequest" }, "output": { "shape": "CreateCapacityReservationFleetResult" }, "documentation": "Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.
" }, "CreateCarrierGateway": { "name": "CreateCarrierGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateCarrierGatewayRequest" }, "output": { "shape": "CreateCarrierGatewayResult" }, "documentation": "Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.
" }, "CreateClientVpnEndpoint": { "name": "CreateClientVpnEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateClientVpnEndpointRequest" }, "output": { "shape": "CreateClientVpnEndpointResult" }, "documentation": "Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
" }, "CreateClientVpnRoute": { "name": "CreateClientVpnRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateClientVpnRouteRequest" }, "output": { "shape": "CreateClientVpnRouteResult" }, "documentation": "Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
" }, "CreateCoipCidr": { "name": "CreateCoipCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateCoipCidrRequest" }, "output": { "shape": "CreateCoipCidrResult" }, "documentation": "Creates a range of customer-owned IP addresses.
" }, "CreateCoipPool": { "name": "CreateCoipPool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateCoipPoolRequest" }, "output": { "shape": "CreateCoipPoolResult" }, "documentation": "Creates a pool of customer-owned IP (CoIP) addresses.
" }, "CreateCustomerGateway": { "name": "CreateCustomerGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateCustomerGatewayRequest" }, "output": { "shape": "CreateCustomerGatewayResult" }, "documentation": "Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.
" }, "CreateDefaultSubnet": { "name": "CreateDefaultSubnet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateDefaultSubnetRequest" }, "output": { "shape": "CreateDefaultSubnetResult" }, "documentation": "Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Create a default subnet in the Amazon VPC User Guide.
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPCs in the Amazon VPC User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
" }, "CreateDhcpOptions": { "name": "CreateDhcpOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateDhcpOptionsRequest" }, "output": { "shape": "CreateDhcpOptionsResult" }, "documentation": "Creates a custom set of DHCP options. After you create a DHCP option set, you associate 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 in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
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.
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. 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 lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
" }, "CreateFleet": { "name": "CreateFleet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateFleetRequest" }, "output": { "shape": "CreateFleetResult" }, "documentation": "Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances. Instances are launched immediately if there is available capacity.
A single EC2 Fleet can include multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
" }, "CreateFlowLogs": { "name": "CreateFlowLogs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateFlowLogsRequest" }, "output": { "shape": "CreateFlowLogsResult" }, "documentation": "Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
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.
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.
" }, "CreateFpgaImage": { "name": "CreateFpgaImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateFpgaImageRequest" }, "output": { "shape": "CreateFpgaImageResult" }, "documentation": "Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
" }, "CreateImage": { "name": "CreateImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateImageRequest" }, "output": { "shape": "CreateImageResult" }, "documentation": "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Create an Amazon EBS-backed Linux AMI in the Amazon Elastic Compute Cloud User Guide.
" }, "CreateInstanceConnectEndpoint": { "name": "CreateInstanceConnectEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateInstanceConnectEndpointRequest" }, "output": { "shape": "CreateInstanceConnectEndpointResult" }, "documentation": "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.
" }, "CreateInstanceEventWindow": { "name": "CreateInstanceEventWindow", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateInstanceEventWindowRequest" }, "output": { "shape": "CreateInstanceEventWindowResult" }, "documentation": "Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.
You can create up to 200 event windows per Amazon Web Services Region.
When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.
Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.
Event windows are not applicable for:
Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
" }, "CreateInstanceExportTask": { "name": "CreateInstanceExportTask", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateInstanceExportTaskRequest" }, "output": { "shape": "CreateInstanceExportTaskResult" }, "documentation": "Exports a running or stopped instance to an Amazon S3 bucket.
For information about the prerequisites for your Amazon S3 bucket, supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
" }, "CreateInternetGateway": { "name": "CreateInternetGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateInternetGatewayRequest" }, "output": { "shape": "CreateInternetGatewayResult" }, "documentation": "Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information, see Internet gateways in the Amazon VPC User Guide.
" }, "CreateIpam": { "name": "CreateIpam", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateIpamRequest" }, "output": { "shape": "CreateIpamResult" }, "documentation": "Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
" }, "CreateIpamPool": { "name": "CreateIpamPool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateIpamPoolRequest" }, "output": { "shape": "CreateIpamPoolResult" }, "documentation": "Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
" }, "CreateIpamResourceDiscovery": { "name": "CreateIpamResourceDiscovery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateIpamResourceDiscoveryRequest" }, "output": { "shape": "CreateIpamResourceDiscoveryResult" }, "documentation": "Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
" }, "CreateIpamScope": { "name": "CreateIpamScope", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateIpamScopeRequest" }, "output": { "shape": "CreateIpamScopeResult" }, "documentation": "Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
" }, "CreateKeyPair": { "name": "CreateKeyPair", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateKeyPairRequest" }, "output": { "shape": "KeyPair" }, "documentation": "Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.
The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
You can have up to 5,000 key pairs per Amazon Web Services Region.
For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
" }, "CreateLaunchTemplate": { "name": "CreateLaunchTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateLaunchTemplateRequest" }, "output": { "shape": "CreateLaunchTemplateResult" }, "documentation": "Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an 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.
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.
" }, "CreateLaunchTemplateVersion": { "name": "CreateLaunchTemplateVersion", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateLaunchTemplateVersionRequest" }, "output": { "shape": "CreateLaunchTemplateVersionResult" }, "documentation": "Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed.
Launch template versions are numbered in the order in which they are created. You can't specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify 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.
" }, "CreateLocalGatewayRoute": { "name": "CreateLocalGatewayRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateLocalGatewayRouteRequest" }, "output": { "shape": "CreateLocalGatewayRouteResult" }, "documentation": "Creates a static route for the specified local gateway route table. You must specify one of the following targets:
LocalGatewayVirtualInterfaceGroupId
NetworkInterfaceId
Creates a local gateway route table.
" }, "CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation": { "name": "CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest" }, "output": { "shape": "CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult" }, "documentation": "Creates a local gateway route table virtual interface group association.
" }, "CreateLocalGatewayRouteTableVpcAssociation": { "name": "CreateLocalGatewayRouteTableVpcAssociation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateLocalGatewayRouteTableVpcAssociationRequest" }, "output": { "shape": "CreateLocalGatewayRouteTableVpcAssociationResult" }, "documentation": "Associates the specified VPC with the specified local gateway route table.
" }, "CreateManagedPrefixList": { "name": "CreateManagedPrefixList", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateManagedPrefixListRequest" }, "output": { "shape": "CreateManagedPrefixListResult" }, "documentation": "Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.
" }, "CreateNatGateway": { "name": "CreateNatGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateNatGatewayRequest" }, "output": { "shape": "CreateNatGatewayResult" }, "documentation": "Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT gateways in the Amazon VPC User Guide.
When you create a public NAT gateway and assign it an EIP or secondary EIPs, 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 NAT gateway will fail to launch. 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.
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon VPC User Guide.
" }, "CreateNetworkAclEntry": { "name": "CreateNetworkAclEntry", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateNetworkAclEntryRequest" }, "documentation": "Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon VPC User Guide.
" }, "CreateNetworkInsightsAccessScope": { "name": "CreateNetworkInsightsAccessScope", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateNetworkInsightsAccessScopeRequest" }, "output": { "shape": "CreateNetworkInsightsAccessScopeResult" }, "documentation": "Creates a Network Access Scope.
Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
" }, "CreateNetworkInsightsPath": { "name": "CreateNetworkInsightsPath", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateNetworkInsightsPathRequest" }, "output": { "shape": "CreateNetworkInsightsPathResult" }, "documentation": "Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the Reachability Analyzer Guide.
" }, "CreateNetworkInterface": { "name": "CreateNetworkInterface", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateNetworkInterfaceRequest" }, "output": { "shape": "CreateNetworkInterfaceResult" }, "documentation": "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.
For more information about network interfaces, see Elastic network interfaces in the Amazon Elastic Compute Cloud User Guide.
" }, "CreateNetworkInterfacePermission": { "name": "CreateNetworkInterfacePermission", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateNetworkInterfacePermissionRequest" }, "output": { "shape": "CreateNetworkInterfacePermissionResult" }, "documentation": "Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single Amazon Web Services account only, and only one account at a time.
" }, "CreatePlacementGroup": { "name": "CreatePlacementGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreatePlacementGroupRequest" }, "output": { "shape": "CreatePlacementGroupResult" }, "documentation": "Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide.
" }, "CreatePublicIpv4Pool": { "name": "CreatePublicIpv4Pool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreatePublicIpv4PoolRequest" }, "output": { "shape": "CreatePublicIpv4PoolResult" }, "documentation": "Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.
" }, "CreateReplaceRootVolumeTask": { "name": "CreateReplaceRootVolumeTask", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateReplaceRootVolumeTaskRequest" }, "output": { "shape": "CreateReplaceRootVolumeTaskResult" }, "documentation": "Replaces the EBS-backed root volume for a running instance with a new 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.
" }, "CreateReservedInstancesListing": { "name": "CreateReservedInstancesListing", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateReservedInstancesListingRequest" }, "output": { "shape": "CreateReservedInstancesListingResult" }, "documentation": "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The 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.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price 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.
" }, "CreateRestoreImageTask": { "name": "CreateRestoreImageTask", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateRestoreImageTaskRequest" }, "output": { "shape": "CreateRestoreImageTaskResult" }, "documentation": "Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
" }, "CreateRoute": { "name": "CreateRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateRouteRequest" }, "output": { "shape": "CreateRouteResult" }, "documentation": "Creates a route in a route table within a VPC.
You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the Amazon VPC User Guide.
" }, "CreateRouteTable": { "name": "CreateRouteTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateRouteTableRequest" }, "output": { "shape": "CreateRouteTableResult" }, "documentation": "Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route tables in the Amazon VPC User Guide.
" }, "CreateSecurityGroup": { "name": "CreateSecurityGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateSecurityGroupRequest" }, "output": { "shape": "CreateSecurityGroupResult" }, "documentation": "Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
When you create a security group, you specify a friendly name of your choice. You can't have two security groups for the same VPC with the same name.
You have a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
For more information about VPC security group limits, see Amazon VPC Limits.
" }, "CreateSnapshot": { "name": "CreateSnapshot", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateSnapshotRequest" }, "output": { "shape": "Snapshot" }, "documentation": "Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that 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.
" }, "CreateSnapshots": { "name": "CreateSnapshots", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateSnapshotsRequest" }, "output": { "shape": "CreateSnapshotsResult" }, "documentation": "Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance.
You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
" }, "CreateSpotDatafeedSubscription": { "name": "CreateSpotDatafeedSubscription", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateSpotDatafeedSubscriptionRequest" }, "output": { "shape": "CreateSpotDatafeedSubscriptionResult" }, "documentation": "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.
" }, "CreateStoreImageTask": { "name": "CreateStoreImageTask", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateStoreImageTaskRequest" }, "output": { "shape": "CreateStoreImageTaskResult" }, "documentation": "Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
" }, "CreateSubnet": { "name": "CreateSubnet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateSubnetRequest" }, "output": { "shape": "CreateSubnetResult" }, "documentation": "Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block.
The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use.
If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information, see Subnets in the Amazon VPC User Guide.
" }, "CreateSubnetCidrReservation": { "name": "CreateSubnetCidrReservation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateSubnetCidrReservationRequest" }, "output": { "shape": "CreateSubnetCidrReservationResult" }, "documentation": "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.
" }, "CreateTags": { "name": "CreateTags", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTagsRequest" }, "documentation": "Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the Amazon Elastic Compute Cloud User Guide.
" }, "CreateTrafficMirrorFilter": { "name": "CreateTrafficMirrorFilter", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTrafficMirrorFilterRequest" }, "output": { "shape": "CreateTrafficMirrorFilterResult" }, "documentation": "Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
" }, "CreateTrafficMirrorFilterRule": { "name": "CreateTrafficMirrorFilterRule", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTrafficMirrorFilterRuleRequest" }, "output": { "shape": "CreateTrafficMirrorFilterRuleResult" }, "documentation": "Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
" }, "CreateTrafficMirrorSession": { "name": "CreateTrafficMirrorSession", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTrafficMirrorSessionRequest" }, "output": { "shape": "CreateTrafficMirrorSessionResult" }, "documentation": "Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
" }, "CreateTrafficMirrorTarget": { "name": "CreateTrafficMirrorTarget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTrafficMirrorTargetRequest" }, "output": { "shape": "CreateTrafficMirrorTargetResult" }, "documentation": "Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
" }, "CreateTransitGateway": { "name": "CreateTransitGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayRequest" }, "output": { "shape": "CreateTransitGatewayResult" }, "documentation": "Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
" }, "CreateTransitGatewayConnect": { "name": "CreateTransitGatewayConnect", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayConnectRequest" }, "output": { "shape": "CreateTransitGatewayConnectResult" }, "documentation": "Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
" }, "CreateTransitGatewayConnectPeer": { "name": "CreateTransitGatewayConnectPeer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayConnectPeerRequest" }, "output": { "shape": "CreateTransitGatewayConnectPeerResult" }, "documentation": "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.
" }, "CreateTransitGatewayMulticastDomain": { "name": "CreateTransitGatewayMulticastDomain", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayMulticastDomainRequest" }, "output": { "shape": "CreateTransitGatewayMulticastDomainResult" }, "documentation": "Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
" }, "CreateTransitGatewayPeeringAttachment": { "name": "CreateTransitGatewayPeeringAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayPeeringAttachmentRequest" }, "output": { "shape": "CreateTransitGatewayPeeringAttachmentResult" }, "documentation": "Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
" }, "CreateTransitGatewayPolicyTable": { "name": "CreateTransitGatewayPolicyTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayPolicyTableRequest" }, "output": { "shape": "CreateTransitGatewayPolicyTableResult" }, "documentation": "Creates a transit gateway policy table.
" }, "CreateTransitGatewayPrefixListReference": { "name": "CreateTransitGatewayPrefixListReference", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayPrefixListReferenceRequest" }, "output": { "shape": "CreateTransitGatewayPrefixListReferenceResult" }, "documentation": "Creates a reference (route) to a prefix list in a specified transit gateway route table.
" }, "CreateTransitGatewayRoute": { "name": "CreateTransitGatewayRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayRouteRequest" }, "output": { "shape": "CreateTransitGatewayRouteResult" }, "documentation": "Creates a static route for the specified transit gateway route table.
" }, "CreateTransitGatewayRouteTable": { "name": "CreateTransitGatewayRouteTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayRouteTableRequest" }, "output": { "shape": "CreateTransitGatewayRouteTableResult" }, "documentation": "Creates a route table for the specified transit gateway.
" }, "CreateTransitGatewayRouteTableAnnouncement": { "name": "CreateTransitGatewayRouteTableAnnouncement", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayRouteTableAnnouncementRequest" }, "output": { "shape": "CreateTransitGatewayRouteTableAnnouncementResult" }, "documentation": "Advertises a new transit gateway route table.
" }, "CreateTransitGatewayVpcAttachment": { "name": "CreateTransitGatewayVpcAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTransitGatewayVpcAttachmentRequest" }, "output": { "shape": "CreateTransitGatewayVpcAttachmentResult" }, "documentation": "Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.
" }, "CreateVerifiedAccessEndpoint": { "name": "CreateVerifiedAccessEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVerifiedAccessEndpointRequest" }, "output": { "shape": "CreateVerifiedAccessEndpointResult" }, "documentation": "An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
" }, "CreateVerifiedAccessGroup": { "name": "CreateVerifiedAccessGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVerifiedAccessGroupRequest" }, "output": { "shape": "CreateVerifiedAccessGroupResult" }, "documentation": "An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with \"sales\" applications together and use one common Verified Access policy.
" }, "CreateVerifiedAccessInstance": { "name": "CreateVerifiedAccessInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVerifiedAccessInstanceRequest" }, "output": { "shape": "CreateVerifiedAccessInstanceResult" }, "documentation": "An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.
" }, "CreateVerifiedAccessTrustProvider": { "name": "CreateVerifiedAccessTrustProvider", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVerifiedAccessTrustProviderRequest" }, "output": { "shape": "CreateVerifiedAccessTrustProviderResult" }, "documentation": "A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.
" }, "CreateVolume": { "name": "CreateVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVolumeRequest" }, "output": { "shape": "Volume" }, "documentation": "Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Create an Amazon EBS volume in the Amazon EBS User Guide.
" }, "CreateVpc": { "name": "CreateVpc", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVpcRequest" }, "output": { "shape": "CreateVpcResult" }, "documentation": "Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
By default, each instance that you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP option sets in the Amazon VPC User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon EC2 User Guide.
" }, "CreateVpcEndpoint": { "name": "CreateVpcEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVpcEndpointRequest" }, "output": { "shape": "CreateVpcEndpointResult" }, "documentation": "Creates a VPC endpoint. A VPC endpoint provides a private connection between the specified VPC and the specified endpoint service. You can use an endpoint service provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink User Guide.
" }, "CreateVpcEndpointConnectionNotification": { "name": "CreateVpcEndpointConnectionNotification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVpcEndpointConnectionNotificationRequest" }, "output": { "shape": "CreateVpcEndpointConnectionNotificationResult" }, "documentation": "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.
You can create a connection notification for interface endpoints only.
" }, "CreateVpcEndpointServiceConfiguration": { "name": "CreateVpcEndpointServiceConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVpcEndpointServiceConfigurationRequest" }, "output": { "shape": "CreateVpcEndpointServiceConfigurationResult" }, "documentation": "Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.
Before you create an endpoint service, you must create one of the following for your service:
A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.
If you set the private DNS name, you must prove that you own the private DNS domain name.
For more information, see the Amazon Web Services PrivateLink Guide.
" }, "CreateVpcPeeringConnection": { "name": "CreateVpcPeeringConnection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVpcPeeringConnectionRequest" }, "output": { "shape": "CreateVpcPeeringConnectionResult" }, "documentation": "Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. 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 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 cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "CreateVpnConnectionRoute": { "name": "CreateVpnConnectionRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVpnConnectionRouteRequest" }, "documentation": "Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "CreateVpnGateway": { "name": "CreateVpnGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVpnGatewayRequest" }, "output": { "shape": "CreateVpnGatewayResult" }, "documentation": "Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "DeleteCarrierGateway": { "name": "DeleteCarrierGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteCarrierGatewayRequest" }, "output": { "shape": "DeleteCarrierGatewayResult" }, "documentation": "Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.
Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
" }, "DeleteClientVpnRoute": { "name": "DeleteClientVpnRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteClientVpnRouteRequest" }, "output": { "shape": "DeleteClientVpnRouteResult" }, "documentation": "Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
" }, "DeleteCoipCidr": { "name": "DeleteCoipCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteCoipCidrRequest" }, "output": { "shape": "DeleteCoipCidrResult" }, "documentation": "Deletes a range of customer-owned IP addresses.
" }, "DeleteCoipPool": { "name": "DeleteCoipPool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteCoipPoolRequest" }, "output": { "shape": "DeleteCoipPoolResult" }, "documentation": "Deletes a pool of customer-owned IP (CoIP) addresses.
" }, "DeleteCustomerGateway": { "name": "DeleteCustomerGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteCustomerGatewayRequest" }, "documentation": "Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
" }, "DeleteDhcpOptions": { "name": "DeleteDhcpOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteDhcpOptionsRequest" }, "documentation": "Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
" }, "DeleteEgressOnlyInternetGateway": { "name": "DeleteEgressOnlyInternetGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteEgressOnlyInternetGatewayRequest" }, "output": { "shape": "DeleteEgressOnlyInternetGatewayResult" }, "documentation": "Deletes an egress-only internet gateway.
" }, "DeleteFleets": { "name": "DeleteFleets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteFleetsRequest" }, "output": { "shape": "DeleteFleetsResult" }, "documentation": "Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. Up to 1000 instances can be terminated in a single request to delete instant fleets. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 fleets of type instant in a single request.
You can delete up to 100 fleets of type maintain or request in a single request.
You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above.
If you exceed the specified number of fleets to delete, no fleets are deleted.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
" }, "DeleteFlowLogs": { "name": "DeleteFlowLogs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteFlowLogsRequest" }, "output": { "shape": "DeleteFlowLogsResult" }, "documentation": "Deletes one or more flow logs.
" }, "DeleteFpgaImage": { "name": "DeleteFpgaImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteFpgaImageRequest" }, "output": { "shape": "DeleteFpgaImageResult" }, "documentation": "Deletes the specified Amazon FPGA Image (AFI).
" }, "DeleteInstanceConnectEndpoint": { "name": "DeleteInstanceConnectEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteInstanceConnectEndpointRequest" }, "output": { "shape": "DeleteInstanceConnectEndpointResult" }, "documentation": "Deletes the specified EC2 Instance Connect Endpoint.
" }, "DeleteInstanceEventWindow": { "name": "DeleteInstanceEventWindow", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteInstanceEventWindowRequest" }, "output": { "shape": "DeleteInstanceEventWindowResult" }, "documentation": "Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
" }, "DeleteInternetGateway": { "name": "DeleteInternetGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteInternetGatewayRequest" }, "documentation": "Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
" }, "DeleteIpam": { "name": "DeleteIpam", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteIpamRequest" }, "output": { "shape": "DeleteIpamResult" }, "documentation": "Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
" }, "DeleteIpamPool": { "name": "DeleteIpamPool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteIpamPoolRequest" }, "output": { "shape": "DeleteIpamPoolResult" }, "documentation": "Delete an IPAM pool.
You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.
For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
" }, "DeleteIpamResourceDiscovery": { "name": "DeleteIpamResourceDiscovery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteIpamResourceDiscoveryRequest" }, "output": { "shape": "DeleteIpamResourceDiscoveryResult" }, "documentation": "Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
" }, "DeleteIpamScope": { "name": "DeleteIpamScope", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteIpamScopeRequest" }, "output": { "shape": "DeleteIpamScopeResult" }, "documentation": "Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
" }, "DeleteKeyPair": { "name": "DeleteKeyPair", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteKeyPairRequest" }, "output": { "shape": "DeleteKeyPairResult" }, "documentation": "Deletes the specified key pair, by removing the public key from Amazon EC2.
" }, "DeleteLaunchTemplate": { "name": "DeleteLaunchTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLaunchTemplateRequest" }, "output": { "shape": "DeleteLaunchTemplateResult" }, "documentation": "Deletes a launch template. Deleting a launch template deletes all of its versions.
" }, "DeleteLaunchTemplateVersions": { "name": "DeleteLaunchTemplateVersions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLaunchTemplateVersionsRequest" }, "output": { "shape": "DeleteLaunchTemplateVersionsResult" }, "documentation": "Deletes one or more versions of a launch template.
You can't delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
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.
" }, "DeleteLocalGatewayRoute": { "name": "DeleteLocalGatewayRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLocalGatewayRouteRequest" }, "output": { "shape": "DeleteLocalGatewayRouteResult" }, "documentation": "Deletes the specified route from the specified local gateway route table.
" }, "DeleteLocalGatewayRouteTable": { "name": "DeleteLocalGatewayRouteTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLocalGatewayRouteTableRequest" }, "output": { "shape": "DeleteLocalGatewayRouteTableResult" }, "documentation": "Deletes a local gateway route table.
" }, "DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation": { "name": "DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest" }, "output": { "shape": "DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult" }, "documentation": "Deletes a local gateway route table virtual interface group association.
" }, "DeleteLocalGatewayRouteTableVpcAssociation": { "name": "DeleteLocalGatewayRouteTableVpcAssociation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLocalGatewayRouteTableVpcAssociationRequest" }, "output": { "shape": "DeleteLocalGatewayRouteTableVpcAssociationResult" }, "documentation": "Deletes the specified association between a VPC and local gateway route table.
" }, "DeleteManagedPrefixList": { "name": "DeleteManagedPrefixList", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteManagedPrefixListRequest" }, "output": { "shape": "DeleteManagedPrefixListResult" }, "documentation": "Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
" }, "DeleteNatGateway": { "name": "DeleteNatGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNatGatewayRequest" }, "output": { "shape": "DeleteNatGatewayResult" }, "documentation": "Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.
" }, "DeleteNetworkAcl": { "name": "DeleteNetworkAcl", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkAclRequest" }, "documentation": "Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
" }, "DeleteNetworkAclEntry": { "name": "DeleteNetworkAclEntry", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkAclEntryRequest" }, "documentation": "Deletes the specified ingress or egress entry (rule) from the specified network ACL.
" }, "DeleteNetworkInsightsAccessScope": { "name": "DeleteNetworkInsightsAccessScope", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkInsightsAccessScopeRequest" }, "output": { "shape": "DeleteNetworkInsightsAccessScopeResult" }, "documentation": "Deletes the specified Network Access Scope.
" }, "DeleteNetworkInsightsAccessScopeAnalysis": { "name": "DeleteNetworkInsightsAccessScopeAnalysis", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkInsightsAccessScopeAnalysisRequest" }, "output": { "shape": "DeleteNetworkInsightsAccessScopeAnalysisResult" }, "documentation": "Deletes the specified Network Access Scope analysis.
" }, "DeleteNetworkInsightsAnalysis": { "name": "DeleteNetworkInsightsAnalysis", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkInsightsAnalysisRequest" }, "output": { "shape": "DeleteNetworkInsightsAnalysisResult" }, "documentation": "Deletes the specified network insights analysis.
" }, "DeleteNetworkInsightsPath": { "name": "DeleteNetworkInsightsPath", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkInsightsPathRequest" }, "output": { "shape": "DeleteNetworkInsightsPathResult" }, "documentation": "Deletes the specified path.
" }, "DeleteNetworkInterface": { "name": "DeleteNetworkInterface", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkInterfaceRequest" }, "documentation": "Deletes the specified network interface. You must detach the network interface before you can delete it.
" }, "DeleteNetworkInterfacePermission": { "name": "DeleteNetworkInterfacePermission", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNetworkInterfacePermissionRequest" }, "output": { "shape": "DeleteNetworkInterfacePermissionResult" }, "documentation": "Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.
" }, "DeletePlacementGroup": { "name": "DeletePlacementGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeletePlacementGroupRequest" }, "documentation": "Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.
" }, "DeletePublicIpv4Pool": { "name": "DeletePublicIpv4Pool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeletePublicIpv4PoolRequest" }, "output": { "shape": "DeletePublicIpv4PoolResult" }, "documentation": "Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.
" }, "DeleteQueuedReservedInstances": { "name": "DeleteQueuedReservedInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteQueuedReservedInstancesRequest" }, "output": { "shape": "DeleteQueuedReservedInstancesResult" }, "documentation": "Deletes the queued purchases for the specified Reserved Instances.
" }, "DeleteRoute": { "name": "DeleteRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteRouteRequest" }, "documentation": "Deletes the specified route from the specified route table.
" }, "DeleteRouteTable": { "name": "DeleteRouteTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteRouteTableRequest" }, "documentation": "Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
" }, "DeleteSecurityGroup": { "name": "DeleteSecurityGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteSecurityGroupRequest" }, "documentation": "Deletes a security group.
If you attempt to delete a security group that is associated with an instance or network interface or is referenced by another security group, the operation fails with DependencyViolation.
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon EBS User Guide.
" }, "DeleteSpotDatafeedSubscription": { "name": "DeleteSpotDatafeedSubscription", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteSpotDatafeedSubscriptionRequest" }, "documentation": "Deletes the data feed for Spot Instances.
" }, "DeleteSubnet": { "name": "DeleteSubnet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteSubnetRequest" }, "documentation": "Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
" }, "DeleteSubnetCidrReservation": { "name": "DeleteSubnetCidrReservation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteSubnetCidrReservationRequest" }, "output": { "shape": "DeleteSubnetCidrReservationResult" }, "documentation": "Deletes a subnet CIDR reservation.
" }, "DeleteTags": { "name": "DeleteTags", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTagsRequest" }, "documentation": "Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
" }, "DeleteTrafficMirrorFilter": { "name": "DeleteTrafficMirrorFilter", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTrafficMirrorFilterRequest" }, "output": { "shape": "DeleteTrafficMirrorFilterResult" }, "documentation": "Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
" }, "DeleteTrafficMirrorFilterRule": { "name": "DeleteTrafficMirrorFilterRule", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTrafficMirrorFilterRuleRequest" }, "output": { "shape": "DeleteTrafficMirrorFilterRuleResult" }, "documentation": "Deletes the specified Traffic Mirror rule.
" }, "DeleteTrafficMirrorSession": { "name": "DeleteTrafficMirrorSession", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTrafficMirrorSessionRequest" }, "output": { "shape": "DeleteTrafficMirrorSessionResult" }, "documentation": "Deletes the specified Traffic Mirror session.
" }, "DeleteTrafficMirrorTarget": { "name": "DeleteTrafficMirrorTarget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTrafficMirrorTargetRequest" }, "output": { "shape": "DeleteTrafficMirrorTargetResult" }, "documentation": "Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
" }, "DeleteTransitGateway": { "name": "DeleteTransitGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayRequest" }, "output": { "shape": "DeleteTransitGatewayResult" }, "documentation": "Deletes the specified transit gateway.
" }, "DeleteTransitGatewayConnect": { "name": "DeleteTransitGatewayConnect", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayConnectRequest" }, "output": { "shape": "DeleteTransitGatewayConnectResult" }, "documentation": "Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
" }, "DeleteTransitGatewayConnectPeer": { "name": "DeleteTransitGatewayConnectPeer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayConnectPeerRequest" }, "output": { "shape": "DeleteTransitGatewayConnectPeerResult" }, "documentation": "Deletes the specified Connect peer.
" }, "DeleteTransitGatewayMulticastDomain": { "name": "DeleteTransitGatewayMulticastDomain", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayMulticastDomainRequest" }, "output": { "shape": "DeleteTransitGatewayMulticastDomainResult" }, "documentation": "Deletes the specified transit gateway multicast domain.
" }, "DeleteTransitGatewayPeeringAttachment": { "name": "DeleteTransitGatewayPeeringAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayPeeringAttachmentRequest" }, "output": { "shape": "DeleteTransitGatewayPeeringAttachmentResult" }, "documentation": "Deletes a transit gateway peering attachment.
" }, "DeleteTransitGatewayPolicyTable": { "name": "DeleteTransitGatewayPolicyTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayPolicyTableRequest" }, "output": { "shape": "DeleteTransitGatewayPolicyTableResult" }, "documentation": "Deletes the specified transit gateway policy table.
" }, "DeleteTransitGatewayPrefixListReference": { "name": "DeleteTransitGatewayPrefixListReference", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayPrefixListReferenceRequest" }, "output": { "shape": "DeleteTransitGatewayPrefixListReferenceResult" }, "documentation": "Deletes a reference (route) to a prefix list in a specified transit gateway route table.
" }, "DeleteTransitGatewayRoute": { "name": "DeleteTransitGatewayRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayRouteRequest" }, "output": { "shape": "DeleteTransitGatewayRouteResult" }, "documentation": "Deletes the specified route from the specified transit gateway route table.
" }, "DeleteTransitGatewayRouteTable": { "name": "DeleteTransitGatewayRouteTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayRouteTableRequest" }, "output": { "shape": "DeleteTransitGatewayRouteTableResult" }, "documentation": "Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
" }, "DeleteTransitGatewayRouteTableAnnouncement": { "name": "DeleteTransitGatewayRouteTableAnnouncement", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayRouteTableAnnouncementRequest" }, "output": { "shape": "DeleteTransitGatewayRouteTableAnnouncementResult" }, "documentation": "Advertises to the transit gateway that a transit gateway route table is deleted.
" }, "DeleteTransitGatewayVpcAttachment": { "name": "DeleteTransitGatewayVpcAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTransitGatewayVpcAttachmentRequest" }, "output": { "shape": "DeleteTransitGatewayVpcAttachmentResult" }, "documentation": "Deletes the specified VPC attachment.
" }, "DeleteVerifiedAccessEndpoint": { "name": "DeleteVerifiedAccessEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVerifiedAccessEndpointRequest" }, "output": { "shape": "DeleteVerifiedAccessEndpointResult" }, "documentation": "Delete an Amazon Web Services Verified Access endpoint.
" }, "DeleteVerifiedAccessGroup": { "name": "DeleteVerifiedAccessGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVerifiedAccessGroupRequest" }, "output": { "shape": "DeleteVerifiedAccessGroupResult" }, "documentation": "Delete an Amazon Web Services Verified Access group.
" }, "DeleteVerifiedAccessInstance": { "name": "DeleteVerifiedAccessInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVerifiedAccessInstanceRequest" }, "output": { "shape": "DeleteVerifiedAccessInstanceResult" }, "documentation": "Delete an Amazon Web Services Verified Access instance.
" }, "DeleteVerifiedAccessTrustProvider": { "name": "DeleteVerifiedAccessTrustProvider", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVerifiedAccessTrustProviderRequest" }, "output": { "shape": "DeleteVerifiedAccessTrustProviderResult" }, "documentation": "Delete an Amazon Web Services Verified Access trust provider.
" }, "DeleteVolume": { "name": "DeleteVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVolumeRequest" }, "documentation": "Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Delete an Amazon EBS volume in the Amazon EBS User Guide.
" }, "DeleteVpc": { "name": "DeleteVpc", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVpcRequest" }, "documentation": "Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the VPC's default security group, network ACL, and route table.
" }, "DeleteVpcEndpointConnectionNotifications": { "name": "DeleteVpcEndpointConnectionNotifications", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVpcEndpointConnectionNotificationsRequest" }, "output": { "shape": "DeleteVpcEndpointConnectionNotificationsResult" }, "documentation": "Deletes the specified VPC endpoint connection notifications.
" }, "DeleteVpcEndpointServiceConfigurations": { "name": "DeleteVpcEndpointServiceConfigurations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVpcEndpointServiceConfigurationsRequest" }, "output": { "shape": "DeleteVpcEndpointServiceConfigurationsResult" }, "documentation": "Deletes the specified VPC endpoint service configurations. Before you can delete an endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.
Deletes the specified VPC endpoints.
When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint.
When you delete a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
When you delete an interface endpoint, we delete its endpoint network interfaces.
" }, "DeleteVpcPeeringConnection": { "name": "DeleteVpcPeeringConnection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVpcPeeringConnectionRequest" }, "output": { "shape": "DeleteVpcPeeringConnectionResult" }, "documentation": "Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed or rejected state.
Deletes the specified VPN connection.
If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.
" }, "DeleteVpnConnectionRoute": { "name": "DeleteVpnConnectionRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVpnConnectionRouteRequest" }, "documentation": "Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
" }, "DeleteVpnGateway": { "name": "DeleteVpnGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVpnGatewayRequest" }, "documentation": "Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
" }, "DeprovisionByoipCidr": { "name": "DeprovisionByoipCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeprovisionByoipCidrRequest" }, "output": { "shape": "DeprovisionByoipCidrResult" }, "documentation": "Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
" }, "DeprovisionIpamByoasn": { "name": "DeprovisionIpamByoasn", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeprovisionIpamByoasnRequest" }, "output": { "shape": "DeprovisionIpamByoasnResult" }, "documentation": "Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account. This action can only be called after any BYOIP CIDR associations are removed from your Amazon Web Services account with DisassociateIpamByoasn. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
" }, "DeprovisionIpamPoolCidr": { "name": "DeprovisionIpamPoolCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeprovisionIpamPoolCidrRequest" }, "output": { "shape": "DeprovisionIpamPoolCidrResult" }, "documentation": "Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.
" }, "DeprovisionPublicIpv4PoolCidr": { "name": "DeprovisionPublicIpv4PoolCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeprovisionPublicIpv4PoolCidrRequest" }, "output": { "shape": "DeprovisionPublicIpv4PoolCidrResult" }, "documentation": "Deprovision a CIDR from a public IPv4 pool.
" }, "DeregisterImage": { "name": "DeregisterImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterImageRequest" }, "documentation": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon EC2 User Guide.
When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
" }, "DeregisterInstanceEventNotificationAttributes": { "name": "DeregisterInstanceEventNotificationAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterInstanceEventNotificationAttributesRequest" }, "output": { "shape": "DeregisterInstanceEventNotificationAttributesResult" }, "documentation": "Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
" }, "DeregisterTransitGatewayMulticastGroupMembers": { "name": "DeregisterTransitGatewayMulticastGroupMembers", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterTransitGatewayMulticastGroupMembersRequest" }, "output": { "shape": "DeregisterTransitGatewayMulticastGroupMembersResult" }, "documentation": "Deregisters the specified members (network interfaces) from the transit gateway multicast group.
" }, "DeregisterTransitGatewayMulticastGroupSources": { "name": "DeregisterTransitGatewayMulticastGroupSources", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeregisterTransitGatewayMulticastGroupSourcesRequest" }, "output": { "shape": "DeregisterTransitGatewayMulticastGroupSourcesResult" }, "documentation": "Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
" }, "DescribeAccountAttributes": { "name": "DescribeAccountAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeAccountAttributesRequest" }, "output": { "shape": "DescribeAccountAttributesResult" }, "documentation": "Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
default-vpc: The ID of the default VPC for your account, or none.
max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
supported-platforms: This attribute is deprecated.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
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.
Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud 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 transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for three days after the transfers have been accepted.
" }, "DescribeAddresses": { "name": "DescribeAddresses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeAddressesRequest" }, "output": { "shape": "DescribeAddressesResult" }, "documentation": "Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
" }, "DescribeAddressesAttribute": { "name": "DescribeAddressesAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeAddressesAttributeRequest" }, "output": { "shape": "DescribeAddressesAttributeResult" }, "documentation": "Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.
" }, "DescribeAggregateIdFormat": { "name": "DescribeAggregateIdFormat", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeAggregateIdFormatRequest" }, "output": { "shape": "DescribeAggregateIdFormatResult" }, "documentation": "Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any 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.
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.
Describes the current Infrastructure Performance metric subscriptions.
" }, "DescribeBundleTasks": { "name": "DescribeBundleTasks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBundleTasksRequest" }, "output": { "shape": "DescribeBundleTasksResult" }, "documentation": "Describes the specified bundle tasks or all of your bundle tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
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.
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
" }, "DescribeCapacityBlockOfferings": { "name": "DescribeCapacityBlockOfferings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeCapacityBlockOfferingsRequest" }, "output": { "shape": "DescribeCapacityBlockOfferingsResult" }, "documentation": "Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
" }, "DescribeCapacityReservationFleets": { "name": "DescribeCapacityReservationFleets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeCapacityReservationFleetsRequest" }, "output": { "shape": "DescribeCapacityReservationFleetsResult" }, "documentation": "Describes one or more Capacity Reservation Fleets.
" }, "DescribeCapacityReservations": { "name": "DescribeCapacityReservations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeCapacityReservationsRequest" }, "output": { "shape": "DescribeCapacityReservationsResult" }, "documentation": "Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
" }, "DescribeCarrierGateways": { "name": "DescribeCarrierGateways", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeCarrierGatewaysRequest" }, "output": { "shape": "DescribeCarrierGatewaysResult" }, "documentation": "Describes one or more of your carrier gateways.
" }, "DescribeClassicLinkInstances": { "name": "DescribeClassicLinkInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeClassicLinkInstancesRequest" }, "output": { "shape": "DescribeClassicLinkInstancesResult" }, "documentation": "This action is deprecated.
Describes one or more of 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.
" }, "DescribeClientVpnAuthorizationRules": { "name": "DescribeClientVpnAuthorizationRules", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeClientVpnAuthorizationRulesRequest" }, "output": { "shape": "DescribeClientVpnAuthorizationRulesResult" }, "documentation": "Describes the authorization rules for a specified Client VPN endpoint.
" }, "DescribeClientVpnConnections": { "name": "DescribeClientVpnConnections", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeClientVpnConnectionsRequest" }, "output": { "shape": "DescribeClientVpnConnectionsResult" }, "documentation": "Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
" }, "DescribeClientVpnEndpoints": { "name": "DescribeClientVpnEndpoints", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeClientVpnEndpointsRequest" }, "output": { "shape": "DescribeClientVpnEndpointsResult" }, "documentation": "Describes one or more Client VPN endpoints in the account.
" }, "DescribeClientVpnRoutes": { "name": "DescribeClientVpnRoutes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeClientVpnRoutesRequest" }, "output": { "shape": "DescribeClientVpnRoutesResult" }, "documentation": "Describes the routes for the specified Client VPN endpoint.
" }, "DescribeClientVpnTargetNetworks": { "name": "DescribeClientVpnTargetNetworks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeClientVpnTargetNetworksRequest" }, "output": { "shape": "DescribeClientVpnTargetNetworksResult" }, "documentation": "Describes the target networks associated with the specified Client VPN endpoint.
" }, "DescribeCoipPools": { "name": "DescribeCoipPools", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeCoipPoolsRequest" }, "output": { "shape": "DescribeCoipPoolsResult" }, "documentation": "Describes the specified customer-owned address pools or all of your customer-owned address pools.
" }, "DescribeConversionTasks": { "name": "DescribeConversionTasks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeConversionTasksRequest" }, "output": { "shape": "DescribeConversionTasksResult" }, "documentation": "Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
" }, "DescribeCustomerGateways": { "name": "DescribeCustomerGateways", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeCustomerGatewaysRequest" }, "output": { "shape": "DescribeCustomerGatewaysResult" }, "documentation": "Describes one or more of your VPN customer gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "DescribeDhcpOptions": { "name": "DescribeDhcpOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeDhcpOptionsRequest" }, "output": { "shape": "DescribeDhcpOptionsResult" }, "documentation": "Describes one or more of your DHCP options sets.
For more information, see DHCP options sets in the Amazon VPC User Guide.
" }, "DescribeEgressOnlyInternetGateways": { "name": "DescribeEgressOnlyInternetGateways", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEgressOnlyInternetGatewaysRequest" }, "output": { "shape": "DescribeEgressOnlyInternetGatewaysResult" }, "documentation": "Describes one or more of your egress-only internet gateways.
" }, "DescribeElasticGpus": { "name": "DescribeElasticGpus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeElasticGpusRequest" }, "output": { "shape": "DescribeElasticGpusResult" }, "documentation": "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.
Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.
" }, "DescribeExportImageTasks": { "name": "DescribeExportImageTasks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeExportImageTasksRequest" }, "output": { "shape": "DescribeExportImageTasksResult" }, "documentation": "Describes the specified export image tasks or all of your export image tasks.
" }, "DescribeExportTasks": { "name": "DescribeExportTasks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeExportTasksRequest" }, "output": { "shape": "DescribeExportTasksResult" }, "documentation": "Describes the specified export instance tasks or all of your export instance tasks.
" }, "DescribeFastLaunchImages": { "name": "DescribeFastLaunchImages", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFastLaunchImagesRequest" }, "output": { "shape": "DescribeFastLaunchImagesResult" }, "documentation": "Describe details for Windows AMIs that are configured for Windows fast launch.
" }, "DescribeFastSnapshotRestores": { "name": "DescribeFastSnapshotRestores", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFastSnapshotRestoresRequest" }, "output": { "shape": "DescribeFastSnapshotRestoresResult" }, "documentation": "Describes the state of fast snapshot restores for your snapshots.
" }, "DescribeFleetHistory": { "name": "DescribeFleetHistory", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFleetHistoryRequest" }, "output": { "shape": "DescribeFleetHistoryResult" }, "documentation": "Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
" }, "DescribeFleetInstances": { "name": "DescribeFleetInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFleetInstancesRequest" }, "output": { "shape": "DescribeFleetInstancesResult" }, "documentation": "Describes the running instances for the specified EC2 Fleet.
Currently, DescribeFleetInstances does not support fleets of type instant. Instead, use DescribeFleets, specifying the instant fleet ID in the request.
For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.
" }, "DescribeFleets": { "name": "DescribeFleets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFleetsRequest" }, "output": { "shape": "DescribeFleetsResult" }, "documentation": "Describes the specified EC2 Fleet or all of your EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID in the request, otherwise the fleet does not appear in the response.
For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.
" }, "DescribeFlowLogs": { "name": "DescribeFlowLogs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFlowLogsRequest" }, "output": { "shape": "DescribeFlowLogsResult" }, "documentation": "Describes one or more flow logs.
To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.
" }, "DescribeFpgaImageAttribute": { "name": "DescribeFpgaImageAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFpgaImageAttributeRequest" }, "output": { "shape": "DescribeFpgaImageAttributeResult" }, "documentation": "Describes the specified attribute of the specified Amazon FPGA Image (AFI).
" }, "DescribeFpgaImages": { "name": "DescribeFpgaImages", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFpgaImagesRequest" }, "output": { "shape": "DescribeFpgaImagesResult" }, "documentation": "Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.
" }, "DescribeHostReservationOfferings": { "name": "DescribeHostReservationOfferings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeHostReservationOfferingsRequest" }, "output": { "shape": "DescribeHostReservationOfferingsResult" }, "documentation": "Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
" }, "DescribeHostReservations": { "name": "DescribeHostReservations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeHostReservationsRequest" }, "output": { "shape": "DescribeHostReservationsResult" }, "documentation": "Describes reservations that are associated with Dedicated Hosts in your account.
" }, "DescribeHosts": { "name": "DescribeHosts", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeHostsRequest" }, "output": { "shape": "DescribeHostsResult" }, "documentation": "Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.
Describes your IAM instance profile associations.
" }, "DescribeIdFormat": { "name": "DescribeIdFormat", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIdFormatRequest" }, "output": { "shape": "DescribeIdFormatResult" }, "documentation": "Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
" }, "DescribeImageAttribute": { "name": "DescribeImageAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeImageAttributeRequest" }, "output": { "shape": "ImageAttribute" }, "documentation": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
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.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
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.
Displays details about an import virtual machine or import snapshot tasks that are already created.
" }, "DescribeImportSnapshotTasks": { "name": "DescribeImportSnapshotTasks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeImportSnapshotTasksRequest" }, "output": { "shape": "DescribeImportSnapshotTasksResult" }, "documentation": "Describes your import snapshot tasks.
" }, "DescribeInstanceAttribute": { "name": "DescribeInstanceAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstanceAttributeRequest" }, "output": { "shape": "InstanceAttribute" }, "documentation": "Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport
Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.
" }, "DescribeInstanceCreditSpecifications": { "name": "DescribeInstanceCreditSpecifications", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstanceCreditSpecificationsRequest" }, "output": { "shape": "DescribeInstanceCreditSpecificationsResult" }, "documentation": "Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
" }, "DescribeInstanceEventNotificationAttributes": { "name": "DescribeInstanceEventNotificationAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstanceEventNotificationAttributesRequest" }, "output": { "shape": "DescribeInstanceEventNotificationAttributesResult" }, "documentation": "Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
" }, "DescribeInstanceEventWindows": { "name": "DescribeInstanceEventWindows", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstanceEventWindowsRequest" }, "output": { "shape": "DescribeInstanceEventWindowsResult" }, "documentation": "Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
" }, "DescribeInstanceStatus": { "name": "DescribeInstanceStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstanceStatusRequest" }, "output": { "shape": "DescribeInstanceStatusResult" }, "documentation": "Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The 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.
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge
p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
" }, "DescribeInstanceTypeOfferings": { "name": "DescribeInstanceTypeOfferings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstanceTypeOfferingsRequest" }, "output": { "shape": "DescribeInstanceTypeOfferingsResult" }, "documentation": "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.
" }, "DescribeInstanceTypes": { "name": "DescribeInstanceTypes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstanceTypesRequest" }, "output": { "shape": "DescribeInstanceTypesResult" }, "documentation": "Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
" }, "DescribeInstances": { "name": "DescribeInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeInstancesRequest" }, "output": { "shape": "DescribeInstancesResult" }, "documentation": "Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
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.
Describes one or more of your internet gateways.
" }, "DescribeIpamByoasn": { "name": "DescribeIpamByoasn", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIpamByoasnRequest" }, "output": { "shape": "DescribeIpamByoasnResult" }, "documentation": "Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
" }, "DescribeIpamPools": { "name": "DescribeIpamPools", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIpamPoolsRequest" }, "output": { "shape": "DescribeIpamPoolsResult" }, "documentation": "Get information about your IPAM pools.
" }, "DescribeIpamResourceDiscoveries": { "name": "DescribeIpamResourceDiscoveries", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIpamResourceDiscoveriesRequest" }, "output": { "shape": "DescribeIpamResourceDiscoveriesResult" }, "documentation": "Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
" }, "DescribeIpamResourceDiscoveryAssociations": { "name": "DescribeIpamResourceDiscoveryAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIpamResourceDiscoveryAssociationsRequest" }, "output": { "shape": "DescribeIpamResourceDiscoveryAssociationsResult" }, "documentation": "Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..
" }, "DescribeIpamScopes": { "name": "DescribeIpamScopes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIpamScopesRequest" }, "output": { "shape": "DescribeIpamScopesResult" }, "documentation": "Get information about your IPAM scopes.
" }, "DescribeIpams": { "name": "DescribeIpams", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIpamsRequest" }, "output": { "shape": "DescribeIpamsResult" }, "documentation": "Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "DescribeIpv6Pools": { "name": "DescribeIpv6Pools", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIpv6PoolsRequest" }, "output": { "shape": "DescribeIpv6PoolsResult" }, "documentation": "Describes your IPv6 address pools.
" }, "DescribeKeyPairs": { "name": "DescribeKeyPairs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeKeyPairsRequest" }, "output": { "shape": "DescribeKeyPairsResult" }, "documentation": "Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
" }, "DescribeLaunchTemplateVersions": { "name": "DescribeLaunchTemplateVersions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLaunchTemplateVersionsRequest" }, "output": { "shape": "DescribeLaunchTemplateVersionsResult" }, "documentation": "Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.
" }, "DescribeLaunchTemplates": { "name": "DescribeLaunchTemplates", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLaunchTemplatesRequest" }, "output": { "shape": "DescribeLaunchTemplatesResult" }, "documentation": "Describes one or more launch templates.
" }, "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations": { "name": "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest" }, "output": { "shape": "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult" }, "documentation": "Describes the associations between virtual interface groups and local gateway route tables.
" }, "DescribeLocalGatewayRouteTableVpcAssociations": { "name": "DescribeLocalGatewayRouteTableVpcAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLocalGatewayRouteTableVpcAssociationsRequest" }, "output": { "shape": "DescribeLocalGatewayRouteTableVpcAssociationsResult" }, "documentation": "Describes the specified associations between VPCs and local gateway route tables.
" }, "DescribeLocalGatewayRouteTables": { "name": "DescribeLocalGatewayRouteTables", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLocalGatewayRouteTablesRequest" }, "output": { "shape": "DescribeLocalGatewayRouteTablesResult" }, "documentation": "Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
" }, "DescribeLocalGatewayVirtualInterfaceGroups": { "name": "DescribeLocalGatewayVirtualInterfaceGroups", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLocalGatewayVirtualInterfaceGroupsRequest" }, "output": { "shape": "DescribeLocalGatewayVirtualInterfaceGroupsResult" }, "documentation": "Describes the specified local gateway virtual interface groups.
" }, "DescribeLocalGatewayVirtualInterfaces": { "name": "DescribeLocalGatewayVirtualInterfaces", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLocalGatewayVirtualInterfacesRequest" }, "output": { "shape": "DescribeLocalGatewayVirtualInterfacesResult" }, "documentation": "Describes the specified local gateway virtual interfaces.
" }, "DescribeLocalGateways": { "name": "DescribeLocalGateways", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLocalGatewaysRequest" }, "output": { "shape": "DescribeLocalGatewaysResult" }, "documentation": "Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
" }, "DescribeLockedSnapshots": { "name": "DescribeLockedSnapshots", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeLockedSnapshotsRequest" }, "output": { "shape": "DescribeLockedSnapshotsResult" }, "documentation": "Describes the lock status for a snapshot.
" }, "DescribeMacHosts": { "name": "DescribeMacHosts", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeMacHostsRequest" }, "output": { "shape": "DescribeMacHostsResult" }, "documentation": "Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.
" }, "DescribeManagedPrefixLists": { "name": "DescribeManagedPrefixLists", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeManagedPrefixListsRequest" }, "output": { "shape": "DescribeManagedPrefixListsResult" }, "documentation": "Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
" }, "DescribeMovingAddresses": { "name": "DescribeMovingAddresses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeMovingAddressesRequest" }, "output": { "shape": "DescribeMovingAddressesResult" }, "documentation": "This action is deprecated.
Describes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
" }, "DescribeNatGateways": { "name": "DescribeNatGateways", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNatGatewaysRequest" }, "output": { "shape": "DescribeNatGatewaysResult" }, "documentation": "Describes one or more of your NAT gateways.
" }, "DescribeNetworkAcls": { "name": "DescribeNetworkAcls", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkAclsRequest" }, "output": { "shape": "DescribeNetworkAclsResult" }, "documentation": "Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon VPC User Guide.
" }, "DescribeNetworkInsightsAccessScopeAnalyses": { "name": "DescribeNetworkInsightsAccessScopeAnalyses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkInsightsAccessScopeAnalysesRequest" }, "output": { "shape": "DescribeNetworkInsightsAccessScopeAnalysesResult" }, "documentation": "Describes the specified Network Access Scope analyses.
" }, "DescribeNetworkInsightsAccessScopes": { "name": "DescribeNetworkInsightsAccessScopes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkInsightsAccessScopesRequest" }, "output": { "shape": "DescribeNetworkInsightsAccessScopesResult" }, "documentation": "Describes the specified Network Access Scopes.
" }, "DescribeNetworkInsightsAnalyses": { "name": "DescribeNetworkInsightsAnalyses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkInsightsAnalysesRequest" }, "output": { "shape": "DescribeNetworkInsightsAnalysesResult" }, "documentation": "Describes one or more of your network insights analyses.
" }, "DescribeNetworkInsightsPaths": { "name": "DescribeNetworkInsightsPaths", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkInsightsPathsRequest" }, "output": { "shape": "DescribeNetworkInsightsPathsResult" }, "documentation": "Describes one or more of your paths.
" }, "DescribeNetworkInterfaceAttribute": { "name": "DescribeNetworkInterfaceAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkInterfaceAttributeRequest" }, "output": { "shape": "DescribeNetworkInterfaceAttributeResult" }, "documentation": "Describes a network interface attribute. You can specify only one attribute at a time.
" }, "DescribeNetworkInterfacePermissions": { "name": "DescribeNetworkInterfacePermissions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkInterfacePermissionsRequest" }, "output": { "shape": "DescribeNetworkInterfacePermissionsResult" }, "documentation": "Describes the permissions for your network interfaces.
" }, "DescribeNetworkInterfaces": { "name": "DescribeNetworkInterfaces", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkInterfacesRequest" }, "output": { "shape": "DescribeNetworkInterfacesResult" }, "documentation": "Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.
" }, "DescribePrefixLists": { "name": "DescribePrefixLists", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribePrefixListsRequest" }, "output": { "shape": "DescribePrefixListsResult" }, "documentation": "Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
" }, "DescribePrincipalIdFormat": { "name": "DescribePrincipalIdFormat", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribePrincipalIdFormatRequest" }, "output": { "shape": "DescribePrincipalIdFormatResult" }, "documentation": "Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the specified IPv4 address pools.
" }, "DescribeRegions": { "name": "DescribeRegions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeRegionsRequest" }, "output": { "shape": "DescribeRegionsResult" }, "documentation": "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.
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.
Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
" }, "DescribeReservedInstances": { "name": "DescribeReservedInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeReservedInstancesRequest" }, "output": { "shape": "DescribeReservedInstancesResult" }, "documentation": "Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see 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 particular order.
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
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.
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.
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.
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.
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.
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.
Describes one or more of your route tables.
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.
" }, "DescribeScheduledInstanceAvailability": { "name": "DescribeScheduledInstanceAvailability", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeScheduledInstanceAvailabilityRequest" }, "output": { "shape": "DescribeScheduledInstanceAvailabilityResult" }, "documentation": "Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
" }, "DescribeScheduledInstances": { "name": "DescribeScheduledInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeScheduledInstancesRequest" }, "output": { "shape": "DescribeScheduledInstancesResult" }, "documentation": "Describes the specified Scheduled Instances or all your Scheduled Instances.
" }, "DescribeSecurityGroupReferences": { "name": "DescribeSecurityGroupReferences", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSecurityGroupReferencesRequest" }, "output": { "shape": "DescribeSecurityGroupReferencesResult" }, "documentation": "Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
" }, "DescribeSecurityGroupRules": { "name": "DescribeSecurityGroupRules", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSecurityGroupRulesRequest" }, "output": { "shape": "DescribeSecurityGroupRulesResult" }, "documentation": "Describes one or more of your security group rules.
" }, "DescribeSecurityGroups": { "name": "DescribeSecurityGroups", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSecurityGroupsRequest" }, "output": { "shape": "DescribeSecurityGroupsResult" }, "documentation": "Describes the specified security groups or all of your security groups.
" }, "DescribeSnapshotAttribute": { "name": "DescribeSnapshotAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSnapshotAttributeRequest" }, "output": { "shape": "DescribeSnapshotAttributeResult" }, "documentation": "Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
" }, "DescribeSnapshotTierStatus": { "name": "DescribeSnapshotTierStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSnapshotTierStatusRequest" }, "output": { "shape": "DescribeSnapshotTierStatusResult" }, "documentation": "Describes the storage tier status of one or more Amazon EBS snapshots.
" }, "DescribeSnapshots": { "name": "DescribeSnapshots", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSnapshotsRequest" }, "output": { "shape": "DescribeSnapshotsResult" }, "documentation": "Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.
" }, "DescribeSpotFleetInstances": { "name": "DescribeSpotFleetInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSpotFleetInstancesRequest" }, "output": { "shape": "DescribeSpotFleetInstancesResponse" }, "documentation": "Describes the running instances for the specified Spot Fleet.
" }, "DescribeSpotFleetRequestHistory": { "name": "DescribeSpotFleetRequestHistory", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSpotFleetRequestHistoryRequest" }, "output": { "shape": "DescribeSpotFleetRequestHistoryResponse" }, "documentation": "Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
" }, "DescribeSpotFleetRequests": { "name": "DescribeSpotFleetRequests", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSpotFleetRequestsRequest" }, "output": { "shape": "DescribeSpotFleetRequestsResponse" }, "documentation": "Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
" }, "DescribeSpotInstanceRequests": { "name": "DescribeSpotInstanceRequests", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSpotInstanceRequestsRequest" }, "output": { "shape": "DescribeSpotInstanceRequestsResult" }, "documentation": "Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of items returned. This paginates the output, which makes the list more manageable and returns the items faster. If the list of items exceeds your MaxResults value, then that number of items is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining items.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
" }, "DescribeSpotPriceHistory": { "name": "DescribeSpotPriceHistory", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSpotPriceHistoryRequest" }, "output": { "shape": "DescribeSpotPriceHistoryResult" }, "documentation": "Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
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.
" }, "DescribeStaleSecurityGroups": { "name": "DescribeStaleSecurityGroups", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeStaleSecurityGroupsRequest" }, "output": { "shape": "DescribeStaleSecurityGroupsResult" }, "documentation": "Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or peered VPC. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.
" }, "DescribeStoreImageTasks": { "name": "DescribeStoreImageTasks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeStoreImageTasksRequest" }, "output": { "shape": "DescribeStoreImageTasksResult" }, "documentation": "Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
" }, "DescribeSubnets": { "name": "DescribeSubnets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSubnetsRequest" }, "output": { "shape": "DescribeSubnetsResult" }, "documentation": "Describes one or more of your subnets.
For more information, see Subnets in the Amazon VPC User Guide.
" }, "DescribeTags": { "name": "DescribeTags", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTagsRequest" }, "output": { "shape": "DescribeTagsResult" }, "documentation": "Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
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.
Describes one or more Traffic Mirror filters.
" }, "DescribeTrafficMirrorSessions": { "name": "DescribeTrafficMirrorSessions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTrafficMirrorSessionsRequest" }, "output": { "shape": "DescribeTrafficMirrorSessionsResult" }, "documentation": "Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
" }, "DescribeTrafficMirrorTargets": { "name": "DescribeTrafficMirrorTargets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTrafficMirrorTargetsRequest" }, "output": { "shape": "DescribeTrafficMirrorTargetsResult" }, "documentation": "Information about one or more Traffic Mirror targets.
" }, "DescribeTransitGatewayAttachments": { "name": "DescribeTransitGatewayAttachments", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayAttachmentsRequest" }, "output": { "shape": "DescribeTransitGatewayAttachmentsResult" }, "documentation": "Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
" }, "DescribeTransitGatewayConnectPeers": { "name": "DescribeTransitGatewayConnectPeers", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayConnectPeersRequest" }, "output": { "shape": "DescribeTransitGatewayConnectPeersResult" }, "documentation": "Describes one or more Connect peers.
" }, "DescribeTransitGatewayConnects": { "name": "DescribeTransitGatewayConnects", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayConnectsRequest" }, "output": { "shape": "DescribeTransitGatewayConnectsResult" }, "documentation": "Describes one or more Connect attachments.
" }, "DescribeTransitGatewayMulticastDomains": { "name": "DescribeTransitGatewayMulticastDomains", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayMulticastDomainsRequest" }, "output": { "shape": "DescribeTransitGatewayMulticastDomainsResult" }, "documentation": "Describes one or more transit gateway multicast domains.
" }, "DescribeTransitGatewayPeeringAttachments": { "name": "DescribeTransitGatewayPeeringAttachments", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayPeeringAttachmentsRequest" }, "output": { "shape": "DescribeTransitGatewayPeeringAttachmentsResult" }, "documentation": "Describes your transit gateway peering attachments.
" }, "DescribeTransitGatewayPolicyTables": { "name": "DescribeTransitGatewayPolicyTables", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayPolicyTablesRequest" }, "output": { "shape": "DescribeTransitGatewayPolicyTablesResult" }, "documentation": "Describes one or more transit gateway route policy tables.
" }, "DescribeTransitGatewayRouteTableAnnouncements": { "name": "DescribeTransitGatewayRouteTableAnnouncements", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayRouteTableAnnouncementsRequest" }, "output": { "shape": "DescribeTransitGatewayRouteTableAnnouncementsResult" }, "documentation": "Describes one or more transit gateway route table advertisements.
" }, "DescribeTransitGatewayRouteTables": { "name": "DescribeTransitGatewayRouteTables", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayRouteTablesRequest" }, "output": { "shape": "DescribeTransitGatewayRouteTablesResult" }, "documentation": "Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.
" }, "DescribeTransitGatewayVpcAttachments": { "name": "DescribeTransitGatewayVpcAttachments", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewayVpcAttachmentsRequest" }, "output": { "shape": "DescribeTransitGatewayVpcAttachmentsResult" }, "documentation": "Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
" }, "DescribeTransitGateways": { "name": "DescribeTransitGateways", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTransitGatewaysRequest" }, "output": { "shape": "DescribeTransitGatewaysResult" }, "documentation": "Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
" }, "DescribeTrunkInterfaceAssociations": { "name": "DescribeTrunkInterfaceAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTrunkInterfaceAssociationsRequest" }, "output": { "shape": "DescribeTrunkInterfaceAssociationsResult" }, "documentation": "Describes one or more network interface trunk associations.
" }, "DescribeVerifiedAccessEndpoints": { "name": "DescribeVerifiedAccessEndpoints", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVerifiedAccessEndpointsRequest" }, "output": { "shape": "DescribeVerifiedAccessEndpointsResult" }, "documentation": "Describes the specified Amazon Web Services Verified Access endpoints.
" }, "DescribeVerifiedAccessGroups": { "name": "DescribeVerifiedAccessGroups", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVerifiedAccessGroupsRequest" }, "output": { "shape": "DescribeVerifiedAccessGroupsResult" }, "documentation": "Describes the specified Verified Access groups.
" }, "DescribeVerifiedAccessInstanceLoggingConfigurations": { "name": "DescribeVerifiedAccessInstanceLoggingConfigurations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVerifiedAccessInstanceLoggingConfigurationsRequest" }, "output": { "shape": "DescribeVerifiedAccessInstanceLoggingConfigurationsResult" }, "documentation": "Describes the specified Amazon Web Services Verified Access instances.
" }, "DescribeVerifiedAccessInstances": { "name": "DescribeVerifiedAccessInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVerifiedAccessInstancesRequest" }, "output": { "shape": "DescribeVerifiedAccessInstancesResult" }, "documentation": "Describes the specified Amazon Web Services Verified Access instances.
" }, "DescribeVerifiedAccessTrustProviders": { "name": "DescribeVerifiedAccessTrustProviders", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVerifiedAccessTrustProvidersRequest" }, "output": { "shape": "DescribeVerifiedAccessTrustProvidersResult" }, "documentation": "Describes the specified Amazon Web Services Verified Access trust providers.
" }, "DescribeVolumeAttribute": { "name": "DescribeVolumeAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVolumeAttributeRequest" }, "output": { "shape": "DescribeVolumeAttributeResult" }, "documentation": "Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
" }, "DescribeVolumeStatus": { "name": "DescribeVolumeStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVolumeStatusRequest" }, "output": { "shape": "DescribeVolumeStatusResult" }, "documentation": "Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon EBS User Guide.
Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
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.
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
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.
Describes the most recent volume modification request for the specified EBS volumes.
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.
" }, "DescribeVpcAttribute": { "name": "DescribeVpcAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcAttributeRequest" }, "output": { "shape": "DescribeVpcAttributeResult" }, "documentation": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
" }, "DescribeVpcClassicLink": { "name": "DescribeVpcClassicLink", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcClassicLinkRequest" }, "output": { "shape": "DescribeVpcClassicLinkResult" }, "documentation": "This action is deprecated.
Describes the ClassicLink status of the specified VPCs.
" }, "DescribeVpcClassicLinkDnsSupport": { "name": "DescribeVpcClassicLinkDnsSupport", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcClassicLinkDnsSupportRequest" }, "output": { "shape": "DescribeVpcClassicLinkDnsSupportResult" }, "documentation": "This action is deprecated.
Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.
" }, "DescribeVpcEndpointConnectionNotifications": { "name": "DescribeVpcEndpointConnectionNotifications", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcEndpointConnectionNotificationsRequest" }, "output": { "shape": "DescribeVpcEndpointConnectionNotificationsResult" }, "documentation": "Describes the connection notifications for VPC endpoints and VPC endpoint services.
" }, "DescribeVpcEndpointConnections": { "name": "DescribeVpcEndpointConnections", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcEndpointConnectionsRequest" }, "output": { "shape": "DescribeVpcEndpointConnectionsResult" }, "documentation": "Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
" }, "DescribeVpcEndpointServiceConfigurations": { "name": "DescribeVpcEndpointServiceConfigurations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcEndpointServiceConfigurationsRequest" }, "output": { "shape": "DescribeVpcEndpointServiceConfigurationsResult" }, "documentation": "Describes the VPC endpoint service configurations in your account (your services).
" }, "DescribeVpcEndpointServicePermissions": { "name": "DescribeVpcEndpointServicePermissions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcEndpointServicePermissionsRequest" }, "output": { "shape": "DescribeVpcEndpointServicePermissionsResult" }, "documentation": "Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
" }, "DescribeVpcEndpointServices": { "name": "DescribeVpcEndpointServices", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcEndpointServicesRequest" }, "output": { "shape": "DescribeVpcEndpointServicesResult" }, "documentation": "Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.
Describes your VPC endpoints.
" }, "DescribeVpcPeeringConnections": { "name": "DescribeVpcPeeringConnections", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcPeeringConnectionsRequest" }, "output": { "shape": "DescribeVpcPeeringConnectionsResult" }, "documentation": "Describes one or more of your VPC peering connections.
" }, "DescribeVpcs": { "name": "DescribeVpcs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcsRequest" }, "output": { "shape": "DescribeVpcsResult" }, "documentation": "Describes one or more of your VPCs.
" }, "DescribeVpnConnections": { "name": "DescribeVpnConnections", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpnConnectionsRequest" }, "output": { "shape": "DescribeVpnConnectionsResult" }, "documentation": "Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "DescribeVpnGateways": { "name": "DescribeVpnGateways", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpnGatewaysRequest" }, "output": { "shape": "DescribeVpnGatewaysResult" }, "documentation": "Describes one or more of your virtual private gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "DetachClassicLinkVpc": { "name": "DetachClassicLinkVpc", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetachClassicLinkVpcRequest" }, "output": { "shape": "DetachClassicLinkVpcResult" }, "documentation": "This action is deprecated.
Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
" }, "DetachInternetGateway": { "name": "DetachInternetGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetachInternetGatewayRequest" }, "documentation": "Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.
" }, "DetachNetworkInterface": { "name": "DetachNetworkInterface", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetachNetworkInterfaceRequest" }, "documentation": "Detaches a network interface from an instance.
" }, "DetachVerifiedAccessTrustProvider": { "name": "DetachVerifiedAccessTrustProvider", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetachVerifiedAccessTrustProviderRequest" }, "output": { "shape": "DetachVerifiedAccessTrustProviderResult" }, "documentation": "Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.
" }, "DetachVolume": { "name": "DetachVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetachVolumeRequest" }, "output": { "shape": "VolumeAttachment" }, "documentation": "Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
You can't detach or force detach volumes that are attached to Amazon ECS or Fargate tasks. Attempting to do this results in the UnsupportedOperationException exception with the Unable to detach volume attached to ECS tasks error message.
For more information, see Detach an Amazon EBS volume in the Amazon EBS User Guide.
" }, "DetachVpnGateway": { "name": "DetachVpnGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetachVpnGatewayRequest" }, "documentation": "Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.
Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
" }, "DisableAwsNetworkPerformanceMetricSubscription": { "name": "DisableAwsNetworkPerformanceMetricSubscription", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableAwsNetworkPerformanceMetricSubscriptionRequest" }, "output": { "shape": "DisableAwsNetworkPerformanceMetricSubscriptionResult" }, "documentation": "Disables Infrastructure Performance metric subscriptions.
" }, "DisableEbsEncryptionByDefault": { "name": "DisableEbsEncryptionByDefault", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableEbsEncryptionByDefaultRequest" }, "output": { "shape": "DisableEbsEncryptionByDefaultResult" }, "documentation": "Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
" }, "DisableFastLaunch": { "name": "DisableFastLaunch", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableFastLaunchRequest" }, "output": { "shape": "DisableFastLaunchResult" }, "documentation": "Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again.
You can only change these settings for Windows AMIs that you own or that have been shared with you.
Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
" }, "DisableImage": { "name": "DisableImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableImageRequest" }, "output": { "shape": "DisableImageResult" }, "documentation": "Sets the AMI state to disabled and removes all launch permissions from the AMI. A disabled AMI can't be used for instance launches.
A disabled AMI can't be shared. If an AMI was public or previously shared, it is made private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit, they lose access to the disabled AMI.
A disabled AMI does not appear in DescribeImages API calls by default.
Only the AMI owner can disable an AMI.
You can re-enable a disabled AMI using EnableImage.
For more information, see Disable an AMI in the Amazon EC2 User Guide.
" }, "DisableImageBlockPublicAccess": { "name": "DisableImageBlockPublicAccess", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableImageBlockPublicAccessRequest" }, "output": { "shape": "DisableImageBlockPublicAccessResult" }, "documentation": "Disables block public access for AMIs at the account level in the specified Amazon Web Services Region. This removes the block public access restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region.
The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be block-new-sharing. When the API has completed the configuration, the response will be unblocked.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
" }, "DisableImageDeprecation": { "name": "DisableImageDeprecation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableImageDeprecationRequest" }, "output": { "shape": "DisableImageDeprecationResult" }, "documentation": "Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
" }, "DisableImageDeregistrationProtection": { "name": "DisableImageDeregistrationProtection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableImageDeregistrationProtectionRequest" }, "output": { "shape": "DisableImageDeregistrationProtectionResult" }, "documentation": "Disables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered.
If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
" }, "DisableIpamOrganizationAdminAccount": { "name": "DisableIpamOrganizationAdminAccount", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableIpamOrganizationAdminAccountRequest" }, "output": { "shape": "DisableIpamOrganizationAdminAccountResult" }, "documentation": "Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
" }, "DisableSerialConsoleAccess": { "name": "DisableSerialConsoleAccess", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableSerialConsoleAccessRequest" }, "output": { "shape": "DisableSerialConsoleAccessResult" }, "documentation": "Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
" }, "DisableSnapshotBlockPublicAccess": { "name": "DisableSnapshotBlockPublicAccess", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableSnapshotBlockPublicAccessRequest" }, "output": { "shape": "DisableSnapshotBlockPublicAccessResult" }, "documentation": "Disables the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you disable block public access for snapshots in a Region, users can publicly share snapshots in that Region.
If block public access is enabled in block-all-sharing mode, and you disable block public access, all snapshots that were previously publicly shared are no longer treated as private and they become publicly accessible again.
For more information, see Block public access for snapshots in the Amazon EBS User Guide .
" }, "DisableTransitGatewayRouteTablePropagation": { "name": "DisableTransitGatewayRouteTablePropagation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableTransitGatewayRouteTablePropagationRequest" }, "output": { "shape": "DisableTransitGatewayRouteTablePropagationResult" }, "documentation": "Disables the specified resource attachment from propagating routes to the specified propagation route table.
" }, "DisableVgwRoutePropagation": { "name": "DisableVgwRoutePropagation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableVgwRoutePropagationRequest" }, "documentation": "Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
" }, "DisableVpcClassicLink": { "name": "DisableVpcClassicLink", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableVpcClassicLinkRequest" }, "output": { "shape": "DisableVpcClassicLinkResult" }, "documentation": "This action is deprecated.
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
" }, "DisableVpcClassicLinkDnsSupport": { "name": "DisableVpcClassicLinkDnsSupport", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableVpcClassicLinkDnsSupportRequest" }, "output": { "shape": "DisableVpcClassicLinkDnsSupportResult" }, "documentation": "This action is deprecated.
Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked.
You must specify a VPC ID in the request.
" }, "DisassociateAddress": { "name": "DisassociateAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateAddressRequest" }, "documentation": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" }, "DisassociateClientVpnTargetNetwork": { "name": "DisassociateClientVpnTargetNetwork", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateClientVpnTargetNetworkRequest" }, "output": { "shape": "DisassociateClientVpnTargetNetworkResult" }, "documentation": "Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint's status changes to pending-associate
Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate.
" }, "DisassociateIamInstanceProfile": { "name": "DisassociateIamInstanceProfile", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateIamInstanceProfileRequest" }, "output": { "shape": "DisassociateIamInstanceProfileResult" }, "documentation": "Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
" }, "DisassociateInstanceEventWindow": { "name": "DisassociateInstanceEventWindow", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateInstanceEventWindowRequest" }, "output": { "shape": "DisassociateInstanceEventWindowResult" }, "documentation": "Disassociates one or more targets from an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
" }, "DisassociateIpamByoasn": { "name": "DisassociateIpamByoasn", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateIpamByoasnRequest" }, "output": { "shape": "DisassociateIpamByoasnResult" }, "documentation": "Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
" }, "DisassociateIpamResourceDiscovery": { "name": "DisassociateIpamResourceDiscovery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateIpamResourceDiscoveryRequest" }, "output": { "shape": "DisassociateIpamResourceDiscoveryResult" }, "documentation": "Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
" }, "DisassociateNatGatewayAddress": { "name": "DisassociateNatGatewayAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateNatGatewayAddressRequest" }, "output": { "shape": "DisassociateNatGatewayAddressResult" }, "documentation": "Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.
An EIP is released only at the end of MaxDrainDurationSeconds. It stays associated and supports the existing connections but does not support any new connections (new connections are distributed across the remaining associated EIPs). As the existing connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) are released.
" }, "DisassociateRouteTable": { "name": "DisassociateRouteTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateRouteTableRequest" }, "documentation": "Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route tables in the Amazon VPC User Guide.
" }, "DisassociateSubnetCidrBlock": { "name": "DisassociateSubnetCidrBlock", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateSubnetCidrBlockRequest" }, "output": { "shape": "DisassociateSubnetCidrBlockResult" }, "documentation": "Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
" }, "DisassociateTransitGatewayMulticastDomain": { "name": "DisassociateTransitGatewayMulticastDomain", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateTransitGatewayMulticastDomainRequest" }, "output": { "shape": "DisassociateTransitGatewayMulticastDomainResult" }, "documentation": "Disassociates the specified subnets from the transit gateway multicast domain.
" }, "DisassociateTransitGatewayPolicyTable": { "name": "DisassociateTransitGatewayPolicyTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateTransitGatewayPolicyTableRequest" }, "output": { "shape": "DisassociateTransitGatewayPolicyTableResult" }, "documentation": "Removes the association between an an attachment and a policy table.
" }, "DisassociateTransitGatewayRouteTable": { "name": "DisassociateTransitGatewayRouteTable", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateTransitGatewayRouteTableRequest" }, "output": { "shape": "DisassociateTransitGatewayRouteTableResult" }, "documentation": "Disassociates a resource attachment from a transit gateway route table.
" }, "DisassociateTrunkInterface": { "name": "DisassociateTrunkInterface", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateTrunkInterfaceRequest" }, "output": { "shape": "DisassociateTrunkInterfaceResult" }, "documentation": "Removes an association between a branch network interface with a trunk network interface.
" }, "DisassociateVpcCidrBlock": { "name": "DisassociateVpcCidrBlock", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateVpcCidrBlockRequest" }, "output": { "shape": "DisassociateVpcCidrBlockResult" }, "documentation": "Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).
" }, "EnableAddressTransfer": { "name": "EnableAddressTransfer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableAddressTransferRequest" }, "output": { "shape": "EnableAddressTransferResult" }, "documentation": "Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
" }, "EnableAwsNetworkPerformanceMetricSubscription": { "name": "EnableAwsNetworkPerformanceMetricSubscription", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableAwsNetworkPerformanceMetricSubscriptionRequest" }, "output": { "shape": "EnableAwsNetworkPerformanceMetricSubscriptionResult" }, "documentation": "Enables Infrastructure Performance subscriptions.
" }, "EnableEbsEncryptionByDefault": { "name": "EnableEbsEncryptionByDefault", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableEbsEncryptionByDefaultRequest" }, "output": { "shape": "EnableEbsEncryptionByDefaultResult" }, "documentation": "Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
Enabling encryption by default has no effect on the encryption status of your existing volumes.
After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.
" }, "EnableFastLaunch": { "name": "EnableFastLaunch", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableFastLaunchRequest" }, "output": { "shape": "EnableFastLaunchResult" }, "documentation": "When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.
You can only change these settings for Windows AMIs that you own or that have been shared with you.
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.
For more information, see Amazon EBS fast snapshot restore in the Amazon EBS User Guide.
" }, "EnableImage": { "name": "EnableImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableImageRequest" }, "output": { "shape": "EnableImageResult" }, "documentation": "Re-enables a disabled AMI. The re-enabled AMI is marked as available and can be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services accounts, organizations, and Organizational Units that lost access to the AMI when it was disabled do not regain access automatically. Once the AMI is available, it can be shared with them again.
Only the AMI owner can re-enable a disabled AMI.
For more information, see Disable an AMI in the Amazon EC2 User Guide.
" }, "EnableImageBlockPublicAccess": { "name": "EnableImageBlockPublicAccess", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableImageBlockPublicAccessRequest" }, "output": { "shape": "EnableImageBlockPublicAccessResult" }, "documentation": "Enables block public access for AMIs at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available.
The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be unblocked. When the API has completed the configuration, the response will be block-new-sharing.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
" }, "EnableImageDeprecation": { "name": "EnableImageDeprecation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableImageDeprecationRequest" }, "output": { "shape": "EnableImageDeprecationResult" }, "documentation": "Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
" }, "EnableImageDeregistrationProtection": { "name": "EnableImageDeregistrationProtection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableImageDeregistrationProtectionRequest" }, "output": { "shape": "EnableImageDeregistrationProtectionResult" }, "documentation": "Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered.
To allow the AMI to be deregistered, you must first disable deregistration protection using DisableImageDeregistrationProtection.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
" }, "EnableIpamOrganizationAdminAccount": { "name": "EnableIpamOrganizationAdminAccount", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableIpamOrganizationAdminAccountRequest" }, "output": { "shape": "EnableIpamOrganizationAdminAccountResult" }, "documentation": "Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
" }, "EnableReachabilityAnalyzerOrganizationSharing": { "name": "EnableReachabilityAnalyzerOrganizationSharing", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableReachabilityAnalyzerOrganizationSharingRequest" }, "output": { "shape": "EnableReachabilityAnalyzerOrganizationSharingResult" }, "documentation": "Establishes a trust relationship between Reachability Analyzer and Organizations. This operation must be performed by the management account for the organization.
After you establish a trust relationship, a user in the management account or a delegated administrator account can run a cross-account analysis using resources from the member accounts.
" }, "EnableSerialConsoleAccess": { "name": "EnableSerialConsoleAccess", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableSerialConsoleAccessRequest" }, "output": { "shape": "EnableSerialConsoleAccessResult" }, "documentation": "Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
" }, "EnableSnapshotBlockPublicAccess": { "name": "EnableSnapshotBlockPublicAccess", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableSnapshotBlockPublicAccessRequest" }, "output": { "shape": "EnableSnapshotBlockPublicAccessResult" }, "documentation": "Enables or modifies the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you enable block public access for snapshots in a Region, users can no longer request public sharing for snapshots in that Region. Snapshots that are already publicly shared are either treated as private or they remain publicly shared, depending on the State that you specify.
If block public access is enabled in block-all-sharing mode, and you change the mode to block-new-sharing, all snapshots that were previously publicly shared are no longer treated as private and they become publicly accessible again.
For more information, see Block public access for snapshots in the Amazon EBS User Guide.
" }, "EnableTransitGatewayRouteTablePropagation": { "name": "EnableTransitGatewayRouteTablePropagation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableTransitGatewayRouteTablePropagationRequest" }, "output": { "shape": "EnableTransitGatewayRouteTablePropagationResult" }, "documentation": "Enables the specified attachment to propagate routes to the specified propagation route table.
" }, "EnableVgwRoutePropagation": { "name": "EnableVgwRoutePropagation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableVgwRoutePropagationRequest" }, "documentation": "Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
" }, "EnableVolumeIO": { "name": "EnableVolumeIO", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableVolumeIORequest" }, "documentation": "Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
" }, "EnableVpcClassicLink": { "name": "EnableVpcClassicLink", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableVpcClassicLinkRequest" }, "output": { "shape": "EnableVpcClassicLinkResult" }, "documentation": "This action is deprecated.
Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges.
This action is deprecated.
Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.
You must specify a VPC ID in the request.
" }, "ExportClientVpnClientCertificateRevocationList": { "name": "ExportClientVpnClientCertificateRevocationList", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportClientVpnClientCertificateRevocationListRequest" }, "output": { "shape": "ExportClientVpnClientCertificateRevocationListResult" }, "documentation": "Downloads the client certificate revocation list for the specified Client VPN endpoint.
" }, "ExportClientVpnClientConfiguration": { "name": "ExportClientVpnClientConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportClientVpnClientConfigurationRequest" }, "output": { "shape": "ExportClientVpnClientConfigurationResult" }, "documentation": "Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
" }, "ExportImage": { "name": "ExportImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportImageRequest" }, "output": { "shape": "ExportImageResult" }, "documentation": "Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.
" }, "ExportTransitGatewayRoutes": { "name": "ExportTransitGatewayRoutes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExportTransitGatewayRoutesRequest" }, "output": { "shape": "ExportTransitGatewayRoutesResult" }, "documentation": "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.
" }, "GetAssociatedEnclaveCertificateIamRoles": { "name": "GetAssociatedEnclaveCertificateIamRoles", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetAssociatedEnclaveCertificateIamRolesRequest" }, "output": { "shape": "GetAssociatedEnclaveCertificateIamRolesResult" }, "documentation": "Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that's used to encrypt the private key.
" }, "GetAssociatedIpv6PoolCidrs": { "name": "GetAssociatedIpv6PoolCidrs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetAssociatedIpv6PoolCidrsRequest" }, "output": { "shape": "GetAssociatedIpv6PoolCidrsResult" }, "documentation": "Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
" }, "GetAwsNetworkPerformanceData": { "name": "GetAwsNetworkPerformanceData", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetAwsNetworkPerformanceDataRequest" }, "output": { "shape": "GetAwsNetworkPerformanceDataResult" }, "documentation": "Gets network performance data.
" }, "GetCapacityReservationUsage": { "name": "GetCapacityReservationUsage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetCapacityReservationUsageRequest" }, "output": { "shape": "GetCapacityReservationUsageResult" }, "documentation": "Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
" }, "GetCoipPoolUsage": { "name": "GetCoipPoolUsage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetCoipPoolUsageRequest" }, "output": { "shape": "GetCoipPoolUsageResult" }, "documentation": "Describes the allocations from the specified customer-owned address pool.
" }, "GetConsoleOutput": { "name": "GetConsoleOutput", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetConsoleOutputRequest" }, "output": { "shape": "GetConsoleOutputResult" }, "documentation": "Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
" }, "GetConsoleScreenshot": { "name": "GetConsoleScreenshot", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetConsoleScreenshotRequest" }, "output": { "shape": "GetConsoleScreenshotResult" }, "documentation": "Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
For more information, see Instance console output in the Amazon EC2 User Guide.
" }, "GetDefaultCreditSpecification": { "name": "GetDefaultCreditSpecification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDefaultCreditSpecificationRequest" }, "output": { "shape": "GetDefaultCreditSpecificationResult" }, "documentation": "Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
" }, "GetEbsDefaultKmsKeyId": { "name": "GetEbsDefaultKmsKeyId", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEbsDefaultKmsKeyIdRequest" }, "output": { "shape": "GetEbsDefaultKmsKeyIdResult" }, "documentation": "Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
" }, "GetEbsEncryptionByDefault": { "name": "GetEbsEncryptionByDefault", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetEbsEncryptionByDefaultRequest" }, "output": { "shape": "GetEbsEncryptionByDefaultResult" }, "documentation": "Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
" }, "GetFlowLogsIntegrationTemplate": { "name": "GetFlowLogsIntegrationTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetFlowLogsIntegrationTemplateRequest" }, "output": { "shape": "GetFlowLogsIntegrationTemplateResult" }, "documentation": "Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:
Create a table in Athena that maps fields to a custom log format
Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis
Create a table partitioned between two timestamps in the past
Create a set of named queries in Athena that you can use to get started quickly
GetFlowLogsIntegrationTemplate does not support integration between Amazon Web Services Transit Gateway Flow Logs and Amazon Athena.
Lists the resource groups to which a Capacity Reservation has been added.
" }, "GetHostReservationPurchasePreview": { "name": "GetHostReservationPurchasePreview", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetHostReservationPurchasePreviewRequest" }, "output": { "shape": "GetHostReservationPurchasePreviewResult" }, "documentation": "Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
" }, "GetImageBlockPublicAccessState": { "name": "GetImageBlockPublicAccessState", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetImageBlockPublicAccessStateRequest" }, "output": { "shape": "GetImageBlockPublicAccessStateResult" }, "documentation": "Gets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
" }, "GetInstanceMetadataDefaults": { "name": "GetInstanceMetadataDefaults", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetInstanceMetadataDefaultsRequest" }, "output": { "shape": "GetInstanceMetadataDefaultsResult" }, "documentation": "Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified Amazon Web Services Region.
For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
" }, "GetInstanceTypesFromInstanceRequirements": { "name": "GetInstanceTypesFromInstanceRequirements", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetInstanceTypesFromInstanceRequirementsRequest" }, "output": { "shape": "GetInstanceTypesFromInstanceRequirementsResult" }, "documentation": "Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
" }, "GetInstanceUefiData": { "name": "GetInstanceUefiData", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetInstanceUefiDataRequest" }, "output": { "shape": "GetInstanceUefiDataResult" }, "documentation": "A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.
When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.
For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
" }, "GetIpamAddressHistory": { "name": "GetIpamAddressHistory", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIpamAddressHistoryRequest" }, "output": { "shape": "GetIpamAddressHistoryResult" }, "documentation": "Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.
" }, "GetIpamDiscoveredAccounts": { "name": "GetIpamDiscoveredAccounts", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIpamDiscoveredAccountsRequest" }, "output": { "shape": "GetIpamDiscoveredAccountsResult" }, "documentation": "Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.
" }, "GetIpamDiscoveredPublicAddresses": { "name": "GetIpamDiscoveredPublicAddresses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIpamDiscoveredPublicAddressesRequest" }, "output": { "shape": "GetIpamDiscoveredPublicAddressesResult" }, "documentation": "Gets the public IP addresses that have been discovered by IPAM.
" }, "GetIpamDiscoveredResourceCidrs": { "name": "GetIpamDiscoveredResourceCidrs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIpamDiscoveredResourceCidrsRequest" }, "output": { "shape": "GetIpamDiscoveredResourceCidrsResult" }, "documentation": "Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.
" }, "GetIpamPoolAllocations": { "name": "GetIpamPoolAllocations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIpamPoolAllocationsRequest" }, "output": { "shape": "GetIpamPoolAllocationsResult" }, "documentation": "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.
Get the CIDRs provisioned to an IPAM pool.
" }, "GetIpamResourceCidrs": { "name": "GetIpamResourceCidrs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIpamResourceCidrsRequest" }, "output": { "shape": "GetIpamResourceCidrsResult" }, "documentation": "Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
" }, "GetLaunchTemplateData": { "name": "GetLaunchTemplateData", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetLaunchTemplateDataRequest" }, "output": { "shape": "GetLaunchTemplateDataResult" }, "documentation": "Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, and DescribeInstanceAttribute. Or, you can allow describe* depending on your instance requirements.
Gets information about the resources that are associated with the specified managed prefix list.
" }, "GetManagedPrefixListEntries": { "name": "GetManagedPrefixListEntries", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetManagedPrefixListEntriesRequest" }, "output": { "shape": "GetManagedPrefixListEntriesResult" }, "documentation": "Gets information about the entries for a specified managed prefix list.
" }, "GetNetworkInsightsAccessScopeAnalysisFindings": { "name": "GetNetworkInsightsAccessScopeAnalysisFindings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetNetworkInsightsAccessScopeAnalysisFindingsRequest" }, "output": { "shape": "GetNetworkInsightsAccessScopeAnalysisFindingsResult" }, "documentation": "Gets the findings for the specified Network Access Scope analysis.
" }, "GetNetworkInsightsAccessScopeContent": { "name": "GetNetworkInsightsAccessScopeContent", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetNetworkInsightsAccessScopeContentRequest" }, "output": { "shape": "GetNetworkInsightsAccessScopeContentResult" }, "documentation": "Gets the content for the specified Network Access Scope.
" }, "GetPasswordData": { "name": "GetPasswordData", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetPasswordDataRequest" }, "output": { "shape": "GetPasswordDataResult" }, "documentation": "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 Amazon EC2 User Guide.
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
" }, "GetReservedInstancesExchangeQuote": { "name": "GetReservedInstancesExchangeQuote", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetReservedInstancesExchangeQuoteRequest" }, "output": { "shape": "GetReservedInstancesExchangeQuoteResult" }, "documentation": "Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.
" }, "GetSecurityGroupsForVpc": { "name": "GetSecurityGroupsForVpc", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetSecurityGroupsForVpcRequest" }, "output": { "shape": "GetSecurityGroupsForVpcResult" }, "documentation": "Gets security groups that can be associated by the Amazon Web Services account making the request with network interfaces in the specified VPC.
" }, "GetSerialConsoleAccessStatus": { "name": "GetSerialConsoleAccessStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetSerialConsoleAccessStatusRequest" }, "output": { "shape": "GetSerialConsoleAccessStatusResult" }, "documentation": "Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
" }, "GetSnapshotBlockPublicAccessState": { "name": "GetSnapshotBlockPublicAccessState", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetSnapshotBlockPublicAccessStateRequest" }, "output": { "shape": "GetSnapshotBlockPublicAccessStateResult" }, "documentation": "Gets the current state of block public access for snapshots setting for the account and Region.
For more information, see Block public access for snapshots in the Amazon EBS User Guide.
" }, "GetSpotPlacementScores": { "name": "GetSpotPlacementScores", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetSpotPlacementScoresRequest" }, "output": { "shape": "GetSpotPlacementScoresResult" }, "documentation": "Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.
You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.
For more information, see Spot placement score in the Amazon EC2 User Guide.
" }, "GetSubnetCidrReservations": { "name": "GetSubnetCidrReservations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetSubnetCidrReservationsRequest" }, "output": { "shape": "GetSubnetCidrReservationsResult" }, "documentation": "Gets information about the subnet CIDR reservations.
" }, "GetTransitGatewayAttachmentPropagations": { "name": "GetTransitGatewayAttachmentPropagations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTransitGatewayAttachmentPropagationsRequest" }, "output": { "shape": "GetTransitGatewayAttachmentPropagationsResult" }, "documentation": "Lists the route tables to which the specified resource attachment propagates routes.
" }, "GetTransitGatewayMulticastDomainAssociations": { "name": "GetTransitGatewayMulticastDomainAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTransitGatewayMulticastDomainAssociationsRequest" }, "output": { "shape": "GetTransitGatewayMulticastDomainAssociationsResult" }, "documentation": "Gets information about the associations for the transit gateway multicast domain.
" }, "GetTransitGatewayPolicyTableAssociations": { "name": "GetTransitGatewayPolicyTableAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTransitGatewayPolicyTableAssociationsRequest" }, "output": { "shape": "GetTransitGatewayPolicyTableAssociationsResult" }, "documentation": "Gets a list of the transit gateway policy table associations.
" }, "GetTransitGatewayPolicyTableEntries": { "name": "GetTransitGatewayPolicyTableEntries", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTransitGatewayPolicyTableEntriesRequest" }, "output": { "shape": "GetTransitGatewayPolicyTableEntriesResult" }, "documentation": "Returns a list of transit gateway policy table entries.
" }, "GetTransitGatewayPrefixListReferences": { "name": "GetTransitGatewayPrefixListReferences", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTransitGatewayPrefixListReferencesRequest" }, "output": { "shape": "GetTransitGatewayPrefixListReferencesResult" }, "documentation": "Gets information about the prefix list references in a specified transit gateway route table.
" }, "GetTransitGatewayRouteTableAssociations": { "name": "GetTransitGatewayRouteTableAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTransitGatewayRouteTableAssociationsRequest" }, "output": { "shape": "GetTransitGatewayRouteTableAssociationsResult" }, "documentation": "Gets information about the associations for the specified transit gateway route table.
" }, "GetTransitGatewayRouteTablePropagations": { "name": "GetTransitGatewayRouteTablePropagations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTransitGatewayRouteTablePropagationsRequest" }, "output": { "shape": "GetTransitGatewayRouteTablePropagationsResult" }, "documentation": "Gets information about the route table propagations for the specified transit gateway route table.
" }, "GetVerifiedAccessEndpointPolicy": { "name": "GetVerifiedAccessEndpointPolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetVerifiedAccessEndpointPolicyRequest" }, "output": { "shape": "GetVerifiedAccessEndpointPolicyResult" }, "documentation": "Get the Verified Access policy associated with the endpoint.
" }, "GetVerifiedAccessGroupPolicy": { "name": "GetVerifiedAccessGroupPolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetVerifiedAccessGroupPolicyRequest" }, "output": { "shape": "GetVerifiedAccessGroupPolicyResult" }, "documentation": "Shows the contents of the Verified Access policy associated with the group.
" }, "GetVpnConnectionDeviceSampleConfiguration": { "name": "GetVpnConnectionDeviceSampleConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetVpnConnectionDeviceSampleConfigurationRequest" }, "output": { "shape": "GetVpnConnectionDeviceSampleConfigurationResult" }, "documentation": "Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
" }, "GetVpnConnectionDeviceTypes": { "name": "GetVpnConnectionDeviceTypes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetVpnConnectionDeviceTypesRequest" }, "output": { "shape": "GetVpnConnectionDeviceTypesResult" }, "documentation": "Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "GetVpnTunnelReplacementStatus": { "name": "GetVpnTunnelReplacementStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetVpnTunnelReplacementStatusRequest" }, "output": { "shape": "GetVpnTunnelReplacementStatusResult" }, "documentation": "Get details of available tunnel endpoint maintenance.
" }, "ImportClientVpnClientCertificateRevocationList": { "name": "ImportClientVpnClientCertificateRevocationList", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ImportClientVpnClientCertificateRevocationListRequest" }, "output": { "shape": "ImportClientVpnClientCertificateRevocationListResult" }, "documentation": "Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
" }, "ImportImage": { "name": "ImportImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ImportImageRequest" }, "output": { "shape": "ImportImageResult" }, "documentation": "To import your virtual machines (VMs) with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide .
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
" }, "ImportInstance": { "name": "ImportInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ImportInstanceRequest" }, "output": { "shape": "ImportInstanceResult" }, "documentation": "We recommend that you use the ImportImage API. For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
Creates an import instance task using metadata from the specified disk image.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
For information about the import manifest referenced by this API action, see VM Import Manifest.
" }, "ImportKeyPair": { "name": "ImportKeyPair", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ImportKeyPairRequest" }, "output": { "shape": "ImportKeyPairResult" }, "documentation": "Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
" }, "ImportSnapshot": { "name": "ImportSnapshot", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ImportSnapshotRequest" }, "output": { "shape": "ImportSnapshotResult" }, "documentation": "Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
" }, "ImportVolume": { "name": "ImportVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ImportVolumeRequest" }, "output": { "shape": "ImportVolumeResult" }, "documentation": "Creates an import volume task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
" }, "ListImagesInRecycleBin": { "name": "ListImagesInRecycleBin", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListImagesInRecycleBinRequest" }, "output": { "shape": "ListImagesInRecycleBinResult" }, "documentation": "Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
" }, "ListSnapshotsInRecycleBin": { "name": "ListSnapshotsInRecycleBin", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListSnapshotsInRecycleBinRequest" }, "output": { "shape": "ListSnapshotsInRecycleBinResult" }, "documentation": "Lists one or more snapshots that are currently in the Recycle Bin.
" }, "LockSnapshot": { "name": "LockSnapshot", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "LockSnapshotRequest" }, "output": { "shape": "LockSnapshotResult" }, "documentation": "Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot can't be deleted.
You can also use this action to modify the lock settings for a snapshot that is already locked. The allowed modifications depend on the lock mode and lock state:
If the snapshot is locked in governance mode, you can modify the lock mode and the lock duration or lock expiration date.
If the snapshot is locked in compliance mode and it is in the cooling-off period, you can modify the lock mode and the lock duration or lock expiration date.
If the snapshot is locked in compliance mode and the cooling-off period has lapsed, you can only increase the lock duration or extend the lock expiration date.
Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.
" }, "ModifyAvailabilityZoneGroup": { "name": "ModifyAvailabilityZoneGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyAvailabilityZoneGroupRequest" }, "output": { "shape": "ModifyAvailabilityZoneGroupResult" }, "documentation": "Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for GroupName.
Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.
" }, "ModifyCapacityReservationFleet": { "name": "ModifyCapacityReservationFleet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyCapacityReservationFleetRequest" }, "output": { "shape": "ModifyCapacityReservationFleetResult" }, "documentation": "Modifies a Capacity Reservation Fleet.
When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.
" }, "ModifyClientVpnEndpoint": { "name": "ModifyClientVpnEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyClientVpnEndpointRequest" }, "output": { "shape": "ModifyClientVpnEndpointResult" }, "documentation": "Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
" }, "ModifyDefaultCreditSpecification": { "name": "ModifyDefaultCreditSpecification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyDefaultCreditSpecificationRequest" }, "output": { "shape": "ModifyDefaultCreditSpecificationResult" }, "documentation": "Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
" }, "ModifyEbsDefaultKmsKeyId": { "name": "ModifyEbsDefaultKmsKeyId", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyEbsDefaultKmsKeyIdRequest" }, "output": { "shape": "ModifyEbsDefaultKmsKeyIdResult" }, "documentation": "Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
" }, "ModifyFleet": { "name": "ModifyFleet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyFleetRequest" }, "output": { "shape": "ModifyFleetResult" }, "documentation": "Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type maintain.
While the EC2 Fleet is being modified, it is in the modifying state.
To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.
" }, "ModifyFpgaImageAttribute": { "name": "ModifyFpgaImageAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyFpgaImageAttributeRequest" }, "output": { "shape": "ModifyFpgaImageAttributeResult" }, "documentation": "Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
" }, "ModifyHosts": { "name": "ModifyHosts", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyHostsRequest" }, "output": { "shape": "ModifyHostsResult" }, "documentation": "Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
" }, "ModifyIdFormat": { "name": "ModifyIdFormat", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyIdFormatRequest" }, "documentation": "Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
To specify the attribute, you can use the Attribute parameter, or one of the following parameters: Description, ImdsSupport, or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
" }, "ModifyInstanceAttribute": { "name": "ModifyInstanceAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyInstanceAttributeRequest" }, "documentation": "Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.
" }, "ModifyInstanceCapacityReservationAttributes": { "name": "ModifyInstanceCapacityReservationAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyInstanceCapacityReservationAttributesRequest" }, "output": { "shape": "ModifyInstanceCapacityReservationAttributesResult" }, "documentation": "Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.
Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
" }, "ModifyInstanceEventStartTime": { "name": "ModifyInstanceEventStartTime", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyInstanceEventStartTimeRequest" }, "output": { "shape": "ModifyInstanceEventStartTimeResult" }, "documentation": "Modifies the start time for a scheduled Amazon EC2 instance event.
" }, "ModifyInstanceEventWindow": { "name": "ModifyInstanceEventWindow", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyInstanceEventWindowRequest" }, "output": { "shape": "ModifyInstanceEventWindowResult" }, "documentation": "Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
" }, "ModifyInstanceMaintenanceOptions": { "name": "ModifyInstanceMaintenanceOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyInstanceMaintenanceOptionsRequest" }, "output": { "shape": "ModifyInstanceMaintenanceOptionsResult" }, "documentation": "Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
" }, "ModifyInstanceMetadataDefaults": { "name": "ModifyInstanceMetadataDefaults", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyInstanceMetadataDefaultsRequest" }, "output": { "shape": "ModifyInstanceMetadataDefaultsResult" }, "documentation": "Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. If an account-level setting is cleared with no-preference, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
" }, "ModifyInstancePlacement": { "name": "ModifyInstancePlacement", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyInstancePlacementRequest" }, "output": { "shape": "ModifyInstancePlacementResult" }, "documentation": "Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is started, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.
Modify the configurations of an IPAM.
" }, "ModifyIpamPool": { "name": "ModifyIpamPool", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyIpamPoolRequest" }, "output": { "shape": "ModifyIpamPoolResult" }, "documentation": "Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
" }, "ModifyIpamResourceCidr": { "name": "ModifyIpamResourceCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyIpamResourceCidrRequest" }, "output": { "shape": "ModifyIpamResourceCidrResult" }, "documentation": "Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.
For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.
" }, "ModifyIpamResourceDiscovery": { "name": "ModifyIpamResourceDiscovery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyIpamResourceDiscoveryRequest" }, "output": { "shape": "ModifyIpamResourceDiscoveryResult" }, "documentation": "Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
" }, "ModifyIpamScope": { "name": "ModifyIpamScope", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyIpamScopeRequest" }, "output": { "shape": "ModifyIpamScopeResult" }, "documentation": "Modify an IPAM scope.
" }, "ModifyLaunchTemplate": { "name": "ModifyLaunchTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyLaunchTemplateRequest" }, "output": { "shape": "ModifyLaunchTemplateResult" }, "documentation": "Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.
" }, "ModifyLocalGatewayRoute": { "name": "ModifyLocalGatewayRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyLocalGatewayRouteRequest" }, "output": { "shape": "ModifyLocalGatewayRouteResult" }, "documentation": "Modifies the specified local gateway route.
" }, "ModifyManagedPrefixList": { "name": "ModifyManagedPrefixList", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyManagedPrefixListRequest" }, "output": { "shape": "ModifyManagedPrefixListResult" }, "documentation": "Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
" }, "ModifyNetworkInterfaceAttribute": { "name": "ModifyNetworkInterfaceAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyNetworkInterfaceAttributeRequest" }, "documentation": "Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.
" }, "ModifyPrivateDnsNameOptions": { "name": "ModifyPrivateDnsNameOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyPrivateDnsNameOptionsRequest" }, "output": { "shape": "ModifyPrivateDnsNameOptionsResult" }, "documentation": "Modifies the options for instance hostnames for the specified instance.
" }, "ModifyReservedInstances": { "name": "ModifyReservedInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyReservedInstancesRequest" }, "output": { "shape": "ModifyReservedInstancesResult" }, "documentation": "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.
" }, "ModifySecurityGroupRules": { "name": "ModifySecurityGroupRules", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifySecurityGroupRulesRequest" }, "output": { "shape": "ModifySecurityGroupRulesResult" }, "documentation": "Modifies the rules of a security group.
" }, "ModifySnapshotAttribute": { "name": "ModifySnapshotAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifySnapshotAttributeRequest" }, "documentation": "Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.
" }, "ModifySnapshotTier": { "name": "ModifySnapshotTier", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifySnapshotTierRequest" }, "output": { "shape": "ModifySnapshotTierResult" }, "documentation": "Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon EBS User Guide.
" }, "ModifySpotFleetRequest": { "name": "ModifySpotFleetRequest", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifySpotFleetRequestRequest" }, "output": { "shape": "ModifySpotFleetRequestResponse" }, "documentation": "Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type maintain.
While the Spot Fleet request is being modified, it is in the modifying state.
To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.
" }, "ModifySubnetAttribute": { "name": "ModifySubnetAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifySubnetAttributeRequest" }, "documentation": "Modifies a subnet attribute. You can only modify one attribute at a time.
Use this action to modify subnets on Amazon Web Services Outposts.
To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute.
To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
" }, "ModifyTrafficMirrorFilterNetworkServices": { "name": "ModifyTrafficMirrorFilterNetworkServices", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyTrafficMirrorFilterNetworkServicesRequest" }, "output": { "shape": "ModifyTrafficMirrorFilterNetworkServicesResult" }, "documentation": "Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.
Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
Modifies a Traffic Mirror session.
" }, "ModifyTransitGateway": { "name": "ModifyTransitGateway", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyTransitGatewayRequest" }, "output": { "shape": "ModifyTransitGatewayResult" }, "documentation": "Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.
" }, "ModifyTransitGatewayPrefixListReference": { "name": "ModifyTransitGatewayPrefixListReference", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyTransitGatewayPrefixListReferenceRequest" }, "output": { "shape": "ModifyTransitGatewayPrefixListReferenceResult" }, "documentation": "Modifies a reference (route) to a prefix list in a specified transit gateway route table.
" }, "ModifyTransitGatewayVpcAttachment": { "name": "ModifyTransitGatewayVpcAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyTransitGatewayVpcAttachmentRequest" }, "output": { "shape": "ModifyTransitGatewayVpcAttachmentResult" }, "documentation": "Modifies the specified VPC attachment.
" }, "ModifyVerifiedAccessEndpoint": { "name": "ModifyVerifiedAccessEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVerifiedAccessEndpointRequest" }, "output": { "shape": "ModifyVerifiedAccessEndpointResult" }, "documentation": "Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.
" }, "ModifyVerifiedAccessEndpointPolicy": { "name": "ModifyVerifiedAccessEndpointPolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVerifiedAccessEndpointPolicyRequest" }, "output": { "shape": "ModifyVerifiedAccessEndpointPolicyResult" }, "documentation": "Modifies the specified Amazon Web Services Verified Access endpoint policy.
" }, "ModifyVerifiedAccessGroup": { "name": "ModifyVerifiedAccessGroup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVerifiedAccessGroupRequest" }, "output": { "shape": "ModifyVerifiedAccessGroupResult" }, "documentation": "Modifies the specified Amazon Web Services Verified Access group configuration.
" }, "ModifyVerifiedAccessGroupPolicy": { "name": "ModifyVerifiedAccessGroupPolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVerifiedAccessGroupPolicyRequest" }, "output": { "shape": "ModifyVerifiedAccessGroupPolicyResult" }, "documentation": "Modifies the specified Amazon Web Services Verified Access group policy.
" }, "ModifyVerifiedAccessInstance": { "name": "ModifyVerifiedAccessInstance", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVerifiedAccessInstanceRequest" }, "output": { "shape": "ModifyVerifiedAccessInstanceResult" }, "documentation": "Modifies the configuration of the specified Amazon Web Services Verified Access instance.
" }, "ModifyVerifiedAccessInstanceLoggingConfiguration": { "name": "ModifyVerifiedAccessInstanceLoggingConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVerifiedAccessInstanceLoggingConfigurationRequest" }, "output": { "shape": "ModifyVerifiedAccessInstanceLoggingConfigurationResult" }, "documentation": "Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.
" }, "ModifyVerifiedAccessTrustProvider": { "name": "ModifyVerifiedAccessTrustProvider", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVerifiedAccessTrustProviderRequest" }, "output": { "shape": "ModifyVerifiedAccessTrustProviderResult" }, "documentation": "Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.
" }, "ModifyVolume": { "name": "ModifyVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVolumeRequest" }, "output": { "shape": "ModifyVolumeResult" }, "documentation": "You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes in the Amazon EBS User Guide.
When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For more information, see Extend the file system.
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.
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 is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
" }, "ModifyVpcAttribute": { "name": "ModifyVpcAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpcAttributeRequest" }, "documentation": "Modifies the specified attribute of the specified VPC.
" }, "ModifyVpcEndpoint": { "name": "ModifyVpcEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpcEndpointRequest" }, "output": { "shape": "ModifyVpcEndpointResult" }, "documentation": "Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.
" }, "ModifyVpcEndpointConnectionNotification": { "name": "ModifyVpcEndpointConnectionNotification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpcEndpointConnectionNotificationRequest" }, "output": { "shape": "ModifyVpcEndpointConnectionNotificationResult" }, "documentation": "Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.
" }, "ModifyVpcEndpointServiceConfiguration": { "name": "ModifyVpcEndpointServiceConfiguration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpcEndpointServiceConfigurationRequest" }, "output": { "shape": "ModifyVpcEndpointServiceConfigurationResult" }, "documentation": "Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
" }, "ModifyVpcEndpointServicePayerResponsibility": { "name": "ModifyVpcEndpointServicePayerResponsibility", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpcEndpointServicePayerResponsibilityRequest" }, "output": { "shape": "ModifyVpcEndpointServicePayerResponsibilityResult" }, "documentation": "Modifies the payer responsibility for your VPC endpoint service.
" }, "ModifyVpcEndpointServicePermissions": { "name": "ModifyVpcEndpointServicePermissions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpcEndpointServicePermissionsRequest" }, "output": { "shape": "ModifyVpcEndpointServicePermissionsResult" }, "documentation": "Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
" }, "ModifyVpcPeeringConnectionOptions": { "name": "ModifyVpcPeeringConnectionOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpcPeeringConnectionOptionsRequest" }, "output": { "shape": "ModifyVpcPeeringConnectionOptionsResult" }, "documentation": "Modifies the VPC peering connection options on one side of a VPC peering connection.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
" }, "ModifyVpcTenancy": { "name": "ModifyVpcTenancy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpcTenancyRequest" }, "output": { "shape": "ModifyVpcTenancyResult" }, "documentation": "Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the Amazon EC2 User Guide.
" }, "ModifyVpnConnection": { "name": "ModifyVpnConnection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpnConnectionRequest" }, "output": { "shape": "ModifyVpnConnectionResult" }, "documentation": "Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
" }, "ModifyVpnConnectionOptions": { "name": "ModifyVpnConnectionOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpnConnectionOptionsRequest" }, "output": { "shape": "ModifyVpnConnectionOptionsResult" }, "documentation": "Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
" }, "ModifyVpnTunnelCertificate": { "name": "ModifyVpnTunnelCertificate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpnTunnelCertificateRequest" }, "output": { "shape": "ModifyVpnTunnelCertificateResult" }, "documentation": "Modifies the VPN tunnel endpoint certificate.
" }, "ModifyVpnTunnelOptions": { "name": "ModifyVpnTunnelOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyVpnTunnelOptionsRequest" }, "output": { "shape": "ModifyVpnTunnelOptionsResult" }, "documentation": "Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "MonitorInstances": { "name": "MonitorInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "MonitorInstancesRequest" }, "output": { "shape": "MonitorInstancesResult" }, "documentation": "Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
" }, "MoveAddressToVpc": { "name": "MoveAddressToVpc", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "MoveAddressToVpcRequest" }, "output": { "shape": "MoveAddressToVpcResult" }, "documentation": "This action is deprecated.
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
" }, "MoveByoipCidrToIpam": { "name": "MoveByoipCidrToIpam", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "MoveByoipCidrToIpamRequest" }, "output": { "shape": "MoveByoipCidrToIpamResult" }, "documentation": "Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.
If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
" }, "ProvisionByoipCidr": { "name": "ProvisionByoipCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ProvisionByoipCidrRequest" }, "output": { "shape": "ProvisionByoipCidrResult" }, "documentation": "Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
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.
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. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
" }, "ProvisionIpamPoolCidr": { "name": "ProvisionIpamPoolCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ProvisionIpamPoolCidrRequest" }, "output": { "shape": "ProvisionIpamPoolCidrResult" }, "documentation": "Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.
" }, "ProvisionPublicIpv4PoolCidr": { "name": "ProvisionPublicIpv4PoolCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ProvisionPublicIpv4PoolCidrRequest" }, "output": { "shape": "ProvisionPublicIpv4PoolCidrResult" }, "documentation": "Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "PurchaseCapacityBlock": { "name": "PurchaseCapacityBlock", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PurchaseCapacityBlockRequest" }, "output": { "shape": "PurchaseCapacityBlockResult" }, "documentation": "Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing.
" }, "PurchaseHostReservation": { "name": "PurchaseHostReservation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PurchaseHostReservationRequest" }, "output": { "shape": "PurchaseHostReservationResult" }, "documentation": "Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.
" }, "PurchaseReservedInstancesOffering": { "name": "PurchaseReservedInstancesOffering", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PurchaseReservedInstancesOfferingRequest" }, "output": { "shape": "PurchaseReservedInstancesOfferingResult" }, "documentation": "Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your 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.
" }, "PurchaseScheduledInstances": { "name": "PurchaseScheduledInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PurchaseScheduledInstancesRequest" }, "output": { "shape": "PurchaseScheduledInstancesResult" }, "documentation": "You can no longer purchase Scheduled Instances.
Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.
" }, "RebootInstances": { "name": "RebootInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RebootInstancesRequest" }, "documentation": "Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.
" }, "RegisterImage": { "name": "RegisterImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterImageRequest" }, "output": { "shape": "RegisterImageResult" }, "documentation": "Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI is the final step in the creation process. For more information about creating AMIs, see Create your own AMI in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. We recommend that you always use CreateImage unless you have a specific reason to use RegisterImage.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understand AMI billing information in the Amazon EC2 User Guide.
" }, "RegisterInstanceEventNotificationAttributes": { "name": "RegisterInstanceEventNotificationAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterInstanceEventNotificationAttributesRequest" }, "output": { "shape": "RegisterInstanceEventNotificationAttributesResult" }, "documentation": "Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
" }, "RegisterTransitGatewayMulticastGroupMembers": { "name": "RegisterTransitGatewayMulticastGroupMembers", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterTransitGatewayMulticastGroupMembersRequest" }, "output": { "shape": "RegisterTransitGatewayMulticastGroupMembersResult" }, "documentation": "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.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
" }, "RegisterTransitGatewayMulticastGroupSources": { "name": "RegisterTransitGatewayMulticastGroupSources", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterTransitGatewayMulticastGroupSourcesRequest" }, "output": { "shape": "RegisterTransitGatewayMulticastGroupSourcesResult" }, "documentation": "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.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
" }, "RejectTransitGatewayMulticastDomainAssociations": { "name": "RejectTransitGatewayMulticastDomainAssociations", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RejectTransitGatewayMulticastDomainAssociationsRequest" }, "output": { "shape": "RejectTransitGatewayMulticastDomainAssociationsResult" }, "documentation": "Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
" }, "RejectTransitGatewayPeeringAttachment": { "name": "RejectTransitGatewayPeeringAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RejectTransitGatewayPeeringAttachmentRequest" }, "output": { "shape": "RejectTransitGatewayPeeringAttachmentResult" }, "documentation": "Rejects a transit gateway peering attachment request.
" }, "RejectTransitGatewayVpcAttachment": { "name": "RejectTransitGatewayVpcAttachment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RejectTransitGatewayVpcAttachmentRequest" }, "output": { "shape": "RejectTransitGatewayVpcAttachmentResult" }, "documentation": "Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.
Rejects VPC endpoint connection requests to your VPC endpoint service.
" }, "RejectVpcPeeringConnection": { "name": "RejectVpcPeeringConnection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RejectVpcPeeringConnectionRequest" }, "output": { "shape": "RejectVpcPeeringConnectionResult" }, "documentation": "Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.
Releases the specified Elastic IP address.
[Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.
After you release an Elastic IP address, you might be able to recover it. For more information, see AllocateAddress.
" }, "ReleaseHosts": { "name": "ReleaseHosts", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReleaseHostsRequest" }, "output": { "shape": "ReleaseHostsResult" }, "documentation": "When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
" }, "ReleaseIpamPoolAllocation": { "name": "ReleaseIpamPoolAllocation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReleaseIpamPoolAllocationRequest" }, "output": { "shape": "ReleaseIpamPoolAllocationResult" }, "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.
All EC2 API actions follow an eventual consistency model.
Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
" }, "ReplaceNetworkAclAssociation": { "name": "ReplaceNetworkAclAssociation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReplaceNetworkAclAssociationRequest" }, "output": { "shape": "ReplaceNetworkAclAssociationResult" }, "documentation": "Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.
This is an idempotent operation.
" }, "ReplaceNetworkAclEntry": { "name": "ReplaceNetworkAclEntry", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReplaceNetworkAclEntryRequest" }, "documentation": "Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.
" }, "ReplaceRoute": { "name": "ReplaceRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReplaceRouteRequest" }, "documentation": "Replaces an existing route within a route table in a VPC.
You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target.
For more information, see Route tables in the Amazon VPC User Guide.
" }, "ReplaceRouteTableAssociation": { "name": "ReplaceRouteTableAssociation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReplaceRouteTableAssociationRequest" }, "output": { "shape": "ReplaceRouteTableAssociationResult" }, "documentation": "Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon VPC User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.
" }, "ReplaceTransitGatewayRoute": { "name": "ReplaceTransitGatewayRoute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReplaceTransitGatewayRouteRequest" }, "output": { "shape": "ReplaceTransitGatewayRouteResult" }, "documentation": "Replaces the specified route in the specified transit gateway route table.
" }, "ReplaceVpnTunnel": { "name": "ReplaceVpnTunnel", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReplaceVpnTunnelRequest" }, "output": { "shape": "ReplaceVpnTunnelResult" }, "documentation": "Trigger replacement of specified VPN tunnel.
" }, "ReportInstanceStatus": { "name": "ReportInstanceStatus", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReportInstanceStatusRequest" }, "documentation": "Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
" }, "RequestSpotFleet": { "name": "RequestSpotFleet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RequestSpotFleetRequest" }, "output": { "shape": "RequestSpotFleetResponse" }, "documentation": "Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide.
We strongly discourage using the RequestSpotFleet 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.
Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
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.
Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.
" }, "ResetEbsDefaultKmsKeyId": { "name": "ResetEbsDefaultKmsKeyId", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ResetEbsDefaultKmsKeyIdRequest" }, "output": { "shape": "ResetEbsDefaultKmsKeyIdResult" }, "documentation": "Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.
After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
" }, "ResetFpgaImageAttribute": { "name": "ResetFpgaImageAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ResetFpgaImageAttributeRequest" }, "output": { "shape": "ResetFpgaImageAttributeResult" }, "documentation": "Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.
" }, "ResetImageAttribute": { "name": "ResetImageAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ResetImageAttributeRequest" }, "documentation": "Resets an attribute of an AMI to its default value.
" }, "ResetInstanceAttribute": { "name": "ResetInstanceAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ResetInstanceAttributeRequest" }, "documentation": "Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.
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 Amazon VPC User Guide.
Resets a network interface attribute. You can specify only one attribute at a time.
" }, "ResetSnapshotAttribute": { "name": "ResetSnapshotAttribute", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ResetSnapshotAttributeRequest" }, "documentation": "Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.
" }, "RestoreAddressToClassic": { "name": "RestoreAddressToClassic", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RestoreAddressToClassicRequest" }, "output": { "shape": "RestoreAddressToClassicResult" }, "documentation": "This action is deprecated.
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
" }, "RestoreImageFromRecycleBin": { "name": "RestoreImageFromRecycleBin", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RestoreImageFromRecycleBinRequest" }, "output": { "shape": "RestoreImageFromRecycleBinResult" }, "documentation": "Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
" }, "RestoreManagedPrefixListVersion": { "name": "RestoreManagedPrefixListVersion", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RestoreManagedPrefixListVersionRequest" }, "output": { "shape": "RestoreManagedPrefixListVersionResult" }, "documentation": "Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
" }, "RestoreSnapshotFromRecycleBin": { "name": "RestoreSnapshotFromRecycleBin", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RestoreSnapshotFromRecycleBinRequest" }, "output": { "shape": "RestoreSnapshotFromRecycleBinResult" }, "documentation": "Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon EBS User Guide.
" }, "RestoreSnapshotTier": { "name": "RestoreSnapshotTier", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RestoreSnapshotTierRequest" }, "output": { "shape": "RestoreSnapshotTierResult" }, "documentation": "Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.
For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon EBS User Guide.
" }, "RevokeClientVpnIngress": { "name": "RevokeClientVpnIngress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RevokeClientVpnIngressRequest" }, "output": { "shape": "RevokeClientVpnIngressResult" }, "documentation": "Removes an ingress authorization rule from a Client VPN endpoint.
" }, "RevokeSecurityGroupEgress": { "name": "RevokeSecurityGroupEgress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RevokeSecurityGroupEgressRequest" }, "output": { "shape": "RevokeSecurityGroupEgressResult" }, "documentation": "Removes the specified outbound (egress) rules from the specified security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
" }, "RevokeSecurityGroupIngress": { "name": "RevokeSecurityGroupIngress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RevokeSecurityGroupIngressRequest" }, "output": { "shape": "RevokeSecurityGroupIngressResult" }, "documentation": "Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
For a non-default VPC, if the values you specify do not match the existing rule's values, an InvalidPermission.NotFound client error is returned, and no rules are revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
" }, "RunInstances": { "name": "RunInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RunInstancesRequest" }, "output": { "shape": "Reservation" }, "documentation": "Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don't specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
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.
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 information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
" }, "RunScheduledInstances": { "name": "RunScheduledInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RunScheduledInstancesRequest" }, "output": { "shape": "RunScheduledInstancesResult" }, "documentation": "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.
" }, "SearchLocalGatewayRoutes": { "name": "SearchLocalGatewayRoutes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SearchLocalGatewayRoutesRequest" }, "output": { "shape": "SearchLocalGatewayRoutesResult" }, "documentation": "Searches for routes in the specified local gateway route table.
" }, "SearchTransitGatewayMulticastGroups": { "name": "SearchTransitGatewayMulticastGroups", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SearchTransitGatewayMulticastGroupsRequest" }, "output": { "shape": "SearchTransitGatewayMulticastGroupsResult" }, "documentation": "Searches one or more transit gateway multicast groups and returns the group membership information.
" }, "SearchTransitGatewayRoutes": { "name": "SearchTransitGatewayRoutes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SearchTransitGatewayRoutesRequest" }, "output": { "shape": "SearchTransitGatewayRoutesResult" }, "documentation": "Searches for routes in the specified transit gateway route table.
" }, "SendDiagnosticInterrupt": { "name": "SendDiagnosticInterrupt", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SendDiagnosticInterruptRequest" }, "documentation": "Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating 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).
" }, "StartInstances": { "name": "StartInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartInstancesRequest" }, "output": { "shape": "StartInstancesResult" }, "documentation": "Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
If you attempt to start a T3 instance with host tenancy and the unlimited CPU credit option, the request fails. The 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.
" }, "StartNetworkInsightsAccessScopeAnalysis": { "name": "StartNetworkInsightsAccessScopeAnalysis", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartNetworkInsightsAccessScopeAnalysisRequest" }, "output": { "shape": "StartNetworkInsightsAccessScopeAnalysisResult" }, "documentation": "Starts analyzing the specified Network Access Scope.
" }, "StartNetworkInsightsAnalysis": { "name": "StartNetworkInsightsAnalysis", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartNetworkInsightsAnalysisRequest" }, "output": { "shape": "StartNetworkInsightsAnalysisResult" }, "documentation": "Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
" }, "StartVpcEndpointServicePrivateDnsVerification": { "name": "StartVpcEndpointServicePrivateDnsVerification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartVpcEndpointServicePrivateDnsVerificationRequest" }, "output": { "shape": "StartVpcEndpointServicePrivateDnsVerificationResult" }, "documentation": "Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server.
" }, "StopInstances": { "name": "StopInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopInstancesRequest" }, "output": { "shape": "StopInstancesResult" }, "documentation": "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.
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 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
" }, "TerminateClientVpnConnections": { "name": "TerminateClientVpnConnections", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TerminateClientVpnConnectionsRequest" }, "output": { "shape": "TerminateClientVpnConnectionsResult" }, "documentation": "Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.
" }, "TerminateInstances": { "name": "TerminateInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TerminateInstancesRequest" }, "output": { "shape": "TerminateInstancesResult" }, "documentation": "Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
" }, "UnassignIpv6Addresses": { "name": "UnassignIpv6Addresses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UnassignIpv6AddressesRequest" }, "output": { "shape": "UnassignIpv6AddressesResult" }, "documentation": "Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.
" }, "UnassignPrivateIpAddresses": { "name": "UnassignPrivateIpAddresses", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UnassignPrivateIpAddressesRequest" }, "documentation": "Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.
" }, "UnassignPrivateNatGatewayAddress": { "name": "UnassignPrivateNatGatewayAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UnassignPrivateNatGatewayAddressRequest" }, "output": { "shape": "UnassignPrivateNatGatewayAddressResult" }, "documentation": "Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.
A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections, but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses are released.
" }, "UnlockSnapshot": { "name": "UnlockSnapshot", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UnlockSnapshotRequest" }, "output": { "shape": "UnlockSnapshotResult" }, "documentation": "Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.
" }, "UnmonitorInstances": { "name": "UnmonitorInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UnmonitorInstancesRequest" }, "output": { "shape": "UnmonitorInstancesResult" }, "documentation": "Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
" }, "UpdateSecurityGroupRuleDescriptionsEgress": { "name": "UpdateSecurityGroupRuleDescriptionsEgress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateSecurityGroupRuleDescriptionsEgressRequest" }, "output": { "shape": "UpdateSecurityGroupRuleDescriptionsEgressResult" }, "documentation": "Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
" }, "UpdateSecurityGroupRuleDescriptionsIngress": { "name": "UpdateSecurityGroupRuleDescriptionsIngress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateSecurityGroupRuleDescriptionsIngressRequest" }, "output": { "shape": "UpdateSecurityGroupRuleDescriptionsIngressResult" }, "documentation": "Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
" }, "WithdrawByoipCidr": { "name": "WithdrawByoipCidr", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "WithdrawByoipCidrRequest" }, "output": { "shape": "WithdrawByoipCidrResult" }, "documentation": "Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.
" } }, "shapes": { "AcceleratorCount": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.
", "locationName": "min" }, "Max": { "shape": "Integer", "documentation": "The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
" }, "AcceleratorCountRequest": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum number of accelerators. To specify no minimum limit, omit this parameter.
" }, "Max": { "shape": "Integer", "documentation": "The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0.
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set Max to 0.
The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.
", "locationName": "min" }, "Max": { "shape": "Integer", "documentation": "The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum amount of total accelerator memory, in MiB.
" }, "AcceleratorTotalMemoryMiBRequest": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
" }, "Max": { "shape": "Integer", "documentation": "The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
" } }, "documentation": "The minimum and maximum amount of total accelerator memory, in MiB.
" }, "AcceleratorType": { "type": "string", "enum": [ "gpu", "fpga", "inference" ] }, "AcceleratorTypeSet": { "type": "list", "member": { "shape": "AcceleratorType", "locationName": "item" } }, "AcceptAddressTransferRequest": { "type": "structure", "required": [ "Address" ], "members": { "Address": { "shape": "String", "documentation": "The Elastic IP address you are accepting for transfer.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": " tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
An Elastic IP address transfer.
", "locationName": "addressTransfer" } } }, "AcceptReservedInstancesExchangeQuoteRequest": { "type": "structure", "required": [ "ReservedInstanceIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
", "locationName": "ReservedInstanceId" }, "TargetConfigurations": { "shape": "TargetConfigurationRequestSet", "documentation": "The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
", "locationName": "TargetConfiguration" } }, "documentation": "Contains the parameters for accepting the quote.
" }, "AcceptReservedInstancesExchangeQuoteResult": { "type": "structure", "members": { "ExchangeId": { "shape": "String", "documentation": "The ID of the successful exchange.
", "locationName": "exchangeId" } }, "documentation": "The result of the exchange and whether it was successful.
The ID of the transit gateway multicast domain.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway attachment.
" }, "SubnetIds": { "shape": "ValueStringList", "documentation": "The IDs of the subnets to associate with the transit gateway multicast domain.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the multicast domain associations.
", "locationName": "associations" } } }, "AcceptTransitGatewayPeeringAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The transit gateway peering attachment.
", "locationName": "transitGatewayPeeringAttachment" } } }, "AcceptTransitGatewayVpcAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The VPC attachment.
", "locationName": "transitGatewayVpcAttachment" } } }, "AcceptVpcEndpointConnectionsRequest": { "type": "structure", "required": [ "ServiceId", "VpcEndpointIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC endpoint service.
" }, "VpcEndpointIds": { "shape": "VpcEndpointIdList", "documentation": "The IDs of the interface VPC endpoints.
", "locationName": "VpcEndpointId" } } }, "AcceptVpcEndpointConnectionsResult": { "type": "structure", "members": { "Unsuccessful": { "shape": "UnsuccessfulItemSet", "documentation": "Information about the interface endpoints that were not accepted, if applicable.
", "locationName": "unsuccessful" } } }, "AcceptVpcPeeringConnectionRequest": { "type": "structure", "required": [ "VpcPeeringConnectionId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC peering connection. You must specify this parameter in the request.
", "locationName": "vpcPeeringConnectionId" } } }, "AcceptVpcPeeringConnectionResult": { "type": "structure", "members": { "VpcPeeringConnection": { "shape": "VpcPeeringConnection", "documentation": "Information about the VPC peering connection.
", "locationName": "vpcPeeringConnection" } } }, "AccessScopeAnalysisFinding": { "type": "structure", "members": { "NetworkInsightsAccessScopeAnalysisId": { "shape": "NetworkInsightsAccessScopeAnalysisId", "documentation": "The ID of the Network Access Scope analysis.
", "locationName": "networkInsightsAccessScopeAnalysisId" }, "NetworkInsightsAccessScopeId": { "shape": "NetworkInsightsAccessScopeId", "documentation": "The ID of the Network Access Scope.
", "locationName": "networkInsightsAccessScopeId" }, "FindingId": { "shape": "String", "documentation": "The ID of the finding.
", "locationName": "findingId" }, "FindingComponents": { "shape": "PathComponentList", "documentation": "The finding components.
", "locationName": "findingComponentSet" } }, "documentation": "Describes a finding for a Network Access Scope.
" }, "AccessScopeAnalysisFindingList": { "type": "list", "member": { "shape": "AccessScopeAnalysisFinding", "locationName": "item" } }, "AccessScopePath": { "type": "structure", "members": { "Source": { "shape": "PathStatement", "documentation": "The source.
", "locationName": "source" }, "Destination": { "shape": "PathStatement", "documentation": "The destination.
", "locationName": "destination" }, "ThroughResources": { "shape": "ThroughResourcesStatementList", "documentation": "The through resources.
", "locationName": "throughResourceSet" } }, "documentation": "Describes a path.
" }, "AccessScopePathList": { "type": "list", "member": { "shape": "AccessScopePath", "locationName": "item" } }, "AccessScopePathListRequest": { "type": "list", "member": { "shape": "AccessScopePathRequest", "locationName": "item" } }, "AccessScopePathRequest": { "type": "structure", "members": { "Source": { "shape": "PathStatementRequest", "documentation": "The source.
" }, "Destination": { "shape": "PathStatementRequest", "documentation": "The destination.
" }, "ThroughResources": { "shape": "ThroughResourcesStatementRequestList", "documentation": "The through resources.
", "locationName": "ThroughResource" } }, "documentation": "Describes a path.
" }, "AccountAttribute": { "type": "structure", "members": { "AttributeName": { "shape": "String", "documentation": "The name of the account attribute.
", "locationName": "attributeName" }, "AttributeValues": { "shape": "AccountAttributeValueList", "documentation": "The values for the account attribute.
", "locationName": "attributeValueSet" } }, "documentation": "Describes an account attribute.
" }, "AccountAttributeList": { "type": "list", "member": { "shape": "AccountAttribute", "locationName": "item" } }, "AccountAttributeName": { "type": "string", "enum": [ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList": { "type": "list", "member": { "shape": "AccountAttributeName", "locationName": "attributeName" } }, "AccountAttributeValue": { "type": "structure", "members": { "AttributeValue": { "shape": "String", "documentation": "The value of the attribute.
", "locationName": "attributeValue" } }, "documentation": "Describes a value of an account attribute.
" }, "AccountAttributeValueList": { "type": "list", "member": { "shape": "AccountAttributeValue", "locationName": "item" } }, "ActiveInstance": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "InstanceType": { "shape": "String", "documentation": "The instance type.
", "locationName": "instanceType" }, "SpotInstanceRequestId": { "shape": "String", "documentation": "The ID of the Spot Instance request.
", "locationName": "spotInstanceRequestId" }, "InstanceHealth": { "shape": "InstanceHealthStatus", "documentation": "The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.
Describes a running instance in a Spot Fleet.
" }, "ActiveInstanceSet": { "type": "list", "member": { "shape": "ActiveInstance", "locationName": "item" } }, "ActivityStatus": { "type": "string", "enum": [ "error", "pending_fulfillment", "pending_termination", "fulfilled" ] }, "AddIpamOperatingRegion": { "type": "structure", "members": { "RegionName": { "shape": "String", "documentation": "The name of the operating Region.
" } }, "documentation": "Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
" }, "AddIpamOperatingRegionSet": { "type": "list", "member": { "shape": "AddIpamOperatingRegion" }, "max": 50, "min": 0 }, "AddPrefixListEntries": { "type": "list", "member": { "shape": "AddPrefixListEntry" }, "max": 100, "min": 0 }, "AddPrefixListEntry": { "type": "structure", "required": [ "Cidr" ], "members": { "Cidr": { "shape": "String", "documentation": "The CIDR block.
" }, "Description": { "shape": "String", "documentation": "A description for the entry.
Constraints: Up to 255 characters in length.
" } }, "documentation": "An entry for a prefix list.
" }, "AddedPrincipal": { "type": "structure", "members": { "PrincipalType": { "shape": "PrincipalType", "documentation": "The type of principal.
", "locationName": "principalType" }, "Principal": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the principal.
", "locationName": "principal" }, "ServicePermissionId": { "shape": "String", "documentation": "The ID of the service permission.
", "locationName": "servicePermissionId" }, "ServiceId": { "shape": "String", "documentation": "The ID of the service.
", "locationName": "serviceId" } }, "documentation": "Describes a principal.
" }, "AddedPrincipalSet": { "type": "list", "member": { "shape": "AddedPrincipal", "locationName": "item" } }, "AdditionalDetail": { "type": "structure", "members": { "AdditionalDetailType": { "shape": "String", "documentation": "The additional detail code.
", "locationName": "additionalDetailType" }, "Component": { "shape": "AnalysisComponent", "documentation": "The path component.
", "locationName": "component" }, "VpcEndpointService": { "shape": "AnalysisComponent", "documentation": "The VPC endpoint service.
", "locationName": "vpcEndpointService" }, "RuleOptions": { "shape": "RuleOptionList", "documentation": "The rule options.
", "locationName": "ruleOptionSet" }, "RuleGroupTypePairs": { "shape": "RuleGroupTypePairList", "documentation": "The rule group type.
", "locationName": "ruleGroupTypePairSet" }, "RuleGroupRuleOptionsPairs": { "shape": "RuleGroupRuleOptionsPairList", "documentation": "The rule options.
", "locationName": "ruleGroupRuleOptionsPairSet" }, "ServiceName": { "shape": "String", "documentation": "The name of the VPC endpoint service.
", "locationName": "serviceName" }, "LoadBalancers": { "shape": "AnalysisComponentList", "documentation": "The load balancers.
", "locationName": "loadBalancerSet" } }, "documentation": "Describes an additional detail for a path analysis. For more information, see Reachability Analyzer additional detail codes.
" }, "AdditionalDetailList": { "type": "list", "member": { "shape": "AdditionalDetail", "locationName": "item" } }, "Address": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The ID of the instance that the address is associated with (if any).
", "locationName": "instanceId" }, "PublicIp": { "shape": "String", "documentation": "The Elastic IP address.
", "locationName": "publicIp" }, "AllocationId": { "shape": "String", "documentation": "The ID representing the allocation of the address.
", "locationName": "allocationId" }, "AssociationId": { "shape": "String", "documentation": "The ID representing the association of the address with an instance.
", "locationName": "associationId" }, "Domain": { "shape": "DomainType", "documentation": "The network (vpc).
The ID of the network interface.
", "locationName": "networkInterfaceId" }, "NetworkInterfaceOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the network interface.
", "locationName": "networkInterfaceOwnerId" }, "PrivateIpAddress": { "shape": "String", "documentation": "The private IP address associated with the Elastic IP address.
", "locationName": "privateIpAddress" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the Elastic IP address.
", "locationName": "tagSet" }, "PublicIpv4Pool": { "shape": "String", "documentation": "The ID of an address pool.
", "locationName": "publicIpv4Pool" }, "NetworkBorderGroup": { "shape": "String", "documentation": "The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
", "locationName": "networkBorderGroup" }, "CustomerOwnedIp": { "shape": "String", "documentation": "The customer-owned IP address.
", "locationName": "customerOwnedIp" }, "CustomerOwnedIpv4Pool": { "shape": "String", "documentation": "The ID of the customer-owned address pool.
", "locationName": "customerOwnedIpv4Pool" }, "CarrierIp": { "shape": "String", "documentation": "The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
", "locationName": "carrierIp" } }, "documentation": "Describes an Elastic IP address, or a carrier IP address.
" }, "AddressAttribute": { "type": "structure", "members": { "PublicIp": { "shape": "PublicIpAddress", "documentation": "The public IP address.
", "locationName": "publicIp" }, "AllocationId": { "shape": "AllocationId", "documentation": "[EC2-VPC] The allocation ID.
", "locationName": "allocationId" }, "PtrRecord": { "shape": "String", "documentation": "The pointer (PTR) record for the IP address.
", "locationName": "ptrRecord" }, "PtrRecordUpdate": { "shape": "PtrUpdateStatus", "documentation": "The updated PTR record for the IP address.
", "locationName": "ptrRecordUpdate" } }, "documentation": "The attributes associated with an Elastic IP address.
" }, "AddressAttributeName": { "type": "string", "enum": [ "domain-name" ] }, "AddressFamily": { "type": "string", "enum": [ "ipv4", "ipv6" ] }, "AddressList": { "type": "list", "member": { "shape": "Address", "locationName": "item" } }, "AddressMaxResults": { "type": "integer", "max": 1000, "min": 1 }, "AddressSet": { "type": "list", "member": { "shape": "AddressAttribute", "locationName": "item" } }, "AddressTransfer": { "type": "structure", "members": { "PublicIp": { "shape": "String", "documentation": "The Elastic IP address being transferred.
", "locationName": "publicIp" }, "AllocationId": { "shape": "String", "documentation": "The allocation ID of an Elastic IP address.
", "locationName": "allocationId" }, "TransferAccountId": { "shape": "String", "documentation": "The ID of the account that you want to transfer the Elastic IP address to.
", "locationName": "transferAccountId" }, "TransferOfferExpirationTimestamp": { "shape": "MillisecondDateTime", "documentation": "The timestamp when the Elastic IP address transfer expired. When the source account starts the transfer, the transfer account has seven hours to allocate the Elastic IP address to complete the transfer, or the Elastic IP address will return to its original owner.
", "locationName": "transferOfferExpirationTimestamp" }, "TransferOfferAcceptedTimestamp": { "shape": "MillisecondDateTime", "documentation": "The timestamp when the Elastic IP address transfer was accepted.
", "locationName": "transferOfferAcceptedTimestamp" }, "AddressTransferStatus": { "shape": "AddressTransferStatus", "documentation": "The Elastic IP address transfer status.
", "locationName": "addressTransferStatus" } }, "documentation": "Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
" }, "AddressTransferList": { "type": "list", "member": { "shape": "AddressTransfer", "locationName": "item" } }, "AddressTransferStatus": { "type": "string", "enum": [ "pending", "disabled", "accepted" ] }, "AdvertiseByoipCidrRequest": { "type": "structure", "required": [ "Cidr" ], "members": { "Cidr": { "shape": "String", "documentation": "The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.
" }, "Asn": { "shape": "String", "documentation": "The public 2-byte or 4-byte ASN that you want to advertise.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
Information about the address range.
", "locationName": "byoipCidr" } } }, "Affinity": { "type": "string", "enum": [ "default", "host" ] }, "AllocateAddressRequest": { "type": "structure", "members": { "Domain": { "shape": "DomainType", "documentation": "The network (vpc).
The Elastic IP address to recover or an IPv4 address from an address pool.
" }, "PublicIpv4Pool": { "shape": "Ipv4PoolEc2Id", "documentation": "The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.
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.
" }, "CustomerOwnedIpv4Pool": { "shape": "String", "documentation": "The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tags to assign to the Elastic IP address.
", "locationName": "TagSpecification" } } }, "AllocateAddressResult": { "type": "structure", "members": { "PublicIp": { "shape": "String", "documentation": "The Elastic IP address.
", "locationName": "publicIp" }, "AllocationId": { "shape": "String", "documentation": "The ID that represents the allocation of the Elastic IP address.
", "locationName": "allocationId" }, "PublicIpv4Pool": { "shape": "String", "documentation": "The ID of an address pool.
", "locationName": "publicIpv4Pool" }, "NetworkBorderGroup": { "shape": "String", "documentation": "The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
", "locationName": "networkBorderGroup" }, "Domain": { "shape": "DomainType", "documentation": "The network (vpc).
The customer-owned IP address.
", "locationName": "customerOwnedIp" }, "CustomerOwnedIpv4Pool": { "shape": "String", "documentation": "The ID of the customer-owned address pool.
", "locationName": "customerOwnedIpv4Pool" }, "CarrierIp": { "shape": "String", "documentation": "The carrier IP address. This option is only available for network interfaces that reside in a subnet in a Wavelength Zone.
", "locationName": "carrierIp" } } }, "AllocateHostsRequest": { "type": "structure", "required": [ "AvailabilityZone" ], "members": { "AutoPlacement": { "shape": "AutoPlacement", "documentation": "Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
The Availability Zone in which to allocate the Dedicated Host.
", "locationName": "availabilityZone" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "locationName": "clientToken" }, "InstanceType": { "shape": "String", "documentation": "Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
", "locationName": "instanceType" }, "InstanceFamily": { "shape": "String", "documentation": "Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
" }, "Quantity": { "shape": "Integer", "documentation": "The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.
", "locationName": "quantity" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the Dedicated Host during creation.
", "locationName": "TagSpecification" }, "HostRecovery": { "shape": "HostRecovery", "documentation": "Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.
Default: off
The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.
If you are allocating the Dedicated Host in a Region, omit this parameter.
" }, "HostMaintenance": { "shape": "HostMaintenance", "documentation": "Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
" }, "AssetIds": { "shape": "AssetIdList", "documentation": "The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.
If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.
If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.
The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
", "locationName": "hostIdSet" } }, "documentation": "Contains the output of AllocateHosts.
" }, "AllocateIpamPoolCidrRequest": { "type": "structure", "required": [ "IpamPoolId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the IPAM pool from which you would like to allocate a CIDR.
" }, "Cidr": { "shape": "String", "documentation": "The CIDR you would like to allocate from the IPAM pool. Note the following:
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
" }, "NetmaskLength": { "shape": "Integer", "documentation": "The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "Description": { "shape": "String", "documentation": "A description for the allocation.
" }, "PreviewNextCidr": { "shape": "Boolean", "documentation": "A preview of the next available CIDR in a pool.
" }, "AllowedCidrs": { "shape": "IpamPoolAllocationAllowedCidrs", "documentation": "Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.
", "locationName": "AllowedCidr" }, "DisallowedCidrs": { "shape": "IpamPoolAllocationDisallowedCidrs", "documentation": "Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.
", "locationName": "DisallowedCidr" } } }, "AllocateIpamPoolCidrResult": { "type": "structure", "members": { "IpamPoolAllocation": { "shape": "IpamPoolAllocation", "documentation": "Information about the allocation created.
", "locationName": "ipamPoolAllocation" } } }, "AllocationId": { "type": "string" }, "AllocationIdList": { "type": "list", "member": { "shape": "AllocationId", "locationName": "AllocationId" } }, "AllocationIds": { "type": "list", "member": { "shape": "AllocationId", "locationName": "item" } }, "AllocationState": { "type": "string", "enum": [ "available", "under-assessment", "permanent-failure", "released", "released-permanent-failure", "pending" ] }, "AllocationStrategy": { "type": "string", "enum": [ "lowestPrice", "diversified", "capacityOptimized", "capacityOptimizedPrioritized", "priceCapacityOptimized" ] }, "AllocationType": { "type": "string", "enum": [ "used" ] }, "AllowedInstanceType": { "type": "string", "max": 30, "min": 1, "pattern": "[a-zA-Z0-9\\.\\*\\-]+" }, "AllowedInstanceTypeSet": { "type": "list", "member": { "shape": "AllowedInstanceType", "locationName": "item" }, "max": 400, "min": 0 }, "AllowedPrincipal": { "type": "structure", "members": { "PrincipalType": { "shape": "PrincipalType", "documentation": "The type of principal.
", "locationName": "principalType" }, "Principal": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the principal.
", "locationName": "principal" }, "ServicePermissionId": { "shape": "String", "documentation": "The ID of the service permission.
", "locationName": "servicePermissionId" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" }, "ServiceId": { "shape": "String", "documentation": "The ID of the service.
", "locationName": "serviceId" } }, "documentation": "Describes a principal.
" }, "AllowedPrincipalSet": { "type": "list", "member": { "shape": "AllowedPrincipal", "locationName": "item" } }, "AllowsMultipleInstanceTypes": { "type": "string", "enum": [ "on", "off" ] }, "AlternatePathHint": { "type": "structure", "members": { "ComponentId": { "shape": "String", "documentation": "The ID of the component.
", "locationName": "componentId" }, "ComponentArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the component.
", "locationName": "componentArn" } }, "documentation": "Describes an potential intermediate component of a feasible path.
" }, "AlternatePathHintList": { "type": "list", "member": { "shape": "AlternatePathHint", "locationName": "item" } }, "AmdSevSnpSpecification": { "type": "string", "enum": [ "enabled", "disabled" ] }, "AnalysisAclRule": { "type": "structure", "members": { "Cidr": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation.
", "locationName": "cidr" }, "Egress": { "shape": "Boolean", "documentation": "Indicates whether the rule is an outbound rule.
", "locationName": "egress" }, "PortRange": { "shape": "PortRange", "documentation": "The range of ports.
", "locationName": "portRange" }, "Protocol": { "shape": "String", "documentation": "The protocol.
", "locationName": "protocol" }, "RuleAction": { "shape": "String", "documentation": "Indicates whether to allow or deny traffic that matches the rule.
", "locationName": "ruleAction" }, "RuleNumber": { "shape": "Integer", "documentation": "The rule number.
", "locationName": "ruleNumber" } }, "documentation": "Describes a network access control (ACL) rule.
" }, "AnalysisComponent": { "type": "structure", "members": { "Id": { "shape": "String", "documentation": "The ID of the component.
", "locationName": "id" }, "Arn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the component.
", "locationName": "arn" }, "Name": { "shape": "String", "documentation": "The name of the analysis component.
", "locationName": "name" } }, "documentation": "Describes a path component.
" }, "AnalysisComponentList": { "type": "list", "member": { "shape": "AnalysisComponent", "locationName": "item" } }, "AnalysisLoadBalancerListener": { "type": "structure", "members": { "LoadBalancerPort": { "shape": "Port", "documentation": "The port on which the load balancer is listening.
", "locationName": "loadBalancerPort" }, "InstancePort": { "shape": "Port", "documentation": "[Classic Load Balancers] The back-end port for the listener.
", "locationName": "instancePort" } }, "documentation": "Describes a load balancer listener.
" }, "AnalysisLoadBalancerTarget": { "type": "structure", "members": { "Address": { "shape": "IpAddress", "documentation": "The IP address.
", "locationName": "address" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "Instance": { "shape": "AnalysisComponent", "documentation": "Information about the instance.
", "locationName": "instance" }, "Port": { "shape": "Port", "documentation": "The port on which the target is listening.
", "locationName": "port" } }, "documentation": "Describes a load balancer target.
" }, "AnalysisPacketHeader": { "type": "structure", "members": { "DestinationAddresses": { "shape": "IpAddressList", "documentation": "The destination addresses.
", "locationName": "destinationAddressSet" }, "DestinationPortRanges": { "shape": "PortRangeList", "documentation": "The destination port ranges.
", "locationName": "destinationPortRangeSet" }, "Protocol": { "shape": "String", "documentation": "The protocol.
", "locationName": "protocol" }, "SourceAddresses": { "shape": "IpAddressList", "documentation": "The source addresses.
", "locationName": "sourceAddressSet" }, "SourcePortRanges": { "shape": "PortRangeList", "documentation": "The source port ranges.
", "locationName": "sourcePortRangeSet" } }, "documentation": "Describes a header. Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path.
" }, "AnalysisRouteTableRoute": { "type": "structure", "members": { "DestinationCidr": { "shape": "String", "documentation": "The destination IPv4 address, in CIDR notation.
", "locationName": "destinationCidr" }, "DestinationPrefixListId": { "shape": "String", "documentation": "The prefix of the Amazon Web Service.
", "locationName": "destinationPrefixListId" }, "EgressOnlyInternetGatewayId": { "shape": "String", "documentation": "The ID of an egress-only internet gateway.
", "locationName": "egressOnlyInternetGatewayId" }, "GatewayId": { "shape": "String", "documentation": "The ID of the gateway, such as an internet gateway or virtual private gateway.
", "locationName": "gatewayId" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance, such as a NAT instance.
", "locationName": "instanceId" }, "NatGatewayId": { "shape": "String", "documentation": "The ID of a NAT gateway.
", "locationName": "natGatewayId" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of a network interface.
", "locationName": "networkInterfaceId" }, "Origin": { "shape": "String", "documentation": "Describes how the route was created. The following are the possible values:
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
The ID of a transit gateway.
", "locationName": "transitGatewayId" }, "VpcPeeringConnectionId": { "shape": "String", "documentation": "The ID of a VPC peering connection.
", "locationName": "vpcPeeringConnectionId" }, "State": { "shape": "String", "documentation": "The state. The following are the possible values:
active
blackhole
The ID of a carrier gateway.
", "locationName": "carrierGatewayId" }, "CoreNetworkArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of a core network.
", "locationName": "coreNetworkArn" }, "LocalGatewayId": { "shape": "String", "documentation": "The ID of a local gateway.
", "locationName": "localGatewayId" } }, "documentation": "Describes a route table route.
" }, "AnalysisSecurityGroupRule": { "type": "structure", "members": { "Cidr": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation.
", "locationName": "cidr" }, "Direction": { "shape": "String", "documentation": "The direction. The following are the possible values:
egress
ingress
The security group ID.
", "locationName": "securityGroupId" }, "PortRange": { "shape": "PortRange", "documentation": "The port range.
", "locationName": "portRange" }, "PrefixListId": { "shape": "String", "documentation": "The prefix list ID.
", "locationName": "prefixListId" }, "Protocol": { "shape": "String", "documentation": "The protocol name.
", "locationName": "protocol" } }, "documentation": "Describes a security group rule.
" }, "AnalysisStatus": { "type": "string", "enum": [ "running", "succeeded", "failed" ] }, "ApplianceModeSupportValue": { "type": "string", "enum": [ "enable", "disable" ] }, "ApplySecurityGroupsToClientVpnTargetNetworkRequest": { "type": "structure", "required": [ "ClientVpnEndpointId", "VpcId", "SecurityGroupIds" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint.
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC in which the associated target network is located.
" }, "SecurityGroupIds": { "shape": "ClientVpnSecurityGroupIdSet", "documentation": "The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.
", "locationName": "SecurityGroupId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the applied security groups.
", "locationName": "securityGroupIds" } } }, "ArchitectureType": { "type": "string", "enum": [ "i386", "x86_64", "arm64", "x86_64_mac", "arm64_mac" ] }, "ArchitectureTypeList": { "type": "list", "member": { "shape": "ArchitectureType", "locationName": "item" } }, "ArchitectureTypeSet": { "type": "list", "member": { "shape": "ArchitectureType", "locationName": "item" }, "max": 3, "min": 0 }, "ArchitectureValues": { "type": "string", "enum": [ "i386", "x86_64", "arm64", "x86_64_mac", "arm64_mac" ] }, "ArnList": { "type": "list", "member": { "shape": "ResourceArn", "locationName": "item" } }, "AsnAssociation": { "type": "structure", "members": { "Asn": { "shape": "String", "documentation": "The association's ASN.
", "locationName": "asn" }, "Cidr": { "shape": "String", "documentation": "The association's CIDR.
", "locationName": "cidr" }, "StatusMessage": { "shape": "String", "documentation": "The association's status message.
", "locationName": "statusMessage" }, "State": { "shape": "AsnAssociationState", "documentation": "The association's state.
", "locationName": "state" } }, "documentation": "An Autonomous System Number (ASN) and BYOIP CIDR association.
" }, "AsnAssociationSet": { "type": "list", "member": { "shape": "AsnAssociation", "locationName": "item" } }, "AsnAssociationState": { "type": "string", "enum": [ "disassociated", "failed-disassociation", "failed-association", "pending-disassociation", "pending-association", "associated" ] }, "AsnAuthorizationContext": { "type": "structure", "required": [ "Message", "Signature" ], "members": { "Message": { "shape": "String", "documentation": "The authorization context's message.
" }, "Signature": { "shape": "String", "documentation": "The authorization context's signature.
" } }, "documentation": "Provides authorization for Amazon to bring an Autonomous System Number (ASN) to a specific Amazon Web Services account using bring your own ASN (BYOASN). For details on the format of the message and signature, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
" }, "AsnState": { "type": "string", "enum": [ "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned" ] }, "AssetId": { "type": "string" }, "AssetIdList": { "type": "list", "member": { "shape": "AssetId" } }, "AssignIpv6AddressesRequest": { "type": "structure", "required": [ "NetworkInterfaceId" ], "members": { "Ipv6AddressCount": { "shape": "Integer", "documentation": "The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
", "locationName": "ipv6AddressCount" }, "Ipv6Addresses": { "shape": "Ipv6AddressList", "documentation": "The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
", "locationName": "ipv6Addresses" }, "Ipv6PrefixCount": { "shape": "Integer", "documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
The ID of the network interface.
", "locationName": "networkInterfaceId" } } }, "AssignIpv6AddressesResult": { "type": "structure", "members": { "AssignedIpv6Addresses": { "shape": "Ipv6AddressList", "documentation": "The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that were assigned to the network interface before the request are not included.
", "locationName": "assignedIpv6Addresses" }, "AssignedIpv6Prefixes": { "shape": "IpPrefixList", "documentation": "The IPv6 prefixes that are assigned to the network interface.
", "locationName": "assignedIpv6PrefixSet" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" } } }, "AssignPrivateIpAddressesRequest": { "type": "structure", "required": [ "NetworkInterfaceId" ], "members": { "AllowReassignment": { "shape": "Boolean", "documentation": "Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
", "locationName": "allowReassignment" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "PrivateIpAddresses": { "shape": "PrivateIpAddressStringList", "documentation": "The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
", "locationName": "privateIpAddress" }, "SecondaryPrivateIpAddressCount": { "shape": "Integer", "documentation": "The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
", "locationName": "secondaryPrivateIpAddressCount" }, "Ipv4Prefixes": { "shape": "IpPrefixList", "documentation": "One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
Contains the parameters for AssignPrivateIpAddresses.
" }, "AssignPrivateIpAddressesResult": { "type": "structure", "members": { "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "AssignedPrivateIpAddresses": { "shape": "AssignedPrivateIpAddressList", "documentation": "The private IP addresses assigned to the network interface.
", "locationName": "assignedPrivateIpAddressesSet" }, "AssignedIpv4Prefixes": { "shape": "Ipv4PrefixesList", "documentation": "The IPv4 prefixes that are assigned to the network interface.
", "locationName": "assignedIpv4PrefixSet" } } }, "AssignPrivateNatGatewayAddressRequest": { "type": "structure", "required": [ "NatGatewayId" ], "members": { "NatGatewayId": { "shape": "NatGatewayId", "documentation": "The ID of the NAT gateway.
" }, "PrivateIpAddresses": { "shape": "IpList", "documentation": "The private IPv4 addresses you want to assign to the private NAT gateway.
", "locationName": "PrivateIpAddress" }, "PrivateIpAddressCount": { "shape": "PrivateIpAddressCount", "documentation": "The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the NAT gateway.
", "locationName": "natGatewayId" }, "NatGatewayAddresses": { "shape": "NatGatewayAddressList", "documentation": "NAT gateway IP addresses.
", "locationName": "natGatewayAddressSet" } } }, "AssignedPrivateIpAddress": { "type": "structure", "members": { "PrivateIpAddress": { "shape": "String", "documentation": "The private IP address assigned to the network interface.
", "locationName": "privateIpAddress" } }, "documentation": "Describes the private IP addresses assigned to a network interface.
" }, "AssignedPrivateIpAddressList": { "type": "list", "member": { "shape": "AssignedPrivateIpAddress", "locationName": "item" } }, "AssociateAddressRequest": { "type": "structure", "members": { "AllocationId": { "shape": "AllocationId", "documentation": "The allocation ID. This is required.
" }, "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both.
" }, "PublicIp": { "shape": "EipAllocationPublicIp", "documentation": "Deprecated.
" }, "AllowReassociation": { "shape": "Boolean", "documentation": "Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
", "locationName": "allowReassociation" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
You can specify either the instance ID or the network interface ID, but not both.
", "locationName": "networkInterfaceId" }, "PrivateIpAddress": { "shape": "String", "documentation": "The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
", "locationName": "privateIpAddress" } } }, "AssociateAddressResult": { "type": "structure", "members": { "AssociationId": { "shape": "String", "documentation": "The ID that represents the association of the Elastic IP address with an instance.
", "locationName": "associationId" } } }, "AssociateClientVpnTargetNetworkRequest": { "type": "structure", "required": [ "ClientVpnEndpointId", "SubnetId" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint.
" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet to associate with the Client VPN endpoint.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The unique ID of the target network association.
", "locationName": "associationId" }, "Status": { "shape": "AssociationStatus", "documentation": "The current state of the target network association.
", "locationName": "status" } } }, "AssociateDhcpOptionsRequest": { "type": "structure", "required": [ "DhcpOptionsId", "VpcId" ], "members": { "DhcpOptionsId": { "shape": "DefaultingDhcpOptionsId", "documentation": "The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
The ID of the VPC.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ARN of the ACM certificate with which to associate the IAM role.
" }, "RoleArn": { "shape": "RoleId", "documentation": "The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The name of the Amazon S3 bucket to which the certificate was uploaded.
", "locationName": "certificateS3BucketName" }, "CertificateS3ObjectKey": { "shape": "String", "documentation": "The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.
The ID of the KMS key used to encrypt the private key of the certificate.
", "locationName": "encryptionKmsKeyId" } } }, "AssociateIamInstanceProfileRequest": { "type": "structure", "required": [ "IamInstanceProfile", "InstanceId" ], "members": { "IamInstanceProfile": { "shape": "IamInstanceProfileSpecification", "documentation": "The IAM instance profile.
" }, "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance.
" } } }, "AssociateIamInstanceProfileResult": { "type": "structure", "members": { "IamInstanceProfileAssociation": { "shape": "IamInstanceProfileAssociation", "documentation": "Information about the IAM instance profile association.
", "locationName": "iamInstanceProfileAssociation" } } }, "AssociateInstanceEventWindowRequest": { "type": "structure", "required": [ "InstanceEventWindowId", "AssociationTarget" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the event window.
" }, "AssociationTarget": { "shape": "InstanceEventWindowAssociationRequest", "documentation": "One or more targets associated with the specified event window.
" } } }, "AssociateInstanceEventWindowResult": { "type": "structure", "members": { "InstanceEventWindow": { "shape": "InstanceEventWindow", "documentation": "Information about the event window.
", "locationName": "instanceEventWindow" } } }, "AssociateIpamByoasnRequest": { "type": "structure", "required": [ "Asn", "Cidr" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
A public 2-byte or 4-byte ASN.
" }, "Cidr": { "shape": "String", "documentation": "The BYOIP CIDR you want to associate with an ASN.
" } } }, "AssociateIpamByoasnResult": { "type": "structure", "members": { "AsnAssociation": { "shape": "AsnAssociation", "documentation": "The ASN and BYOIP CIDR association.
", "locationName": "asnAssociation" } } }, "AssociateIpamResourceDiscoveryRequest": { "type": "structure", "required": [ "IpamId", "IpamResourceDiscoveryId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
An IPAM ID.
" }, "IpamResourceDiscoveryId": { "shape": "IpamResourceDiscoveryId", "documentation": "A resource discovery ID.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "Tag specifications.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "A client token.
", "idempotencyToken": true } } }, "AssociateIpamResourceDiscoveryResult": { "type": "structure", "members": { "IpamResourceDiscoveryAssociation": { "shape": "IpamResourceDiscoveryAssociation", "documentation": "A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM.
", "locationName": "ipamResourceDiscoveryAssociation" } } }, "AssociateNatGatewayAddressRequest": { "type": "structure", "required": [ "NatGatewayId", "AllocationIds" ], "members": { "NatGatewayId": { "shape": "NatGatewayId", "documentation": "The ID of the NAT gateway.
" }, "AllocationIds": { "shape": "AllocationIdList", "documentation": "The allocation IDs of EIPs that you want to associate with your NAT gateway.
", "locationName": "AllocationId" }, "PrivateIpAddresses": { "shape": "IpList", "documentation": "The private IPv4 addresses that you want to assign to the NAT gateway.
", "locationName": "PrivateIpAddress" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the NAT gateway.
", "locationName": "natGatewayId" }, "NatGatewayAddresses": { "shape": "NatGatewayAddressList", "documentation": "The IP addresses.
", "locationName": "natGatewayAddressSet" } } }, "AssociateRouteTableRequest": { "type": "structure", "required": [ "RouteTableId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the route table.
", "locationName": "routeTableId" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "GatewayId": { "shape": "RouteGatewayId", "documentation": "The ID of the internet gateway or virtual private gateway.
" } } }, "AssociateRouteTableResult": { "type": "structure", "members": { "AssociationId": { "shape": "String", "documentation": "The route table association ID. This ID is required for disassociating the route table.
", "locationName": "associationId" }, "AssociationState": { "shape": "RouteTableAssociationState", "documentation": "The state of the association.
", "locationName": "associationState" } } }, "AssociateSubnetCidrBlockRequest": { "type": "structure", "required": [ "SubnetId" ], "members": { "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 CIDR block for your subnet.
", "locationName": "ipv6CidrBlock" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of your subnet.
", "locationName": "subnetId" }, "Ipv6IpamPoolId": { "shape": "IpamPoolId", "documentation": "An IPv6 IPAM pool ID.
" }, "Ipv6NetmaskLength": { "shape": "NetmaskLength", "documentation": "An IPv6 netmask length.
" } } }, "AssociateSubnetCidrBlockResult": { "type": "structure", "members": { "Ipv6CidrBlockAssociation": { "shape": "SubnetIpv6CidrBlockAssociation", "documentation": "Information about the IPv6 association.
", "locationName": "ipv6CidrBlockAssociation" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" } } }, "AssociateTransitGatewayMulticastDomainRequest": { "type": "structure", "required": [ "TransitGatewayMulticastDomainId", "TransitGatewayAttachmentId", "SubnetIds" ], "members": { "TransitGatewayMulticastDomainId": { "shape": "TransitGatewayMulticastDomainId", "documentation": "The ID of the transit gateway multicast domain.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway attachment to associate with the transit gateway multicast domain.
" }, "SubnetIds": { "shape": "TransitGatewaySubnetIdList", "documentation": "The IDs of the subnets to associate with the transit gateway multicast domain.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateway multicast domain associations.
", "locationName": "associations" } } }, "AssociateTransitGatewayPolicyTableRequest": { "type": "structure", "required": [ "TransitGatewayPolicyTableId", "TransitGatewayAttachmentId" ], "members": { "TransitGatewayPolicyTableId": { "shape": "TransitGatewayPolicyTableId", "documentation": "The ID of the transit gateway policy table to associate with the transit gateway attachment.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway attachment to associate with the policy table.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Describes the association of a transit gateway and a transit gateway policy table.
", "locationName": "association" } } }, "AssociateTransitGatewayRouteTableRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId", "TransitGatewayAttachmentId" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the association.
", "locationName": "association" } } }, "AssociateTrunkInterfaceRequest": { "type": "structure", "required": [ "BranchInterfaceId", "TrunkInterfaceId" ], "members": { "BranchInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the branch network interface.
" }, "TrunkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the trunk network interface.
" }, "VlanId": { "shape": "Integer", "documentation": "The ID of the VLAN. This applies to the VLAN protocol.
" }, "GreKey": { "shape": "Integer", "documentation": "The application key. This applies to the GRE protocol.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the association between the trunk network interface and branch network interface.
", "locationName": "interfaceAssociation" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", "locationName": "clientToken" } } }, "AssociateVpcCidrBlockRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "AmazonProvidedIpv6CidrBlock": { "shape": "Boolean", "documentation": "Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses or the size of the CIDR block.
", "locationName": "amazonProvidedIpv6CidrBlock" }, "CidrBlock": { "shape": "String", "documentation": "An IPv4 CIDR block to associate with the VPC.
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "Ipv6CidrBlockNetworkBorderGroup": { "shape": "String", "documentation": "The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
You can have one IPv6 CIDR block association per network border group.
" }, "Ipv6Pool": { "shape": "Ipv6PoolEc2Id", "documentation": "The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
" }, "Ipv6CidrBlock": { "shape": "String", "documentation": "An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
" }, "Ipv4IpamPoolId": { "shape": "IpamPoolId", "documentation": "Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "Ipv4NetmaskLength": { "shape": "NetmaskLength", "documentation": "The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "Ipv6IpamPoolId": { "shape": "IpamPoolId", "documentation": "Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "Ipv6NetmaskLength": { "shape": "NetmaskLength", "documentation": "The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" } } }, "AssociateVpcCidrBlockResult": { "type": "structure", "members": { "Ipv6CidrBlockAssociation": { "shape": "VpcIpv6CidrBlockAssociation", "documentation": "Information about the IPv6 CIDR block association.
", "locationName": "ipv6CidrBlockAssociation" }, "CidrBlockAssociation": { "shape": "VpcCidrBlockAssociation", "documentation": "Information about the IPv4 CIDR block association.
", "locationName": "cidrBlockAssociation" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" } } }, "AssociatedNetworkType": { "type": "string", "enum": [ "vpc" ] }, "AssociatedRole": { "type": "structure", "members": { "AssociatedRoleArn": { "shape": "ResourceArn", "documentation": "The ARN of the associated IAM role.
", "locationName": "associatedRoleArn" }, "CertificateS3BucketName": { "shape": "String", "documentation": "The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
", "locationName": "certificateS3BucketName" }, "CertificateS3ObjectKey": { "shape": "String", "documentation": "The key of the Amazon S3 object where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.
The ID of the KMS key used to encrypt the private key.
", "locationName": "encryptionKmsKeyId" } }, "documentation": "Information about the associated IAM roles.
" }, "AssociatedRolesList": { "type": "list", "member": { "shape": "AssociatedRole", "locationName": "item" } }, "AssociatedTargetNetwork": { "type": "structure", "members": { "NetworkId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "networkId" }, "NetworkType": { "shape": "AssociatedNetworkType", "documentation": "The target network type.
", "locationName": "networkType" } }, "documentation": "Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
" }, "AssociatedTargetNetworkSet": { "type": "list", "member": { "shape": "AssociatedTargetNetwork", "locationName": "item" } }, "AssociationIdList": { "type": "list", "member": { "shape": "IamInstanceProfileAssociationId", "locationName": "AssociationId" } }, "AssociationStatus": { "type": "structure", "members": { "Code": { "shape": "AssociationStatusCode", "documentation": "The state of the target network association.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "A message about the status of the target network association, if applicable.
", "locationName": "message" } }, "documentation": "Describes the state of a target network association.
" }, "AssociationStatusCode": { "type": "string", "enum": [ "associating", "associated", "association-failed", "disassociating", "disassociated" ] }, "AthenaIntegration": { "type": "structure", "required": [ "IntegrationResultS3DestinationArn", "PartitionLoadFrequency" ], "members": { "IntegrationResultS3DestinationArn": { "shape": "String", "documentation": "The location in Amazon S3 to store the generated CloudFormation template.
" }, "PartitionLoadFrequency": { "shape": "PartitionLoadFrequency", "documentation": "The schedule for adding new partitions to the table.
" }, "PartitionStartDate": { "shape": "MillisecondDateTime", "documentation": "The start date for the partition.
" }, "PartitionEndDate": { "shape": "MillisecondDateTime", "documentation": "The end date for the partition.
" } }, "documentation": "Describes integration options for Amazon Athena.
" }, "AthenaIntegrationsSet": { "type": "list", "member": { "shape": "AthenaIntegration", "locationName": "item" }, "max": 10, "min": 1 }, "AttachClassicLinkVpcRequest": { "type": "structure", "required": [ "Groups", "InstanceId", "VpcId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the security groups. You cannot specify security groups from a different VPC.
", "locationName": "SecurityGroupId" }, "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the EC2-Classic instance.
", "locationName": "instanceId" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the ClassicLink-enabled VPC.
", "locationName": "vpcId" } } }, "AttachClassicLinkVpcResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the internet gateway.
", "locationName": "internetGatewayId" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
", "locationName": "vpcId" } } }, "AttachNetworkInterfaceRequest": { "type": "structure", "required": [ "DeviceIndex", "InstanceId", "NetworkInterfaceId" ], "members": { "DeviceIndex": { "shape": "Integer", "documentation": "The index of the device for the network interface attachment.
", "locationName": "deviceIndex" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance.
", "locationName": "instanceId" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "NetworkCardIndex": { "shape": "Integer", "documentation": "The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
" }, "EnaSrdSpecification": { "shape": "EnaSrdSpecification", "documentation": "Configures ENA Express for the network interface that this action attaches to the instance.
" } }, "documentation": "Contains the parameters for AttachNetworkInterface.
" }, "AttachNetworkInterfaceResult": { "type": "structure", "members": { "AttachmentId": { "shape": "String", "documentation": "The ID of the network interface attachment.
", "locationName": "attachmentId" }, "NetworkCardIndex": { "shape": "Integer", "documentation": "The index of the network card.
", "locationName": "networkCardIndex" } }, "documentation": "Contains the output of AttachNetworkInterface.
" }, "AttachVerifiedAccessTrustProviderRequest": { "type": "structure", "required": [ "VerifiedAccessInstanceId", "VerifiedAccessTrustProviderId" ], "members": { "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "VerifiedAccessTrustProviderId": { "shape": "VerifiedAccessTrustProviderId", "documentation": "The ID of the Verified Access trust provider.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access trust provider.
", "locationName": "verifiedAccessTrustProvider" }, "VerifiedAccessInstance": { "shape": "VerifiedAccessInstance", "documentation": "Details about the Verified Access instance.
", "locationName": "verifiedAccessInstance" } } }, "AttachVolumeRequest": { "type": "structure", "required": [ "Device", "InstanceId", "VolumeId" ], "members": { "Device": { "shape": "String", "documentation": "The device name (for example, /dev/sdh or xvdh).
The ID of the instance.
" }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC.
" }, "VpnGatewayId": { "shape": "VpnGatewayId", "documentation": "The ID of the virtual private gateway.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for AttachVpnGateway.
" }, "AttachVpnGatewayResult": { "type": "structure", "members": { "VpcAttachment": { "shape": "VpcAttachment", "documentation": "Information about the attachment.
", "locationName": "attachment" } }, "documentation": "Contains the output of AttachVpnGateway.
" }, "AttachmentEnaSrdSpecification": { "type": "structure", "members": { "EnaSrdEnabled": { "shape": "Boolean", "documentation": "Indicates whether ENA Express is enabled for the network interface.
", "locationName": "enaSrdEnabled" }, "EnaSrdUdpSpecification": { "shape": "AttachmentEnaSrdUdpSpecification", "documentation": "Configures ENA Express for UDP network traffic.
", "locationName": "enaSrdUdpSpecification" } }, "documentation": "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. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.
To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.
" }, "AttachmentEnaSrdUdpSpecification": { "type": "structure", "members": { "EnaSrdUdpEnabled": { "shape": "Boolean", "documentation": "Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
", "locationName": "enaSrdUdpEnabled" } }, "documentation": "ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.
" }, "AttachmentStatus": { "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "The attribute value. The valid values are true or false.
Describes a value for a resource attribute that is a Boolean value.
" }, "AttributeValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The attribute value. The value is case-sensitive.
", "locationName": "value" } }, "documentation": "Describes a value for a resource attribute that is a String.
" }, "AuthorizationRule": { "type": "structure", "members": { "ClientVpnEndpointId": { "shape": "String", "documentation": "The ID of the Client VPN endpoint with which the authorization rule is associated.
", "locationName": "clientVpnEndpointId" }, "Description": { "shape": "String", "documentation": "A brief description of the authorization rule.
", "locationName": "description" }, "GroupId": { "shape": "String", "documentation": "The ID of the Active Directory group to which the authorization rule grants access.
", "locationName": "groupId" }, "AccessAll": { "shape": "Boolean", "documentation": "Indicates whether the authorization rule grants access to all clients.
", "locationName": "accessAll" }, "DestinationCidr": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
", "locationName": "destinationCidr" }, "Status": { "shape": "ClientVpnAuthorizationRuleStatus", "documentation": "The current state of the authorization rule.
", "locationName": "status" } }, "documentation": "Information about an authorization rule.
" }, "AuthorizationRuleSet": { "type": "list", "member": { "shape": "AuthorizationRule", "locationName": "item" } }, "AuthorizeClientVpnIngressRequest": { "type": "structure", "required": [ "ClientVpnEndpointId", "TargetNetworkCidr" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint.
" }, "TargetNetworkCidr": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
" }, "AccessGroupId": { "shape": "String", "documentation": "The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.
Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.
A brief description of the authorization rule.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The current state of the authorization rule.
", "locationName": "status" } } }, "AuthorizeSecurityGroupEgressRequest": { "type": "structure", "required": [ "GroupId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the security group.
", "locationName": "groupId" }, "IpPermissions": { "shape": "IpPermissionList", "documentation": "The permissions for the security group rules.
", "locationName": "ipPermissions" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags applied to the security group rule.
", "locationName": "TagSpecification" }, "CidrIp": { "shape": "String", "documentation": "Not supported. Use IP permissions instead.
", "locationName": "cidrIp" }, "FromPort": { "shape": "Integer", "documentation": "Not supported. Use IP permissions instead.
", "locationName": "fromPort" }, "IpProtocol": { "shape": "String", "documentation": "Not supported. Use IP permissions instead.
", "locationName": "ipProtocol" }, "ToPort": { "shape": "Integer", "documentation": "Not supported. Use IP permissions instead.
", "locationName": "toPort" }, "SourceSecurityGroupName": { "shape": "String", "documentation": "Not supported. Use IP permissions instead.
", "locationName": "sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId": { "shape": "String", "documentation": "Not supported. Use IP permissions instead.
", "locationName": "sourceSecurityGroupOwnerId" } } }, "AuthorizeSecurityGroupEgressResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, returns an error.
Information about the outbound (egress) security group rules that were added.
", "locationName": "securityGroupRuleSet" } } }, "AuthorizeSecurityGroupIngressRequest": { "type": "structure", "members": { "CidrIp": { "shape": "String", "documentation": "The IPv4 address range, in CIDR format.
To specify an IPv6 address range, use IP permissions instead.
To specify multiple rules and descriptions for the rules, use IP permissions instead.
" }, "FromPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
To specify multiple rules and descriptions for the rules, use IP permissions instead.
" }, "GroupId": { "shape": "SecurityGroupId", "documentation": "The ID of the security group.
" }, "GroupName": { "shape": "SecurityGroupName", "documentation": "[Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
" }, "IpPermissions": { "shape": "IpPermissionList", "documentation": "The permissions for the security group rules.
" }, "IpProtocol": { "shape": "String", "documentation": "The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify all protocols, use -1.
To specify icmpv6, use IP permissions instead.
If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
To specify multiple rules and descriptions for the rules, use IP permissions instead.
" }, "SourceSecurityGroupName": { "shape": "String", "documentation": "[Default VPC] The name of the source security group.
The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
" }, "SourceSecurityGroupOwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
" }, "ToPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
To specify multiple rules and descriptions for the rules, use IP permissions instead.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tags applied to the security group rule.
", "locationName": "TagSpecification" } } }, "AuthorizeSecurityGroupIngressResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, returns an error.
Information about the inbound (ingress) security group rules that were added.
", "locationName": "securityGroupRuleSet" } } }, "AutoAcceptSharedAssociationsValue": { "type": "string", "enum": [ "enable", "disable" ] }, "AutoAcceptSharedAttachmentsValue": { "type": "string", "enum": [ "enable", "disable" ] }, "AutoPlacement": { "type": "string", "enum": [ "on", "off" ] }, "AutoRecoveryFlag": { "type": "boolean" }, "AvailabilityZone": { "type": "structure", "members": { "State": { "shape": "AvailabilityZoneState", "documentation": "The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.
For Availability Zones, this parameter always has the value of opt-in-not-required.
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in, and not-opted-in.
Any messages about the Availability Zone, Local Zone, or Wavelength Zone.
", "locationName": "messageSet" }, "RegionName": { "shape": "String", "documentation": "The name of the Region.
", "locationName": "regionName" }, "ZoneName": { "shape": "String", "documentation": "The name of the Availability Zone, Local Zone, or Wavelength Zone.
", "locationName": "zoneName" }, "ZoneId": { "shape": "String", "documentation": "The ID of the Availability Zone, Local Zone, or Wavelength Zone.
", "locationName": "zoneId" }, "GroupName": { "shape": "String", "documentation": "For Availability Zones, this parameter has the same value as the Region name.
For Local Zones, the name of the associated group, for example us-west-2-lax-1.
For Wavelength Zones, the name of the associated group, for example us-east-1-wl1-bos-wlz-1.
The name of the network border group.
", "locationName": "networkBorderGroup" }, "ZoneType": { "shape": "String", "documentation": "The type of zone. The valid values are availability-zone, local-zone, and wavelength-zone.
The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
", "locationName": "parentZoneName" }, "ParentZoneId": { "shape": "String", "documentation": "The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
", "locationName": "parentZoneId" } }, "documentation": "Describes Availability Zones, Local Zones, and Wavelength Zones.
" }, "AvailabilityZoneId": { "type": "string" }, "AvailabilityZoneList": { "type": "list", "member": { "shape": "AvailabilityZone", "locationName": "item" } }, "AvailabilityZoneMessage": { "type": "structure", "members": { "Message": { "shape": "String", "documentation": "The message about the Availability Zone, Local Zone, or Wavelength Zone.
", "locationName": "message" } }, "documentation": "Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.
" }, "AvailabilityZoneMessageList": { "type": "list", "member": { "shape": "AvailabilityZoneMessage", "locationName": "item" } }, "AvailabilityZoneName": { "type": "string" }, "AvailabilityZoneOptInStatus": { "type": "string", "enum": [ "opt-in-not-required", "opted-in", "not-opted-in" ] }, "AvailabilityZoneState": { "type": "string", "enum": [ "available", "information", "impaired", "unavailable", "constrained" ] }, "AvailabilityZoneStringList": { "type": "list", "member": { "shape": "String", "locationName": "AvailabilityZone" } }, "AvailableCapacity": { "type": "structure", "members": { "AvailableInstanceCapacity": { "shape": "AvailableInstanceCapacityList", "documentation": "The number of instances that can be launched onto the Dedicated Host depending on the host's available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.
", "locationName": "availableInstanceCapacity" }, "AvailableVCpus": { "shape": "Integer", "documentation": "The number of vCPUs available for launching instances onto the Dedicated Host.
", "locationName": "availableVCpus" } }, "documentation": "The capacity information for instances that can be launched onto the Dedicated Host.
" }, "AvailableInstanceCapacityList": { "type": "list", "member": { "shape": "InstanceCapacity", "locationName": "item" } }, "BareMetal": { "type": "string", "enum": [ "included", "required", "excluded" ] }, "BareMetalFlag": { "type": "boolean" }, "BaselineBandwidthInGbps": { "type": "double" }, "BaselineBandwidthInMbps": { "type": "integer" }, "BaselineEbsBandwidthMbps": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.
", "locationName": "min" }, "Max": { "shape": "Integer", "documentation": "The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
" }, "BaselineEbsBandwidthMbpsRequest": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
" }, "Max": { "shape": "Integer", "documentation": "The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
" } }, "documentation": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
" }, "BaselineIops": { "type": "integer" }, "BaselineThroughputInMBps": { "type": "double" }, "BatchState": { "type": "string", "enum": [ "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating", "modifying" ] }, "BgpStatus": { "type": "string", "enum": [ "up", "down" ] }, "BillingProductList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "Blob": { "type": "blob" }, "BlobAttributeValue": { "type": "structure", "members": { "Value": { "shape": "Blob", "locationName": "value" } } }, "BlockDeviceMapping": { "type": "structure", "members": { "DeviceName": { "shape": "String", "documentation": "The device name (for example, /dev/sdh or xvdh).
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
", "locationName": "virtualName" }, "Ebs": { "shape": "EbsBlockDevice", "documentation": "Parameters used to automatically set up EBS volumes when the instance is launched.
", "locationName": "ebs" }, "NoDevice": { "shape": "String", "documentation": "To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
", "locationName": "noDevice" } }, "documentation": "Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.
" }, "BlockDeviceMappingList": { "type": "list", "member": { "shape": "BlockDeviceMapping", "locationName": "item" } }, "BlockDeviceMappingRequestList": { "type": "list", "member": { "shape": "BlockDeviceMapping", "locationName": "BlockDeviceMapping" } }, "Boolean": { "type": "boolean" }, "BootModeType": { "type": "string", "enum": [ "legacy-bios", "uefi" ] }, "BootModeTypeList": { "type": "list", "member": { "shape": "BootModeType", "locationName": "item" } }, "BootModeValues": { "type": "string", "enum": [ "legacy-bios", "uefi", "uefi-preferred" ] }, "BoxedDouble": { "type": "double" }, "BoxedInteger": { "type": "integer" }, "BundleId": { "type": "string" }, "BundleIdStringList": { "type": "list", "member": { "shape": "BundleId", "locationName": "BundleId" } }, "BundleInstanceRequest": { "type": "structure", "required": [ "InstanceId", "Storage" ], "members": { "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance to bundle.
Default: None
" }, "Storage": { "shape": "Storage", "documentation": "The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for BundleInstance.
" }, "BundleInstanceResult": { "type": "structure", "members": { "BundleTask": { "shape": "BundleTask", "documentation": "Information about the bundle task.
", "locationName": "bundleInstanceTask" } }, "documentation": "Contains the output of BundleInstance.
" }, "BundleTask": { "type": "structure", "members": { "BundleId": { "shape": "String", "documentation": "The ID of the bundle task.
", "locationName": "bundleId" }, "BundleTaskError": { "shape": "BundleTaskError", "documentation": "If the task fails, a description of the error.
", "locationName": "error" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance associated with this bundle task.
", "locationName": "instanceId" }, "Progress": { "shape": "String", "documentation": "The level of task completion, as a percent (for example, 20%).
", "locationName": "progress" }, "StartTime": { "shape": "DateTime", "documentation": "The time this task started.
", "locationName": "startTime" }, "State": { "shape": "BundleTaskState", "documentation": "The state of the task.
", "locationName": "state" }, "Storage": { "shape": "Storage", "documentation": "The Amazon S3 storage locations.
", "locationName": "storage" }, "UpdateTime": { "shape": "DateTime", "documentation": "The time of the most recent update for the task.
", "locationName": "updateTime" } }, "documentation": "Describes a bundle task.
" }, "BundleTaskError": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The error message.
", "locationName": "message" } }, "documentation": "Describes an error for BundleInstance.
" }, "BundleTaskList": { "type": "list", "member": { "shape": "BundleTask", "locationName": "item" } }, "BundleTaskState": { "type": "string", "enum": [ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "BurstablePerformance": { "type": "string", "enum": [ "included", "required", "excluded" ] }, "BurstablePerformanceFlag": { "type": "boolean" }, "Byoasn": { "type": "structure", "members": { "Asn": { "shape": "String", "documentation": "A public 2-byte or 4-byte ASN.
", "locationName": "asn" }, "IpamId": { "shape": "IpamId", "documentation": "An IPAM ID.
", "locationName": "ipamId" }, "StatusMessage": { "shape": "String", "documentation": "The status message.
", "locationName": "statusMessage" }, "State": { "shape": "AsnState", "documentation": "The provisioning state of the BYOASN.
", "locationName": "state" } }, "documentation": "The Autonomous System Number (ASN) and BYOIP CIDR association.
" }, "ByoasnSet": { "type": "list", "member": { "shape": "Byoasn", "locationName": "item" } }, "ByoipCidr": { "type": "structure", "members": { "Cidr": { "shape": "String", "documentation": "The address range, in CIDR notation.
", "locationName": "cidr" }, "Description": { "shape": "String", "documentation": "The description of the address range.
", "locationName": "description" }, "AsnAssociations": { "shape": "AsnAssociationSet", "documentation": "The BYOIP CIDR associations with ASNs.
", "locationName": "asnAssociationSet" }, "StatusMessage": { "shape": "String", "documentation": "Upon success, contains the ID of the address pool. Otherwise, contains an error message.
", "locationName": "statusMessage" }, "State": { "shape": "ByoipCidrState", "documentation": "The state of the address pool.
", "locationName": "state" }, "NetworkBorderGroup": { "shape": "String", "documentation": "If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
" }, "ByoipCidrSet": { "type": "list", "member": { "shape": "ByoipCidr", "locationName": "item" } }, "ByoipCidrState": { "type": "string", "enum": [ "advertised", "deprovisioned", "failed-deprovision", "failed-provision", "pending-deprovision", "pending-provision", "provisioned", "provisioned-not-publicly-advertisable" ] }, "CancelBatchErrorCode": { "type": "string", "enum": [ "fleetRequestIdDoesNotExist", "fleetRequestIdMalformed", "fleetRequestNotInCancellableState", "unexpectedError" ] }, "CancelBundleTaskRequest": { "type": "structure", "required": [ "BundleId" ], "members": { "BundleId": { "shape": "BundleId", "documentation": "The ID of the bundle task.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for CancelBundleTask.
" }, "CancelBundleTaskResult": { "type": "structure", "members": { "BundleTask": { "shape": "BundleTask", "documentation": "Information about the bundle task.
", "locationName": "bundleInstanceTask" } }, "documentation": "Contains the output of CancelBundleTask.
" }, "CancelCapacityReservationFleetError": { "type": "structure", "members": { "Code": { "shape": "CancelCapacityReservationFleetErrorCode", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "CancelCapacityReservationFleetErrorMessage", "documentation": "The error message.
", "locationName": "message" } }, "documentation": "Describes a Capacity Reservation Fleet cancellation error.
" }, "CancelCapacityReservationFleetErrorCode": { "type": "string" }, "CancelCapacityReservationFleetErrorMessage": { "type": "string" }, "CancelCapacityReservationFleetsRequest": { "type": "structure", "required": [ "CapacityReservationFleetIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the Capacity Reservation Fleets to cancel.
", "locationName": "CapacityReservationFleetId" } } }, "CancelCapacityReservationFleetsResult": { "type": "structure", "members": { "SuccessfulFleetCancellations": { "shape": "CapacityReservationFleetCancellationStateSet", "documentation": "Information about the Capacity Reservation Fleets that were successfully cancelled.
", "locationName": "successfulFleetCancellationSet" }, "FailedFleetCancellations": { "shape": "FailedCapacityReservationFleetCancellationResultSet", "documentation": "Information about the Capacity Reservation Fleets that could not be cancelled.
", "locationName": "failedFleetCancellationSet" } } }, "CancelCapacityReservationRequest": { "type": "structure", "required": [ "CapacityReservationId" ], "members": { "CapacityReservationId": { "shape": "CapacityReservationId", "documentation": "The ID of the Capacity Reservation to be cancelled.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the conversion task.
", "locationName": "conversionTaskId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The reason for canceling the conversion task.
", "locationName": "reasonMessage" } } }, "CancelExportTaskRequest": { "type": "structure", "required": [ "ExportTaskId" ], "members": { "ExportTaskId": { "shape": "ExportVmTaskId", "documentation": "The ID of the export task. This is the ID returned by the CreateInstanceExportTask and ExportImage operations.
The ID of the AMI that was shared with your Amazon Web Services account.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
The reason for canceling the task.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the import image or import snapshot task to be canceled.
" } } }, "CancelImportTaskResult": { "type": "structure", "members": { "ImportTaskId": { "shape": "String", "documentation": "The ID of the task being canceled.
", "locationName": "importTaskId" }, "PreviousState": { "shape": "String", "documentation": "The current state of the task being canceled.
", "locationName": "previousState" }, "State": { "shape": "String", "documentation": "The current state of the task being canceled.
", "locationName": "state" } } }, "CancelReservedInstancesListingRequest": { "type": "structure", "required": [ "ReservedInstancesListingId" ], "members": { "ReservedInstancesListingId": { "shape": "ReservedInstancesListingId", "documentation": "The ID of the Reserved Instance listing.
", "locationName": "reservedInstancesListingId" } }, "documentation": "Contains the parameters for CancelReservedInstancesListing.
" }, "CancelReservedInstancesListingResult": { "type": "structure", "members": { "ReservedInstancesListings": { "shape": "ReservedInstancesListingList", "documentation": "The Reserved Instance listing.
", "locationName": "reservedInstancesListingsSet" } }, "documentation": "Contains the output of CancelReservedInstancesListing.
" }, "CancelSpotFleetRequestsError": { "type": "structure", "members": { "Code": { "shape": "CancelBatchErrorCode", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The description for the error code.
", "locationName": "message" } }, "documentation": "Describes a Spot Fleet error.
" }, "CancelSpotFleetRequestsErrorItem": { "type": "structure", "members": { "Error": { "shape": "CancelSpotFleetRequestsError", "documentation": "The error.
", "locationName": "error" }, "SpotFleetRequestId": { "shape": "String", "documentation": "The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" } }, "documentation": "Describes a Spot Fleet request that was not successfully canceled.
" }, "CancelSpotFleetRequestsErrorSet": { "type": "list", "member": { "shape": "CancelSpotFleetRequestsErrorItem", "locationName": "item" } }, "CancelSpotFleetRequestsRequest": { "type": "structure", "required": [ "SpotFleetRequestIds", "TerminateInstances" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the Spot Fleet requests.
Constraint: You can specify up to 100 IDs in a single request.
", "locationName": "spotFleetRequestId" }, "TerminateInstances": { "shape": "Boolean", "documentation": "Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. The default is to terminate the instances.
To let the instances continue to run after the Spot Fleet request is canceled, specify no-terminate-instances.
Contains the parameters for CancelSpotFleetRequests.
" }, "CancelSpotFleetRequestsResponse": { "type": "structure", "members": { "SuccessfulFleetRequests": { "shape": "CancelSpotFleetRequestsSuccessSet", "documentation": "Information about the Spot Fleet requests that are successfully canceled.
", "locationName": "successfulFleetRequestSet" }, "UnsuccessfulFleetRequests": { "shape": "CancelSpotFleetRequestsErrorSet", "documentation": "Information about the Spot Fleet requests that are not successfully canceled.
", "locationName": "unsuccessfulFleetRequestSet" } }, "documentation": "Contains the output of CancelSpotFleetRequests.
" }, "CancelSpotFleetRequestsSuccessItem": { "type": "structure", "members": { "CurrentSpotFleetRequestState": { "shape": "BatchState", "documentation": "The current state of the Spot Fleet request.
", "locationName": "currentSpotFleetRequestState" }, "PreviousSpotFleetRequestState": { "shape": "BatchState", "documentation": "The previous state of the Spot Fleet request.
", "locationName": "previousSpotFleetRequestState" }, "SpotFleetRequestId": { "shape": "String", "documentation": "The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" } }, "documentation": "Describes a Spot Fleet request that was successfully canceled.
" }, "CancelSpotFleetRequestsSuccessSet": { "type": "list", "member": { "shape": "CancelSpotFleetRequestsSuccessItem", "locationName": "item" } }, "CancelSpotInstanceRequestState": { "type": "string", "enum": [ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest": { "type": "structure", "required": [ "SpotInstanceRequestIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the Spot Instance requests.
", "locationName": "SpotInstanceRequestId" } }, "documentation": "Contains the parameters for CancelSpotInstanceRequests.
" }, "CancelSpotInstanceRequestsResult": { "type": "structure", "members": { "CancelledSpotInstanceRequests": { "shape": "CancelledSpotInstanceRequestList", "documentation": "The Spot Instance requests.
", "locationName": "spotInstanceRequestSet" } }, "documentation": "Contains the output of CancelSpotInstanceRequests.
" }, "CancelledSpotInstanceRequest": { "type": "structure", "members": { "SpotInstanceRequestId": { "shape": "String", "documentation": "The ID of the Spot Instance request.
", "locationName": "spotInstanceRequestId" }, "State": { "shape": "CancelSpotInstanceRequestState", "documentation": "The state of the Spot Instance request.
", "locationName": "state" } }, "documentation": "Describes a request to cancel a Spot Instance.
" }, "CancelledSpotInstanceRequestList": { "type": "list", "member": { "shape": "CancelledSpotInstanceRequest", "locationName": "item" } }, "CapacityAllocation": { "type": "structure", "members": { "AllocationType": { "shape": "AllocationType", "documentation": "The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
Information about instance capacity usage for a Capacity Reservation.
" }, "CapacityAllocations": { "type": "list", "member": { "shape": "CapacityAllocation", "locationName": "item" } }, "CapacityBlockOffering": { "type": "structure", "members": { "CapacityBlockOfferingId": { "shape": "OfferingId", "documentation": "The ID of the Capacity Block offering.
", "locationName": "capacityBlockOfferingId" }, "InstanceType": { "shape": "String", "documentation": "The instance type of the Capacity Block offering.
", "locationName": "instanceType" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone of the Capacity Block offering.
", "locationName": "availabilityZone" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of instances in the Capacity Block offering.
", "locationName": "instanceCount" }, "StartDate": { "shape": "MillisecondDateTime", "documentation": "The start date of the Capacity Block offering.
", "locationName": "startDate" }, "EndDate": { "shape": "MillisecondDateTime", "documentation": "The end date of the Capacity Block offering.
", "locationName": "endDate" }, "CapacityBlockDurationHours": { "shape": "Integer", "documentation": "The amount of time of the Capacity Block reservation in hours.
", "locationName": "capacityBlockDurationHours" }, "UpfrontFee": { "shape": "String", "documentation": "The total price to be paid up front.
", "locationName": "upfrontFee" }, "CurrencyCode": { "shape": "String", "documentation": "The currency of the payment for the Capacity Block.
", "locationName": "currencyCode" }, "Tenancy": { "shape": "CapacityReservationTenancy", "documentation": "The tenancy of the Capacity Block.
", "locationName": "tenancy" } }, "documentation": "The recommended Capacity Block that fits your search requirements.
" }, "CapacityBlockOfferingSet": { "type": "list", "member": { "shape": "CapacityBlockOffering", "locationName": "item" } }, "CapacityReservation": { "type": "structure", "members": { "CapacityReservationId": { "shape": "String", "documentation": "The ID of the Capacity Reservation.
", "locationName": "capacityReservationId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the Capacity Reservation.
", "locationName": "ownerId" }, "CapacityReservationArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Capacity Reservation.
", "locationName": "capacityReservationArn" }, "AvailabilityZoneId": { "shape": "String", "documentation": "The Availability Zone ID of the Capacity Reservation.
", "locationName": "availabilityZoneId" }, "InstanceType": { "shape": "String", "documentation": "The type of instance for which the Capacity Reservation reserves capacity.
", "locationName": "instanceType" }, "InstancePlatform": { "shape": "CapacityReservationInstancePlatform", "documentation": "The type of operating system for which the Capacity Reservation reserves capacity.
", "locationName": "instancePlatform" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which the capacity is reserved.
", "locationName": "availabilityZone" }, "Tenancy": { "shape": "CapacityReservationTenancy", "documentation": "Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The total number of instances for which the Capacity Reservation reserves capacity.
", "locationName": "totalInstanceCount" }, "AvailableInstanceCount": { "shape": "Integer", "documentation": "The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
", "locationName": "availableInstanceCount" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
", "locationName": "ebsOptimized" }, "EphemeralStorage": { "shape": "Boolean", "documentation": "Deprecated.
", "locationName": "ephemeralStorage" }, "State": { "shape": "CapacityReservationState", "documentation": "The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
The date and time at which the Capacity Reservation was started.
", "locationName": "startDate" }, "EndDate": { "shape": "DateTime", "documentation": "The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
The date and time at which the Capacity Reservation was created.
", "locationName": "createDate" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the Capacity Reservation.
", "locationName": "tagSet" }, "OutpostArn": { "shape": "OutpostArn", "documentation": "The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
", "locationName": "outpostArn" }, "CapacityReservationFleetId": { "shape": "String", "documentation": "The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
", "locationName": "capacityReservationFleetId" }, "PlacementGroupArn": { "shape": "PlacementGroupArn", "documentation": "The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
", "locationName": "placementGroupArn" }, "CapacityAllocations": { "shape": "CapacityAllocations", "documentation": "Information about instance capacity usage.
", "locationName": "capacityAllocationSet" }, "ReservationType": { "shape": "CapacityReservationType", "documentation": "The type of Capacity Reservation.
", "locationName": "reservationType" } }, "documentation": "Describes a Capacity Reservation.
" }, "CapacityReservationFleet": { "type": "structure", "members": { "CapacityReservationFleetId": { "shape": "CapacityReservationFleetId", "documentation": "The ID of the Capacity Reservation Fleet.
", "locationName": "capacityReservationFleetId" }, "CapacityReservationFleetArn": { "shape": "String", "documentation": "The ARN of the Capacity Reservation Fleet.
", "locationName": "capacityReservationFleetArn" }, "State": { "shape": "CapacityReservationFleetState", "documentation": "The state of the Capacity Reservation Fleet. Possible states include:
submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.
modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.
active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.
partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.
expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.
expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.
cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.
cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.
failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.
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.
", "locationName": "totalTargetCapacity" }, "TotalFulfilledCapacity": { "shape": "Double", "documentation": "The capacity units that have been fulfilled.
", "locationName": "totalFulfilledCapacity" }, "Tenancy": { "shape": "FleetCapacityReservationTenancy", "documentation": "The tenancy of the Capacity Reservation Fleet. Tenancies include:
default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The date and time at which the Capacity Reservation Fleet expires.
", "locationName": "endDate" }, "CreateTime": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the Capacity Reservation Fleet was created.
", "locationName": "createTime" }, "InstanceMatchCriteria": { "shape": "FleetInstanceMatchCriteria", "documentation": "Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
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.
", "locationName": "allocationStrategy" }, "InstanceTypeSpecifications": { "shape": "FleetCapacityReservationSet", "documentation": "Information about the instance types for which to reserve the capacity.
", "locationName": "instanceTypeSpecificationSet" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the Capacity Reservation Fleet.
", "locationName": "tagSet" } }, "documentation": "Information about a Capacity Reservation Fleet.
" }, "CapacityReservationFleetCancellationState": { "type": "structure", "members": { "CurrentFleetState": { "shape": "CapacityReservationFleetState", "documentation": "The current state of the Capacity Reservation Fleet.
", "locationName": "currentFleetState" }, "PreviousFleetState": { "shape": "CapacityReservationFleetState", "documentation": "The previous state of the Capacity Reservation Fleet.
", "locationName": "previousFleetState" }, "CapacityReservationFleetId": { "shape": "CapacityReservationFleetId", "documentation": "The ID of the Capacity Reservation Fleet that was successfully cancelled.
", "locationName": "capacityReservationFleetId" } }, "documentation": "Describes a Capacity Reservation Fleet that was successfully cancelled.
" }, "CapacityReservationFleetCancellationStateSet": { "type": "list", "member": { "shape": "CapacityReservationFleetCancellationState", "locationName": "item" } }, "CapacityReservationFleetId": { "type": "string" }, "CapacityReservationFleetIdSet": { "type": "list", "member": { "shape": "CapacityReservationFleetId", "locationName": "item" } }, "CapacityReservationFleetSet": { "type": "list", "member": { "shape": "CapacityReservationFleet", "locationName": "item" } }, "CapacityReservationFleetState": { "type": "string", "enum": [ "submitted", "modifying", "active", "partially_fulfilled", "expiring", "expired", "cancelling", "cancelled", "failed" ] }, "CapacityReservationGroup": { "type": "structure", "members": { "GroupArn": { "shape": "String", "documentation": "The ARN of the resource group.
", "locationName": "groupArn" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the resource group.
", "locationName": "ownerId" } }, "documentation": "Describes a resource group to which a Capacity Reservation has been added.
" }, "CapacityReservationGroupSet": { "type": "list", "member": { "shape": "CapacityReservationGroup", "locationName": "item" } }, "CapacityReservationId": { "type": "string" }, "CapacityReservationIdSet": { "type": "list", "member": { "shape": "CapacityReservationId", "locationName": "item" } }, "CapacityReservationInstancePlatform": { "type": "string", "enum": [ "Linux/UNIX", "Red Hat Enterprise Linux", "SUSE Linux", "Windows", "Windows with SQL Server", "Windows with SQL Server Enterprise", "Windows with SQL Server Standard", "Windows with SQL Server Web", "Linux with SQL Server Standard", "Linux with SQL Server Web", "Linux with SQL Server Enterprise", "RHEL with SQL Server Standard", "RHEL with SQL Server Enterprise", "RHEL with SQL Server Web", "RHEL with HA", "RHEL with HA and SQL Server Standard", "RHEL with HA and SQL Server Enterprise", "Ubuntu Pro" ] }, "CapacityReservationOptions": { "type": "structure", "members": { "UsageStrategy": { "shape": "FleetCapacityReservationUsageStrategy", "documentation": "Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
", "locationName": "usageStrategy" } }, "documentation": "Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.
" }, "CapacityReservationOptionsRequest": { "type": "structure", "members": { "UsageStrategy": { "shape": "FleetCapacityReservationUsageStrategy", "documentation": "Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
" } }, "documentation": "Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.
" }, "CapacityReservationPreference": { "type": "string", "enum": [ "open", "none" ] }, "CapacityReservationSet": { "type": "list", "member": { "shape": "CapacityReservation", "locationName": "item" } }, "CapacityReservationSpecification": { "type": "structure", "members": { "CapacityReservationPreference": { "shape": "CapacityReservationPreference", "documentation": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
Information about the target Capacity Reservation or Capacity Reservation group.
" } }, "documentation": "Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
Describes the instance's Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
Information about the targeted Capacity Reservation or Capacity Reservation group.
", "locationName": "capacityReservationTarget" } }, "documentation": "Describes the instance's Capacity Reservation targeting preferences. The action returns the capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.
The ID of the Capacity Reservation in which to run the instance.
" }, "CapacityReservationResourceGroupArn": { "shape": "String", "documentation": "The ARN of the Capacity Reservation resource group in which to run the instance.
" } }, "documentation": "Describes a target Capacity Reservation or Capacity Reservation group.
" }, "CapacityReservationTargetResponse": { "type": "structure", "members": { "CapacityReservationId": { "shape": "String", "documentation": "The ID of the targeted Capacity Reservation.
", "locationName": "capacityReservationId" }, "CapacityReservationResourceGroupArn": { "shape": "String", "documentation": "The ARN of the targeted Capacity Reservation group.
", "locationName": "capacityReservationResourceGroupArn" } }, "documentation": "Describes a target Capacity Reservation or Capacity Reservation group.
" }, "CapacityReservationTenancy": { "type": "string", "enum": [ "default", "dedicated" ] }, "CapacityReservationType": { "type": "string", "enum": [ "default", "capacity-block" ] }, "CarrierGateway": { "type": "structure", "members": { "CarrierGatewayId": { "shape": "CarrierGatewayId", "documentation": "The ID of the carrier gateway.
", "locationName": "carrierGatewayId" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC associated with the carrier gateway.
", "locationName": "vpcId" }, "State": { "shape": "CarrierGatewayState", "documentation": "The state of the carrier gateway.
", "locationName": "state" }, "OwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID of the owner of the carrier gateway.
", "locationName": "ownerId" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the carrier gateway.
", "locationName": "tagSet" } }, "documentation": "Describes a carrier gateway.
" }, "CarrierGatewayId": { "type": "string" }, "CarrierGatewayIdSet": { "type": "list", "member": { "shape": "CarrierGatewayId" } }, "CarrierGatewayMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "CarrierGatewaySet": { "type": "list", "member": { "shape": "CarrierGateway", "locationName": "item" } }, "CarrierGatewayState": { "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ] }, "CertificateArn": { "type": "string" }, "CertificateAuthentication": { "type": "structure", "members": { "ClientRootCertificateChain": { "shape": "String", "documentation": "The ARN of the client certificate.
", "locationName": "clientRootCertificateChain" } }, "documentation": "Information about the client certificate used for authentication.
" }, "CertificateAuthenticationRequest": { "type": "structure", "members": { "ClientRootCertificateChainArn": { "shape": "String", "documentation": "The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in Certificate Manager (ACM).
" } }, "documentation": "Information about the client certificate to be used for authentication.
" }, "CertificateId": { "type": "string" }, "CidrAuthorizationContext": { "type": "structure", "required": [ "Message", "Signature" ], "members": { "Message": { "shape": "String", "documentation": "The plain-text authorization message for the prefix and account.
" }, "Signature": { "shape": "String", "documentation": "The signed authorization message for the prefix and account.
" } }, "documentation": "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.
" }, "CidrBlock": { "type": "structure", "members": { "CidrBlock": { "shape": "String", "documentation": "The IPv4 CIDR block.
", "locationName": "cidrBlock" } }, "documentation": "Describes an IPv4 CIDR block.
" }, "CidrBlockSet": { "type": "list", "member": { "shape": "CidrBlock", "locationName": "item" } }, "ClassicLinkDnsSupport": { "type": "structure", "members": { "ClassicLinkDnsSupported": { "shape": "Boolean", "documentation": "Indicates whether ClassicLink DNS support is enabled for the VPC.
", "locationName": "classicLinkDnsSupported" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" } }, "documentation": "Deprecated.
Describes the ClassicLink DNS support status of a VPC.
" }, "ClassicLinkDnsSupportList": { "type": "list", "member": { "shape": "ClassicLinkDnsSupport", "locationName": "item" } }, "ClassicLinkInstance": { "type": "structure", "members": { "Groups": { "shape": "GroupIdentifierList", "documentation": "The security groups.
", "locationName": "groupSet" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the instance.
", "locationName": "tagSet" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" } }, "documentation": "Deprecated.
Describes a linked EC2-Classic instance.
" }, "ClassicLinkInstanceList": { "type": "list", "member": { "shape": "ClassicLinkInstance", "locationName": "item" } }, "ClassicLoadBalancer": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of the load balancer.
", "locationName": "name" } }, "documentation": "Describes a Classic Load Balancer.
" }, "ClassicLoadBalancers": { "type": "list", "member": { "shape": "ClassicLoadBalancer", "locationName": "item" }, "max": 5, "min": 1 }, "ClassicLoadBalancersConfig": { "type": "structure", "members": { "ClassicLoadBalancers": { "shape": "ClassicLoadBalancers", "documentation": "One or more Classic Load Balancers.
", "locationName": "classicLoadBalancers" } }, "documentation": "Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.
" }, "ClientCertificateRevocationListStatus": { "type": "structure", "members": { "Code": { "shape": "ClientCertificateRevocationListStatusCode", "documentation": "The state of the client certificate revocation list.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "A message about the status of the client certificate revocation list, if applicable.
", "locationName": "message" } }, "documentation": "Describes the state of a client certificate revocation list.
" }, "ClientCertificateRevocationListStatusCode": { "type": "string", "enum": [ "pending", "active" ] }, "ClientConnectOptions": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether client connect options are enabled. The default is false (not enabled).
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
" } }, "documentation": "The options for managing connection authorization for new client connections.
" }, "ClientConnectResponseOptions": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether client connect options are enabled.
", "locationName": "enabled" }, "LambdaFunctionArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
", "locationName": "lambdaFunctionArn" }, "Status": { "shape": "ClientVpnEndpointAttributeStatus", "documentation": "The status of any updates to the client connect options.
", "locationName": "status" } }, "documentation": "The options for managing connection authorization for new client connections.
" }, "ClientData": { "type": "structure", "members": { "Comment": { "shape": "String", "documentation": "A user-defined comment about the disk upload.
" }, "UploadEnd": { "shape": "DateTime", "documentation": "The time that the disk upload ends.
" }, "UploadSize": { "shape": "Double", "documentation": "The size of the uploaded disk image, in GiB.
" }, "UploadStart": { "shape": "DateTime", "documentation": "The time that the disk upload starts.
" } }, "documentation": "Describes the client-specific data.
" }, "ClientLoginBannerOptions": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Valid values: true | false
Default value: false
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
" } }, "documentation": "Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
" }, "ClientLoginBannerResponseOptions": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Current state of text banner feature.
Valid values: true | false
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
", "locationName": "bannerText" } }, "documentation": "Current state of options for customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
" }, "ClientSecretType": { "type": "string", "sensitive": true }, "ClientVpnAuthentication": { "type": "structure", "members": { "Type": { "shape": "ClientVpnAuthenticationType", "documentation": "The authentication type used.
", "locationName": "type" }, "ActiveDirectory": { "shape": "DirectoryServiceAuthentication", "documentation": "Information about the Active Directory, if applicable.
", "locationName": "activeDirectory" }, "MutualAuthentication": { "shape": "CertificateAuthentication", "documentation": "Information about the authentication certificates, if applicable.
", "locationName": "mutualAuthentication" }, "FederatedAuthentication": { "shape": "FederatedAuthentication", "documentation": "Information about the IAM SAML identity provider, if applicable.
", "locationName": "federatedAuthentication" } }, "documentation": "Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.
" }, "ClientVpnAuthenticationList": { "type": "list", "member": { "shape": "ClientVpnAuthentication", "locationName": "item" } }, "ClientVpnAuthenticationRequest": { "type": "structure", "members": { "Type": { "shape": "ClientVpnAuthenticationType", "documentation": "The type of client authentication to be used.
" }, "ActiveDirectory": { "shape": "DirectoryServiceAuthenticationRequest", "documentation": "Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.
" }, "ClientVpnAuthenticationRequestList": { "type": "list", "member": { "shape": "ClientVpnAuthenticationRequest" } }, "ClientVpnAuthenticationType": { "type": "string", "enum": [ "certificate-authentication", "directory-service-authentication", "federated-authentication" ] }, "ClientVpnAuthorizationRuleStatus": { "type": "structure", "members": { "Code": { "shape": "ClientVpnAuthorizationRuleStatusCode", "documentation": "The state of the authorization rule.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "A message about the status of the authorization rule, if applicable.
", "locationName": "message" } }, "documentation": "Describes the state of an authorization rule.
" }, "ClientVpnAuthorizationRuleStatusCode": { "type": "string", "enum": [ "authorizing", "active", "failed", "revoking" ] }, "ClientVpnConnection": { "type": "structure", "members": { "ClientVpnEndpointId": { "shape": "String", "documentation": "The ID of the Client VPN endpoint to which the client is connected.
", "locationName": "clientVpnEndpointId" }, "Timestamp": { "shape": "String", "documentation": "The current date and time.
", "locationName": "timestamp" }, "ConnectionId": { "shape": "String", "documentation": "The ID of the client connection.
", "locationName": "connectionId" }, "Username": { "shape": "String", "documentation": "The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.
", "locationName": "username" }, "ConnectionEstablishedTime": { "shape": "String", "documentation": "The date and time the client connection was established.
", "locationName": "connectionEstablishedTime" }, "IngressBytes": { "shape": "String", "documentation": "The number of bytes sent by the client.
", "locationName": "ingressBytes" }, "EgressBytes": { "shape": "String", "documentation": "The number of bytes received by the client.
", "locationName": "egressBytes" }, "IngressPackets": { "shape": "String", "documentation": "The number of packets sent by the client.
", "locationName": "ingressPackets" }, "EgressPackets": { "shape": "String", "documentation": "The number of packets received by the client.
", "locationName": "egressPackets" }, "ClientIp": { "shape": "String", "documentation": "The IP address of the client.
", "locationName": "clientIp" }, "CommonName": { "shape": "String", "documentation": "The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.
", "locationName": "commonName" }, "Status": { "shape": "ClientVpnConnectionStatus", "documentation": "The current state of the client connection.
", "locationName": "status" }, "ConnectionEndTime": { "shape": "String", "documentation": "The date and time the client connection was terminated.
", "locationName": "connectionEndTime" }, "PostureComplianceStatuses": { "shape": "ValueStringList", "documentation": "The statuses returned by the client connect handler for posture compliance, if applicable.
", "locationName": "postureComplianceStatusSet" } }, "documentation": "Describes a client connection.
" }, "ClientVpnConnectionSet": { "type": "list", "member": { "shape": "ClientVpnConnection", "locationName": "item" } }, "ClientVpnConnectionStatus": { "type": "structure", "members": { "Code": { "shape": "ClientVpnConnectionStatusCode", "documentation": "The state of the client connection.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "A message about the status of the client connection, if applicable.
", "locationName": "message" } }, "documentation": "Describes the status of a client connection.
" }, "ClientVpnConnectionStatusCode": { "type": "string", "enum": [ "active", "failed-to-terminate", "terminating", "terminated" ] }, "ClientVpnEndpoint": { "type": "structure", "members": { "ClientVpnEndpointId": { "shape": "String", "documentation": "The ID of the Client VPN endpoint.
", "locationName": "clientVpnEndpointId" }, "Description": { "shape": "String", "documentation": "A brief description of the endpoint.
", "locationName": "description" }, "Status": { "shape": "ClientVpnEndpointStatus", "documentation": "The current state of the Client VPN endpoint.
", "locationName": "status" }, "CreationTime": { "shape": "String", "documentation": "The date and time the Client VPN endpoint was created.
", "locationName": "creationTime" }, "DeletionTime": { "shape": "String", "documentation": "The date and time the Client VPN endpoint was deleted, if applicable.
", "locationName": "deletionTime" }, "DnsName": { "shape": "String", "documentation": "The DNS name to be used by clients when connecting to the Client VPN endpoint.
", "locationName": "dnsName" }, "ClientCidrBlock": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
", "locationName": "clientCidrBlock" }, "DnsServers": { "shape": "ValueStringList", "documentation": "Information about the DNS servers to be used for DNS resolution.
", "locationName": "dnsServer" }, "SplitTunnel": { "shape": "Boolean", "documentation": "Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
", "locationName": "splitTunnel" }, "VpnProtocol": { "shape": "VpnProtocol", "documentation": "The protocol used by the VPN session.
", "locationName": "vpnProtocol" }, "TransportProtocol": { "shape": "TransportProtocol", "documentation": "The transport protocol used by the Client VPN endpoint.
", "locationName": "transportProtocol" }, "VpnPort": { "shape": "Integer", "documentation": "The port number for the Client VPN endpoint.
", "locationName": "vpnPort" }, "AssociatedTargetNetworks": { "shape": "AssociatedTargetNetworkSet", "documentation": "Information about the associated target networks. A target network is a subnet in a VPC.
", "deprecated": true, "deprecatedMessage": "This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.", "locationName": "associatedTargetNetwork" }, "ServerCertificateArn": { "shape": "String", "documentation": "The ARN of the server certificate.
", "locationName": "serverCertificateArn" }, "AuthenticationOptions": { "shape": "ClientVpnAuthenticationList", "documentation": "Information about the authentication method used by the Client VPN endpoint.
", "locationName": "authenticationOptions" }, "ConnectionLogOptions": { "shape": "ConnectionLogResponseOptions", "documentation": "Information about the client connection logging options for the Client VPN endpoint.
", "locationName": "connectionLogOptions" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the Client VPN endpoint.
", "locationName": "tagSet" }, "SecurityGroupIds": { "shape": "ClientVpnSecurityGroupIdSet", "documentation": "The IDs of the security groups for the target network.
", "locationName": "securityGroupIdSet" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "SelfServicePortalUrl": { "shape": "String", "documentation": "The URL of the self-service portal.
", "locationName": "selfServicePortalUrl" }, "ClientConnectOptions": { "shape": "ClientConnectResponseOptions", "documentation": "The options for managing connection authorization for new client connections.
", "locationName": "clientConnectOptions" }, "SessionTimeoutHours": { "shape": "Integer", "documentation": "The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
", "locationName": "clientLoginBannerOptions" } }, "documentation": "Describes a Client VPN endpoint.
" }, "ClientVpnEndpointAttributeStatus": { "type": "structure", "members": { "Code": { "shape": "ClientVpnEndpointAttributeStatusCode", "documentation": "The status code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The status message.
", "locationName": "message" } }, "documentation": "Describes the status of the Client VPN endpoint attribute.
" }, "ClientVpnEndpointAttributeStatusCode": { "type": "string", "enum": [ "applying", "applied" ] }, "ClientVpnEndpointId": { "type": "string" }, "ClientVpnEndpointIdList": { "type": "list", "member": { "shape": "ClientVpnEndpointId", "locationName": "item" } }, "ClientVpnEndpointStatus": { "type": "structure", "members": { "Code": { "shape": "ClientVpnEndpointStatusCode", "documentation": "The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
A message about the status of the Client VPN endpoint.
", "locationName": "message" } }, "documentation": "Describes the state of a Client VPN endpoint.
" }, "ClientVpnEndpointStatusCode": { "type": "string", "enum": [ "pending-associate", "available", "deleting", "deleted" ] }, "ClientVpnRoute": { "type": "structure", "members": { "ClientVpnEndpointId": { "shape": "String", "documentation": "The ID of the Client VPN endpoint with which the route is associated.
", "locationName": "clientVpnEndpointId" }, "DestinationCidr": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation, of the route destination.
", "locationName": "destinationCidr" }, "TargetSubnet": { "shape": "String", "documentation": "The ID of the subnet through which traffic is routed.
", "locationName": "targetSubnet" }, "Type": { "shape": "String", "documentation": "The route type.
", "locationName": "type" }, "Origin": { "shape": "String", "documentation": "Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.
The current state of the route.
", "locationName": "status" }, "Description": { "shape": "String", "documentation": "A brief description of the route.
", "locationName": "description" } }, "documentation": "Information about a Client VPN endpoint route.
" }, "ClientVpnRouteSet": { "type": "list", "member": { "shape": "ClientVpnRoute", "locationName": "item" } }, "ClientVpnRouteStatus": { "type": "structure", "members": { "Code": { "shape": "ClientVpnRouteStatusCode", "documentation": "The state of the Client VPN endpoint route.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "A message about the status of the Client VPN endpoint route, if applicable.
", "locationName": "message" } }, "documentation": "Describes the state of a Client VPN endpoint route.
" }, "ClientVpnRouteStatusCode": { "type": "string", "enum": [ "creating", "active", "failed", "deleting" ] }, "ClientVpnSecurityGroupIdSet": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "item" } }, "CloudWatchLogGroupArn": { "type": "string" }, "CloudWatchLogOptions": { "type": "structure", "members": { "LogEnabled": { "shape": "Boolean", "documentation": "Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
", "locationName": "logGroupArn" }, "LogOutputFormat": { "shape": "String", "documentation": "Configured log format. Default format is json.
Valid values: json | text
Options for sending VPN tunnel logs to CloudWatch.
" }, "CloudWatchLogOptionsSpecification": { "type": "structure", "members": { "LogEnabled": { "shape": "Boolean", "documentation": "Enable or disable VPN tunnel logging feature. Default value is False.
Valid values: True | False
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
" }, "LogOutputFormat": { "shape": "String", "documentation": "Set log format. Default format is json.
Valid values: json | text
Options for sending VPN tunnel logs to CloudWatch.
" }, "CoipAddressUsage": { "type": "structure", "members": { "AllocationId": { "shape": "String", "documentation": "The allocation ID of the address.
", "locationName": "allocationId" }, "AwsAccountId": { "shape": "String", "documentation": "The Amazon Web Services account ID.
", "locationName": "awsAccountId" }, "AwsService": { "shape": "String", "documentation": "The Amazon Web Services service.
", "locationName": "awsService" }, "CoIp": { "shape": "String", "documentation": "The customer-owned IP address.
", "locationName": "coIp" } }, "documentation": "Describes address usage for a customer-owned address pool.
" }, "CoipAddressUsageSet": { "type": "list", "member": { "shape": "CoipAddressUsage", "locationName": "item" } }, "CoipCidr": { "type": "structure", "members": { "Cidr": { "shape": "String", "documentation": "An address range in a customer-owned IP address space.
", "locationName": "cidr" }, "CoipPoolId": { "shape": "Ipv4PoolCoipId", "documentation": "The ID of the address pool.
", "locationName": "coipPoolId" }, "LocalGatewayRouteTableId": { "shape": "String", "documentation": "The ID of the local gateway route table.
", "locationName": "localGatewayRouteTableId" } }, "documentation": "Information about a customer-owned IP address range.
" }, "CoipPool": { "type": "structure", "members": { "PoolId": { "shape": "Ipv4PoolCoipId", "documentation": "The ID of the address pool.
", "locationName": "poolId" }, "PoolCidrs": { "shape": "ValueStringList", "documentation": "The address ranges of the address pool.
", "locationName": "poolCidrSet" }, "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
", "locationName": "localGatewayRouteTableId" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" }, "PoolArn": { "shape": "ResourceArn", "documentation": "The ARN of the address pool.
", "locationName": "poolArn" } }, "documentation": "Describes a customer-owned address pool.
" }, "CoipPoolId": { "type": "string" }, "CoipPoolIdSet": { "type": "list", "member": { "shape": "Ipv4PoolCoipId", "locationName": "item" } }, "CoipPoolMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "CoipPoolSet": { "type": "list", "member": { "shape": "CoipPool", "locationName": "item" } }, "ComponentAccount": { "type": "string", "pattern": "\\d{12}" }, "ComponentRegion": { "type": "string", "pattern": "[a-z]{2}-[a-z]+-[1-9]+" }, "ConfirmProductInstanceRequest": { "type": "structure", "required": [ "InstanceId", "ProductCode" ], "members": { "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance.
" }, "ProductCode": { "shape": "String", "documentation": "The product code. This must be a product code that you own.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The Amazon Web Services account ID of the instance owner. This is only present if the product code is attached to the instance.
", "locationName": "ownerId" }, "Return": { "shape": "Boolean", "documentation": "The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
Indicates whether connection logging is enabled.
" }, "CloudwatchLogGroup": { "shape": "String", "documentation": "The name of the CloudWatch Logs log group. Required if connection logging is enabled.
" }, "CloudwatchLogStream": { "shape": "String", "documentation": "The name of the CloudWatch Logs log stream to which the connection data is published.
" } }, "documentation": "Describes the client connection logging options for the Client VPN endpoint.
" }, "ConnectionLogResponseOptions": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether client connection logging is enabled for the Client VPN endpoint.
" }, "CloudwatchLogGroup": { "shape": "String", "documentation": "The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
" }, "CloudwatchLogStream": { "shape": "String", "documentation": "The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
" } }, "documentation": "Information about the client connection logging options for a Client VPN endpoint.
" }, "ConnectionNotification": { "type": "structure", "members": { "ConnectionNotificationId": { "shape": "String", "documentation": "The ID of the notification.
", "locationName": "connectionNotificationId" }, "ServiceId": { "shape": "String", "documentation": "The ID of the endpoint service.
", "locationName": "serviceId" }, "VpcEndpointId": { "shape": "String", "documentation": "The ID of the VPC endpoint.
", "locationName": "vpcEndpointId" }, "ConnectionNotificationType": { "shape": "ConnectionNotificationType", "documentation": "The type of notification.
", "locationName": "connectionNotificationType" }, "ConnectionNotificationArn": { "shape": "String", "documentation": "The ARN of the SNS topic for the notification.
", "locationName": "connectionNotificationArn" }, "ConnectionEvents": { "shape": "ValueStringList", "documentation": "The events for the notification. Valid values are Accept, Connect, Delete, and Reject.
The state of the notification.
", "locationName": "connectionNotificationState" } }, "documentation": "Describes a connection notification for a VPC endpoint or VPC endpoint service.
" }, "ConnectionNotificationId": { "type": "string" }, "ConnectionNotificationIdsList": { "type": "list", "member": { "shape": "ConnectionNotificationId", "locationName": "item" } }, "ConnectionNotificationSet": { "type": "list", "member": { "shape": "ConnectionNotification", "locationName": "item" } }, "ConnectionNotificationState": { "type": "string", "enum": [ "Enabled", "Disabled" ] }, "ConnectionNotificationType": { "type": "string", "enum": [ "Topic" ] }, "ConnectionTrackingConfiguration": { "type": "structure", "members": { "TcpEstablishedTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
", "locationName": "tcpEstablishedTimeout" }, "UdpStreamTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
", "locationName": "udpStreamTimeout" }, "UdpTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
", "locationName": "udpTimeout" } }, "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.
" }, "ConnectionTrackingSpecification": { "type": "structure", "members": { "TcpEstablishedTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
", "locationName": "tcpEstablishedTimeout" }, "UdpTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
", "locationName": "udpTimeout" }, "UdpStreamTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
", "locationName": "udpStreamTimeout" } }, "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.
" }, "ConnectionTrackingSpecificationRequest": { "type": "structure", "members": { "TcpEstablishedTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
" }, "UdpStreamTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
" }, "UdpTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
" } }, "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.
" }, "ConnectionTrackingSpecificationResponse": { "type": "structure", "members": { "TcpEstablishedTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
", "locationName": "tcpEstablishedTimeout" }, "UdpStreamTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
", "locationName": "udpStreamTimeout" }, "UdpTimeout": { "shape": "Integer", "documentation": "Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
", "locationName": "udpTimeout" } }, "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.
" }, "ConnectivityType": { "type": "string", "enum": [ "private", "public" ] }, "ContainerFormat": { "type": "string", "enum": [ "ova" ] }, "ConversionIdStringList": { "type": "list", "member": { "shape": "ConversionTaskId", "locationName": "item" } }, "ConversionTask": { "type": "structure", "members": { "ConversionTaskId": { "shape": "String", "documentation": "The ID of the conversion task.
", "locationName": "conversionTaskId" }, "ExpirationTime": { "shape": "String", "documentation": "The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
", "locationName": "expirationTime" }, "ImportInstance": { "shape": "ImportInstanceTaskDetails", "documentation": "If the task is for importing an instance, this contains information about the import instance task.
", "locationName": "importInstance" }, "ImportVolume": { "shape": "ImportVolumeTaskDetails", "documentation": "If the task is for importing a volume, this contains information about the import volume task.
", "locationName": "importVolume" }, "State": { "shape": "ConversionTaskState", "documentation": "The state of the conversion task.
", "locationName": "state" }, "StatusMessage": { "shape": "String", "documentation": "The status message related to the conversion task.
", "locationName": "statusMessage" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the task.
", "locationName": "tagSet" } }, "documentation": "Describes a conversion task.
" }, "ConversionTaskId": { "type": "string" }, "ConversionTaskState": { "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ] }, "CoolOffPeriodRequestHours": { "type": "integer", "max": 72, "min": 1 }, "CoolOffPeriodResponseHours": { "type": "integer" }, "CopyFpgaImageRequest": { "type": "structure", "required": [ "SourceFpgaImageId", "SourceRegion" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the source AFI.
" }, "Description": { "shape": "String", "documentation": "The description for the new AFI.
" }, "Name": { "shape": "String", "documentation": "The name for the new AFI. The default is the name of the source AFI.
" }, "SourceRegion": { "shape": "String", "documentation": "The Region that contains the source AFI.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
" } } }, "CopyFpgaImageResult": { "type": "structure", "members": { "FpgaImageId": { "shape": "String", "documentation": "The ID of the new AFI.
", "locationName": "fpgaImageId" } } }, "CopyImageRequest": { "type": "structure", "required": [ "Name", "SourceImageId", "SourceRegion" ], "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
" }, "Description": { "shape": "String", "documentation": "A description for the new AMI in the destination Region.
" }, "Encrypted": { "shape": "Boolean", "documentation": "Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.
You can specify a KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified KMS key must exist in the destination Region.
Amazon EBS does not support asymmetric KMS keys.
", "locationName": "kmsKeyId" }, "Name": { "shape": "String", "documentation": "The name of the new AMI in the destination Region.
" }, "SourceImageId": { "shape": "String", "documentation": "The ID of the AMI to copy.
" }, "SourceRegion": { "shape": "String", "documentation": "The name of the Region that contains the AMI to copy.
" }, "DestinationOutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether to include your user-defined AMI tags when copying the AMI.
The following tags will not be copied:
System tags (prefixed with aws:)
For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts
Default: Your user-defined AMI tags are not copied.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.
To tag the new AMI, the value for ResourceType must be image.
To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", "locationName": "TagSpecification" } }, "documentation": "Contains the parameters for CopyImage.
" }, "CopyImageResult": { "type": "structure", "members": { "ImageId": { "shape": "String", "documentation": "The ID of the new AMI.
", "locationName": "imageId" } }, "documentation": "Contains the output of CopyImage.
" }, "CopySnapshotRequest": { "type": "structure", "required": [ "SourceRegion", "SourceSnapshotId" ], "members": { "Description": { "shape": "String", "documentation": "A description for the EBS snapshot.
" }, "DestinationOutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
" }, "DestinationRegion": { "shape": "String", "documentation": "The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
", "locationName": "encrypted" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
", "locationName": "kmsKeyId" }, "PresignedUrl": { "shape": "CopySnapshotRequestPSU", "documentation": "When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using 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 invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
The ID of the Region that contains the snapshot to be copied.
" }, "SourceSnapshotId": { "shape": "String", "documentation": "The ID of the EBS snapshot to copy.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the new snapshot.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the new snapshot.
", "locationName": "snapshotId" }, "Tags": { "shape": "TagList", "documentation": "Any tags applied to the new snapshot.
", "locationName": "tagSet" } } }, "CopyTagsFromSource": { "type": "string", "enum": [ "volume" ] }, "CoreCount": { "type": "integer" }, "CoreCountList": { "type": "list", "member": { "shape": "CoreCount", "locationName": "item" } }, "CoreNetworkArn": { "type": "string" }, "CpuManufacturer": { "type": "string", "enum": [ "intel", "amd", "amazon-web-services" ] }, "CpuManufacturerName": { "type": "string" }, "CpuManufacturerSet": { "type": "list", "member": { "shape": "CpuManufacturer", "locationName": "item" } }, "CpuOptions": { "type": "structure", "members": { "CoreCount": { "shape": "Integer", "documentation": "The number of CPU cores for the instance.
", "locationName": "coreCount" }, "ThreadsPerCore": { "shape": "Integer", "documentation": "The number of threads per CPU core.
", "locationName": "threadsPerCore" }, "AmdSevSnp": { "shape": "AmdSevSnpSpecification", "documentation": "Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP.
", "locationName": "amdSevSnp" } }, "documentation": "The CPU options for the instance.
" }, "CpuOptionsRequest": { "type": "structure", "members": { "CoreCount": { "shape": "Integer", "documentation": "The number of CPU cores for the instance.
" }, "ThreadsPerCore": { "shape": "Integer", "documentation": "The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.
Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see AMD SEV-SNP.
" } }, "documentation": "The CPU options for the instance. Both the core count and threads per core must be specified in the request.
" }, "CreateCapacityReservationFleetRequest": { "type": "structure", "required": [ "InstanceTypeSpecifications", "TotalTargetCapacity" ], "members": { "AllocationStrategy": { "shape": "String", "documentation": "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
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
", "idempotencyToken": true }, "InstanceTypeSpecifications": { "shape": "ReservationFleetInstanceSpecificationList", "documentation": "Information about the instance types for which to reserve the capacity.
", "locationName": "InstanceTypeSpecification" }, "Tenancy": { "shape": "FleetCapacityReservationTenancy", "documentation": "Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
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.
" }, "EndDate": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Capacity Reservation Fleet.
", "locationName": "capacityReservationFleetId" }, "State": { "shape": "CapacityReservationFleetState", "documentation": "The status of the Capacity Reservation Fleet.
", "locationName": "state" }, "TotalTargetCapacity": { "shape": "Integer", "documentation": "The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.
", "locationName": "totalTargetCapacity" }, "TotalFulfilledCapacity": { "shape": "Double", "documentation": "The requested capacity units that have been successfully reserved.
", "locationName": "totalFulfilledCapacity" }, "InstanceMatchCriteria": { "shape": "FleetInstanceMatchCriteria", "documentation": "The instance matching criteria for the Capacity Reservation Fleet.
", "locationName": "instanceMatchCriteria" }, "AllocationStrategy": { "shape": "String", "documentation": "The allocation strategy used by the Capacity Reservation Fleet.
", "locationName": "allocationStrategy" }, "CreateTime": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the Capacity Reservation Fleet was created.
", "locationName": "createTime" }, "EndDate": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the Capacity Reservation Fleet expires.
", "locationName": "endDate" }, "Tenancy": { "shape": "FleetCapacityReservationTenancy", "documentation": "Indicates the tenancy of Capacity Reservation Fleet.
", "locationName": "tenancy" }, "FleetCapacityReservations": { "shape": "FleetCapacityReservationSet", "documentation": "Information about the individual Capacity Reservations in the Capacity Reservation Fleet.
", "locationName": "fleetCapacityReservationSet" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the Capacity Reservation Fleet.
", "locationName": "tagSet" } } }, "CreateCapacityReservationRequest": { "type": "structure", "required": [ "InstanceType", "InstancePlatform", "InstanceCount" ], "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
" }, "InstanceType": { "shape": "String", "documentation": "The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.
" }, "InstancePlatform": { "shape": "CapacityReservationInstancePlatform", "documentation": "The type of operating system for which to reserve capacity.
" }, "AvailabilityZone": { "shape": "AvailabilityZoneName", "documentation": "The Availability Zone in which to create the Capacity Reservation.
" }, "AvailabilityZoneId": { "shape": "AvailabilityZoneId", "documentation": "The ID of the Availability Zone in which to create the Capacity Reservation.
" }, "Tenancy": { "shape": "CapacityReservationTenancy", "documentation": "Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The number of instances for which to reserve capacity.
Valid range: 1 - 1000
" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
" }, "EphemeralStorage": { "shape": "Boolean", "documentation": "Deprecated.
" }, "EndDate": { "shape": "DateTime", "documentation": "The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
The tags to apply to the Capacity Reservation during launch.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
" }, "PlacementGroupArn": { "shape": "PlacementGroupArn", "documentation": "The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
" } } }, "CreateCapacityReservationResult": { "type": "structure", "members": { "CapacityReservation": { "shape": "CapacityReservation", "documentation": "Information about the Capacity Reservation.
", "locationName": "capacityReservation" } } }, "CreateCarrierGatewayRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC to associate with the carrier gateway.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to associate with the carrier gateway.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true } } }, "CreateCarrierGatewayResult": { "type": "structure", "members": { "CarrierGateway": { "shape": "CarrierGateway", "documentation": "Information about the carrier gateway.
", "locationName": "carrierGateway" } } }, "CreateClientVpnEndpointRequest": { "type": "structure", "required": [ "ClientCidrBlock", "ServerCertificateArn", "AuthenticationOptions", "ConnectionLogOptions" ], "members": { "ClientCidrBlock": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
" }, "ServerCertificateArn": { "shape": "String", "documentation": "The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
" }, "AuthenticationOptions": { "shape": "ClientVpnAuthenticationRequestList", "documentation": "Information about the authentication method to be used to authenticate clients.
", "locationName": "Authentication" }, "ConnectionLogOptions": { "shape": "ConnectionLogOptions", "documentation": "Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
" }, "TransportProtocol": { "shape": "TransportProtocol", "documentation": "The transport protocol to be used by the VPN session.
Default value: udp
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
A brief description of the Client VPN endpoint.
" }, "SplitTunnel": { "shape": "Boolean", "documentation": "Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the Client VPN endpoint during creation.
", "locationName": "TagSpecification" }, "SecurityGroupIds": { "shape": "ClientVpnSecurityGroupIdSet", "documentation": "The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
", "locationName": "SecurityGroupId" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.
" }, "SelfServicePortal": { "shape": "SelfServicePortal", "documentation": "Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
The options for managing connection authorization for new client connections.
" }, "SessionTimeoutHours": { "shape": "Integer", "documentation": "The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
" } } }, "CreateClientVpnEndpointResult": { "type": "structure", "members": { "ClientVpnEndpointId": { "shape": "String", "documentation": "The ID of the Client VPN endpoint.
", "locationName": "clientVpnEndpointId" }, "Status": { "shape": "ClientVpnEndpointStatus", "documentation": "The current state of the Client VPN endpoint.
", "locationName": "status" }, "DnsName": { "shape": "String", "documentation": "The DNS name to be used by clients when establishing their VPN session.
", "locationName": "dnsName" } } }, "CreateClientVpnRouteRequest": { "type": "structure", "required": [ "ClientVpnEndpointId", "DestinationCidrBlock", "TargetVpcSubnetId" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint to which to add the route.
" }, "DestinationCidrBlock": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation, of the route destination. For example:
To add a route for Internet access, enter 0.0.0.0/0
To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range
To add a route for the local network, enter the client CIDR range
The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you're adding a route for the local network, specify local.
A brief description of the route.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The current state of the route.
", "locationName": "status" } } }, "CreateCoipCidrRequest": { "type": "structure", "required": [ "Cidr", "CoipPoolId" ], "members": { "Cidr": { "shape": "String", "documentation": "A customer-owned IP address range to create.
" }, "CoipPoolId": { "shape": "Ipv4PoolCoipId", "documentation": "The ID of the address pool.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about a range of customer-owned IP addresses.
", "locationName": "coipCidr" } } }, "CreateCoipPoolRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableId" ], "members": { "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the CoIP address pool.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the CoIP address pool.
", "locationName": "coipPool" } } }, "CreateCustomerGatewayRequest": { "type": "structure", "required": [ "Type" ], "members": { "BgpAsn": { "shape": "Integer", "documentation": "For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
" }, "PublicIp": { "shape": "String", "documentation": "This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
" }, "CertificateArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) for the customer gateway certificate.
" }, "Type": { "shape": "GatewayType", "documentation": "The type of VPN connection that this customer gateway supports (ipsec.1).
The tags to apply to the customer gateway.
", "locationName": "TagSpecification" }, "DeviceName": { "shape": "String", "documentation": "A name for the customer gateway device.
Length Constraints: Up to 255 characters.
" }, "IpAddress": { "shape": "String", "documentation": "IPv4 address for the customer gateway device's outside interface. The address must be static.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for CreateCustomerGateway.
" }, "CreateCustomerGatewayResult": { "type": "structure", "members": { "CustomerGateway": { "shape": "CustomerGateway", "documentation": "Information about the customer gateway.
", "locationName": "customerGateway" } }, "documentation": "Contains the output of CreateCustomerGateway.
" }, "CreateDefaultSubnetRequest": { "type": "structure", "required": [ "AvailabilityZone" ], "members": { "AvailabilityZone": { "shape": "AvailabilityZoneName", "documentation": "The Availability Zone in which to create the default subnet.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.
" } } }, "CreateDefaultSubnetResult": { "type": "structure", "members": { "Subnet": { "shape": "Subnet", "documentation": "Information about the subnet.
", "locationName": "subnet" } } }, "CreateDefaultVpcRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the VPC.
", "locationName": "vpc" } } }, "CreateDhcpOptionsRequest": { "type": "structure", "required": [ "DhcpConfigurations" ], "members": { "DhcpConfigurations": { "shape": "NewDhcpConfigurationList", "documentation": "A DHCP configuration option.
", "locationName": "dhcpConfiguration" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the DHCP option.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
A set of DHCP options.
", "locationName": "dhcpOptions" } } }, "CreateEgressOnlyInternetGatewayRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC for which to create the egress-only internet gateway.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the egress-only internet gateway.
", "locationName": "TagSpecification" } } }, "CreateEgressOnlyInternetGatewayResult": { "type": "structure", "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "locationName": "clientToken" }, "EgressOnlyInternetGateway": { "shape": "EgressOnlyInternetGateway", "documentation": "Information about the egress-only internet gateway.
", "locationName": "egressOnlyInternetGateway" } } }, "CreateFleetError": { "type": "structure", "members": { "LaunchTemplateAndOverrides": { "shape": "LaunchTemplateAndOverridesResponse", "documentation": "The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
", "locationName": "launchTemplateAndOverrides" }, "Lifecycle": { "shape": "InstanceLifecycle", "documentation": "Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
", "locationName": "lifecycle" }, "ErrorCode": { "shape": "String", "documentation": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", "locationName": "errorCode" }, "ErrorMessage": { "shape": "String", "documentation": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", "locationName": "errorMessage" } }, "documentation": "Describes the instances that could not be launched by the fleet.
" }, "CreateFleetErrorsSet": { "type": "list", "member": { "shape": "CreateFleetError", "locationName": "item" } }, "CreateFleetInstance": { "type": "structure", "members": { "LaunchTemplateAndOverrides": { "shape": "LaunchTemplateAndOverridesResponse", "documentation": "The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
", "locationName": "launchTemplateAndOverrides" }, "Lifecycle": { "shape": "InstanceLifecycle", "documentation": "Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
", "locationName": "lifecycle" }, "InstanceIds": { "shape": "InstanceIdsSet", "documentation": "The IDs of the instances.
", "locationName": "instanceIds" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
", "locationName": "instanceType" }, "Platform": { "shape": "PlatformValues", "documentation": "The value is Windows for Windows instances. Otherwise, the value is blank.
Describes the instances that were launched by the fleet.
" }, "CreateFleetInstancesSet": { "type": "list", "member": { "shape": "CreateFleetInstance", "locationName": "item" } }, "CreateFleetRequest": { "type": "structure", "required": [ "LaunchTemplateConfigs", "TargetCapacitySpecification" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
" }, "SpotOptions": { "shape": "SpotOptionsRequest", "documentation": "Describes the configuration of Spot Instances in an EC2 Fleet.
" }, "OnDemandOptions": { "shape": "OnDemandOptionsRequest", "documentation": "Describes the configuration of On-Demand Instances in an EC2 Fleet.
" }, "ExcessCapacityTerminationPolicy": { "shape": "FleetExcessCapacityTerminationPolicy", "documentation": "Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Supported only for fleets of type maintain.
The configuration for the EC2 Fleet.
" }, "TargetCapacitySpecification": { "shape": "TargetCapacitySpecificationRequest", "documentation": "The number of units to request.
" }, "TerminateInstancesWithExpiration": { "shape": "Boolean", "documentation": "Indicates whether running instances should be terminated when the EC2 Fleet expires.
" }, "Type": { "shape": "FleetType", "documentation": "The fleet type. The default value is maintain.
maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.
For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.
" }, "ValidFrom": { "shape": "DateTime", "documentation": "The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
" }, "ValidUntil": { "shape": "DateTime", "documentation": "The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
" }, "ReplaceUnhealthyInstances": { "shape": "Boolean", "documentation": "Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.
The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tag your resources.
If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template.
Reserved.
" } } }, "CreateFleetResult": { "type": "structure", "members": { "FleetId": { "shape": "FleetId", "documentation": "The ID of the EC2 Fleet.
", "locationName": "fleetId" }, "Errors": { "shape": "CreateFleetErrorsSet", "documentation": "Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant.
Information about the instances that were launched by the fleet. Supported only for fleets of type instant.
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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" }, "DeliverLogsPermissionArn": { "shape": "String", "documentation": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.
This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.
The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
" }, "LogGroupName": { "shape": "String", "documentation": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
This parameter is valid only if the destination type is cloud-watch-logs.
The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.
Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.
", "locationName": "ResourceId" }, "ResourceType": { "shape": "FlowLogsResourceType", "documentation": "The type of resource to monitor.
" }, "TrafficType": { "shape": "TrafficType", "documentation": "The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.
" }, "LogDestinationType": { "shape": "LogDestinationType", "documentation": "The type of destination for the flow log data.
Default: cloud-watch-logs
The destination for the flow log data. The meaning of this parameter depends on the destination type.
If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:
arn:aws:logs:region:account_id:log-group:my_group
Alternatively, use the LogGroupName parameter.
If the destination type is s3, specify the ARN of an S3 bucket. For example:
arn:aws:s3:::my_bucket/my_subfolder/
The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.
If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:
arn:aws:firehose:region:account_id:deliverystream:my_stream
The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.
Specify the fields using the ${field-id} format, separated by spaces.
The tags to apply to the flow logs.
", "locationName": "TagSpecification" }, "MaxAggregationInterval": { "shape": "Integer", "documentation": "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 instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
" }, "DestinationOptions": { "shape": "DestinationOptionsRequest", "documentation": "The destination options.
" } } }, "CreateFlowLogsResult": { "type": "structure", "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "locationName": "clientToken" }, "FlowLogIds": { "shape": "ValueStringList", "documentation": "The IDs of the flow logs.
", "locationName": "flowLogIdSet" }, "Unsuccessful": { "shape": "UnsuccessfulItemSet", "documentation": "Information about the flow logs that could not be created successfully.
", "locationName": "unsuccessful" } } }, "CreateFpgaImageRequest": { "type": "structure", "required": [ "InputStorageLocation" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
" }, "LogsStorageLocation": { "shape": "StorageLocation", "documentation": "The location in Amazon S3 for the output logs.
" }, "Description": { "shape": "String", "documentation": "A description for the AFI.
" }, "Name": { "shape": "String", "documentation": "A name for the AFI.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the FPGA image during creation.
", "locationName": "TagSpecification" } } }, "CreateFpgaImageResult": { "type": "structure", "members": { "FpgaImageId": { "shape": "String", "documentation": "The FPGA image identifier (AFI ID).
", "locationName": "fpgaImageId" }, "FpgaImageGlobalId": { "shape": "String", "documentation": "The global FPGA image identifier (AGFI ID).
", "locationName": "fpgaImageGlobalId" } } }, "CreateImageRequest": { "type": "structure", "required": [ "InstanceId", "Name" ], "members": { "BlockDeviceMappings": { "shape": "BlockDeviceMappingRequestList", "documentation": "The block device mappings.
When using the CreateImage action:
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.
The only option that can be changed for existing mappings or snapshots is DeleteOnTermination.
A description for the new image.
", "locationName": "description" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance.
", "locationName": "instanceId" }, "Name": { "shape": "String", "documentation": "A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", "locationName": "name" }, "NoReboot": { "shape": "Boolean", "documentation": "Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:
true - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots.
false - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.
Default: false
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", "locationName": "TagSpecification" } } }, "CreateImageResult": { "type": "structure", "members": { "ImageId": { "shape": "String", "documentation": "The ID of the new AMI.
", "locationName": "imageId" } } }, "CreateInstanceConnectEndpointRequest": { "type": "structure", "required": [ "SubnetId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
" }, "SecurityGroupIds": { "shape": "SecurityGroupIdStringListRequest", "documentation": "One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.
", "locationName": "SecurityGroupId" }, "PreserveClientIp": { "shape": "Boolean", "documentation": "Indicates whether your client's IP address is preserved as the source. The value is true or false.
If true, your client's IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken": true }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the EC2 Instance Connect Endpoint during creation.
", "locationName": "TagSpecification" } } }, "CreateInstanceConnectEndpointResult": { "type": "structure", "members": { "InstanceConnectEndpoint": { "shape": "Ec2InstanceConnectEndpoint", "documentation": "Information about the EC2 Instance Connect Endpoint.
", "locationName": "instanceConnectEndpoint" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive idempotency token provided by the client in the the request.
", "locationName": "clientToken" } } }, "CreateInstanceEventWindowRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The name of the event window.
" }, "TimeRanges": { "shape": "InstanceEventWindowTimeRangeRequestSet", "documentation": "The time range for the event window. If you specify a time range, you can't specify a cron expression.
", "locationName": "TimeRange" }, "CronExpression": { "shape": "InstanceEventWindowCronExpression", "documentation": "The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the event window.
", "locationName": "TagSpecification" } } }, "CreateInstanceEventWindowResult": { "type": "structure", "members": { "InstanceEventWindow": { "shape": "InstanceEventWindow", "documentation": "Information about the event window.
", "locationName": "instanceEventWindow" } } }, "CreateInstanceExportTaskRequest": { "type": "structure", "required": [ "ExportToS3Task", "InstanceId", "TargetEnvironment" ], "members": { "Description": { "shape": "String", "documentation": "A description for the conversion task or the resource being exported. The maximum length is 255 characters.
", "locationName": "description" }, "ExportToS3Task": { "shape": "ExportToS3TaskSpecification", "documentation": "The format and location for an export instance task.
", "locationName": "exportToS3" }, "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "TargetEnvironment": { "shape": "ExportEnvironment", "documentation": "The target virtualization environment.
", "locationName": "targetEnvironment" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the export instance task during creation.
", "locationName": "TagSpecification" } } }, "CreateInstanceExportTaskResult": { "type": "structure", "members": { "ExportTask": { "shape": "ExportTask", "documentation": "Information about the export instance task.
", "locationName": "exportTask" } } }, "CreateInternetGatewayRequest": { "type": "structure", "members": { "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the internet gateway.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the internet gateway.
", "locationName": "internetGateway" } } }, "CreateIpamPoolRequest": { "type": "structure", "required": [ "IpamScopeId", "AddressFamily" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the scope in which you would like to create the IPAM pool.
" }, "Locale": { "shape": "String", "documentation": "In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
" }, "SourceIpamPoolId": { "shape": "IpamPoolId", "documentation": "The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.
" }, "Description": { "shape": "String", "documentation": "A description for the IPAM pool.
" }, "AddressFamily": { "shape": "AddressFamily", "documentation": "The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
" }, "AutoImport": { "shape": "Boolean", "documentation": "If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
" }, "PubliclyAdvertisable": { "shape": "Boolean", "documentation": "Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
" }, "AllocationMaxNetmaskLength": { "shape": "IpamNetmaskLength", "documentation": "The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
" }, "AllocationDefaultNetmaskLength": { "shape": "IpamNetmaskLength", "documentation": "The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
" }, "AllocationResourceTags": { "shape": "RequestIpamResourceTagList", "documentation": "Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
", "locationName": "AllocationResourceTag" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "AwsService": { "shape": "IpamPoolAwsService", "documentation": "Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.
" }, "PublicIpSource": { "shape": "IpamPoolPublicIpSource", "documentation": "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 if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
The resource used to provision CIDRs to a resource planning pool.
" } } }, "CreateIpamPoolResult": { "type": "structure", "members": { "IpamPool": { "shape": "IpamPool", "documentation": "Information about the IPAM pool created.
", "locationName": "ipamPool" } } }, "CreateIpamRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
A description for the IPAM.
" }, "OperatingRegions": { "shape": "AddIpamOperatingRegionSet", "documentation": "The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
", "locationName": "OperatingRegion" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "Tier": { "shape": "IpamTier", "documentation": "IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
" } } }, "CreateIpamResourceDiscoveryRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
A description for the IPAM resource discovery.
" }, "OperatingRegions": { "shape": "AddIpamOperatingRegionSet", "documentation": "Operating Regions for the IPAM resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
", "locationName": "OperatingRegion" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "Tag specifications for the IPAM resource discovery.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "A client token for the IPAM resource discovery.
", "idempotencyToken": true } } }, "CreateIpamResourceDiscoveryResult": { "type": "structure", "members": { "IpamResourceDiscovery": { "shape": "IpamResourceDiscovery", "documentation": "An IPAM resource discovery.
", "locationName": "ipamResourceDiscovery" } } }, "CreateIpamResult": { "type": "structure", "members": { "Ipam": { "shape": "Ipam", "documentation": "Information about the IPAM created.
", "locationName": "ipam" } } }, "CreateIpamScopeRequest": { "type": "structure", "required": [ "IpamId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the IPAM for which you're creating this scope.
" }, "Description": { "shape": "String", "documentation": "A description for the scope you're creating.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true } } }, "CreateIpamScopeResult": { "type": "structure", "members": { "IpamScope": { "shape": "IpamScope", "documentation": "Information about the created scope.
", "locationName": "ipamScope" } } }, "CreateKeyPairRequest": { "type": "structure", "required": [ "KeyName" ], "members": { "KeyName": { "shape": "String", "documentation": "A unique name for the key pair.
Constraints: Up to 255 ASCII characters
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default: rsa
The tags to apply to the new key pair.
", "locationName": "TagSpecification" }, "KeyFormat": { "shape": "KeyFormat", "documentation": "The format of the key pair.
Default: pem
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.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
" }, "LaunchTemplateName": { "shape": "LaunchTemplateName", "documentation": "A name for the launch template.
" }, "VersionDescription": { "shape": "VersionDescription", "documentation": "A description for the first version of the launch template.
" }, "LaunchTemplateData": { "shape": "RequestLaunchTemplateData", "documentation": "The information for the launch template.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be launch-template.
To specify the tags for the resources that are created when an instance is launched, you must use the TagSpecifications parameter in the launch template data structure.
Information about the launch template.
", "locationName": "launchTemplate" }, "Warning": { "shape": "ValidationWarning", "documentation": "If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
", "locationName": "warning" } } }, "CreateLaunchTemplateVersionRequest": { "type": "structure", "required": [ "LaunchTemplateData" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
" }, "LaunchTemplateId": { "shape": "LaunchTemplateId", "documentation": "The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "LaunchTemplateName": { "shape": "LaunchTemplateName", "documentation": "The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "SourceVersion": { "shape": "String", "documentation": "The version of the launch template on which to base the new version. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.
If you specify this parameter, the new version inherits the launch parameters from the source version. If you specify additional launch parameters for the new version, they overwrite any corresponding launch parameters inherited from the source version.
If you omit this parameter, the new version contains only the launch parameters that you specify for the new version.
" }, "VersionDescription": { "shape": "VersionDescription", "documentation": "A description for the version of the launch template.
" }, "LaunchTemplateData": { "shape": "RequestLaunchTemplateData", "documentation": "The information for the launch template.
" }, "ResolveAlias": { "shape": "Boolean", "documentation": "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
Information about the launch template version.
", "locationName": "launchTemplateVersion" }, "Warning": { "shape": "ValidationWarning", "documentation": "If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
", "locationName": "warning" } } }, "CreateLocalGatewayRouteRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.
" }, "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
" }, "LocalGatewayVirtualInterfaceGroupId": { "shape": "LocalGatewayVirtualInterfaceGroupId", "documentation": "The ID of the virtual interface group.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the network interface.
" }, "DestinationPrefixListId": { "shape": "PrefixListResourceId", "documentation": " The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.
Information about the route.
", "locationName": "route" } } }, "CreateLocalGatewayRouteTableRequest": { "type": "structure", "required": [ "LocalGatewayId" ], "members": { "LocalGatewayId": { "shape": "LocalGatewayId", "documentation": "The ID of the local gateway.
" }, "Mode": { "shape": "LocalGatewayRouteTableMode", "documentation": "The mode of the local gateway route table.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags assigned to the local gateway route table.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the local gateway route table.
", "locationName": "localGatewayRouteTable" } } }, "CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableId", "LocalGatewayVirtualInterfaceGroupId" ], "members": { "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
" }, "LocalGatewayVirtualInterfaceGroupId": { "shape": "LocalGatewayVirtualInterfaceGroupId", "documentation": "The ID of the local gateway route table virtual interface group association.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags assigned to the local gateway route table virtual interface group association.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the local gateway route table virtual interface group association.
", "locationName": "localGatewayRouteTableVirtualInterfaceGroupAssociation" } } }, "CreateLocalGatewayRouteTableVpcAssociationRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableId", "VpcId" ], "members": { "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the local gateway route table VPC association.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the association.
", "locationName": "localGatewayRouteTableVpcAssociation" } } }, "CreateManagedPrefixListRequest": { "type": "structure", "required": [ "PrefixListName", "MaxEntries", "AddressFamily" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
One or more entries for the prefix list.
", "locationName": "Entry" }, "MaxEntries": { "shape": "Integer", "documentation": "The maximum number of entries for the prefix list.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the prefix list during creation.
", "locationName": "TagSpecification" }, "AddressFamily": { "shape": "String", "documentation": "The IP address type.
Valid Values: IPv4 | IPv6
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Up to 255 UTF-8 characters in length.
", "idempotencyToken": true } } }, "CreateManagedPrefixListResult": { "type": "structure", "members": { "PrefixList": { "shape": "ManagedPrefixList", "documentation": "Information about the prefix list.
", "locationName": "prefixList" } } }, "CreateNatGatewayRequest": { "type": "structure", "required": [ "SubnetId" ], "members": { "AllocationId": { "shape": "AllocationId", "documentation": "[Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 64 ASCII characters.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the subnet in which to create the NAT gateway.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the NAT gateway.
", "locationName": "TagSpecification" }, "ConnectivityType": { "shape": "ConnectivityType", "documentation": "Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
" }, "PrivateIpAddress": { "shape": "String", "documentation": "The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
" }, "SecondaryAllocationIds": { "shape": "AllocationIdList", "documentation": "Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.
", "locationName": "SecondaryAllocationId" }, "SecondaryPrivateIpAddresses": { "shape": "IpList", "documentation": "Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
", "locationName": "SecondaryPrivateIpAddress" }, "SecondaryPrivateIpAddressCount": { "shape": "PrivateIpAddressCount", "documentation": "[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
" } } }, "CreateNatGatewayResult": { "type": "structure", "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "locationName": "clientToken" }, "NatGateway": { "shape": "NatGateway", "documentation": "Information about the NAT gateway.
", "locationName": "natGateway" } } }, "CreateNetworkAclEntryRequest": { "type": "structure", "required": [ "Egress", "NetworkAclId", "Protocol", "RuleAction", "RuleNumber" ], "members": { "CidrBlock": { "shape": "String", "documentation": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
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.
Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
", "locationName": "egress" }, "IcmpTypeCode": { "shape": "IcmpTypeCode", "documentation": "ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
", "locationName": "Icmp" }, "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
The ID of the network ACL.
", "locationName": "networkAclId" }, "PortRange": { "shape": "PortRange", "documentation": "TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
", "locationName": "portRange" }, "Protocol": { "shape": "String", "documentation": "The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
", "locationName": "protocol" }, "RuleAction": { "shape": "RuleAction", "documentation": "Indicates whether to allow or deny the traffic that matches the rule.
", "locationName": "ruleAction" }, "RuleNumber": { "shape": "Integer", "documentation": "The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
", "locationName": "ruleNumber" } } }, "CreateNetworkAclRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC.
", "locationName": "vpcId" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the network ACL.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "idempotencyToken": true } } }, "CreateNetworkAclResult": { "type": "structure", "members": { "NetworkAcl": { "shape": "NetworkAcl", "documentation": "Information about the network ACL.
", "locationName": "networkAcl" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "locationName": "clientToken" } } }, "CreateNetworkInsightsAccessScopeRequest": { "type": "structure", "required": [ "ClientToken" ], "members": { "MatchPaths": { "shape": "AccessScopePathListRequest", "documentation": "The paths to match.
", "locationName": "MatchPath" }, "ExcludePaths": { "shape": "AccessScopePathListRequest", "documentation": "The paths to exclude.
", "locationName": "ExcludePath" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The Network Access Scope.
", "locationName": "networkInsightsAccessScope" }, "NetworkInsightsAccessScopeContent": { "shape": "NetworkInsightsAccessScopeContent", "documentation": "The Network Access Scope content.
", "locationName": "networkInsightsAccessScopeContent" } } }, "CreateNetworkInsightsPathRequest": { "type": "structure", "required": [ "Source", "Protocol", "ClientToken" ], "members": { "SourceIp": { "shape": "IpAddress", "documentation": "The IP address of the source.
" }, "DestinationIp": { "shape": "IpAddress", "documentation": "The IP address of the destination.
" }, "Source": { "shape": "NetworkInsightsResourceId", "documentation": "The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
" }, "Destination": { "shape": "NetworkInsightsResourceId", "documentation": "The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
" }, "Protocol": { "shape": "Protocol", "documentation": "The protocol.
" }, "DestinationPort": { "shape": "Port", "documentation": "The destination port.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to add to the path.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true }, "FilterAtSource": { "shape": "PathRequestFilter", "documentation": "Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.
" }, "FilterAtDestination": { "shape": "PathRequestFilter", "documentation": "Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.
" } } }, "CreateNetworkInsightsPathResult": { "type": "structure", "members": { "NetworkInsightsPath": { "shape": "NetworkInsightsPath", "documentation": "Information about the path.
", "locationName": "networkInsightsPath" } } }, "CreateNetworkInterfacePermissionRequest": { "type": "structure", "required": [ "NetworkInterfaceId", "Permission" ], "members": { "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
" }, "AwsAccountId": { "shape": "String", "documentation": "The Amazon Web Services account ID.
" }, "AwsService": { "shape": "String", "documentation": "The Amazon Web Service. Currently not supported.
" }, "Permission": { "shape": "InterfacePermissionType", "documentation": "The type of permission to grant.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for CreateNetworkInterfacePermission.
" }, "CreateNetworkInterfacePermissionResult": { "type": "structure", "members": { "InterfacePermission": { "shape": "NetworkInterfacePermission", "documentation": "Information about the permission for the network interface.
", "locationName": "interfacePermission" } }, "documentation": "Contains the output of CreateNetworkInterfacePermission.
" }, "CreateNetworkInterfaceRequest": { "type": "structure", "required": [ "SubnetId" ], "members": { "Description": { "shape": "String", "documentation": "A description for the network interface.
", "locationName": "description" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of one or more security groups.
", "locationName": "SecurityGroupId" }, "Ipv6AddressCount": { "shape": "Integer", "documentation": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.
You can't specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.
The IPv6 addresses from the IPv6 CIDR block range of your subnet.
You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
", "locationName": "ipv6Addresses" }, "PrivateIpAddress": { "shape": "String", "documentation": "The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
The private IPv4 addresses.
You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", "locationName": "privateIpAddresses" }, "SecondaryPrivateIpAddressCount": { "shape": "Integer", "documentation": "The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", "locationName": "secondaryPrivateIpAddressCount" }, "Ipv4Prefixes": { "shape": "Ipv4PrefixList", "documentation": "The IPv4 prefixes assigned to the network interface.
You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
", "locationName": "Ipv4Prefix" }, "Ipv4PrefixCount": { "shape": "Integer", "documentation": "The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
" }, "Ipv6Prefixes": { "shape": "Ipv6PrefixList", "documentation": "The IPv6 prefixes assigned to the network interface.
You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
", "locationName": "Ipv6Prefix" }, "Ipv6PrefixCount": { "shape": "Integer", "documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.
You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
" }, "InterfaceType": { "shape": "NetworkInterfaceCreationType", "documentation": "The type of network interface. The default is interface.
The only supported values are interface, efa, and trunk.
The ID of the subnet to associate with the network interface.
", "locationName": "subnetId" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the new network interface.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "EnablePrimaryIpv6": { "shape": "Boolean", "documentation": "If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
" }, "ConnectionTrackingSpecification": { "shape": "ConnectionTrackingSpecificationRequest", "documentation": "A connection tracking specification for the network interface.
" } } }, "CreateNetworkInterfaceResult": { "type": "structure", "members": { "NetworkInterface": { "shape": "NetworkInterface", "documentation": "Information about the network interface.
", "locationName": "networkInterface" }, "ClientToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
", "locationName": "groupName" }, "Strategy": { "shape": "PlacementStrategy", "documentation": "The placement strategy.
", "locationName": "strategy" }, "PartitionCount": { "shape": "Integer", "documentation": "The number of partitions. Valid only when Strategy is set to partition.
The tags to apply to the new placement group.
", "locationName": "TagSpecification" }, "SpreadLevel": { "shape": "SpreadLevel", "documentation": "Determines how placement groups spread instances.
Host – You can use host only with Outpost placement groups.
Rack – No usage restrictions.
Information about the placement group.
", "locationName": "placementGroup" } } }, "CreatePublicIpv4PoolRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The ID of the public IPv4 pool.
", "locationName": "poolId" } } }, "CreateReplaceRootVolumeTaskRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance for which to replace the root volume.
" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume.
If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter.
" }, "ClientToken": { "shape": "String", "documentation": "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.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tags to apply to the root volume replacement task.
", "locationName": "TagSpecification" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance.
If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter.
" }, "DeleteReplacedRootVolume": { "shape": "Boolean", "documentation": "Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify true. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it.
Information about the root volume replacement task.
", "locationName": "replaceRootVolumeTask" } } }, "CreateReservedInstancesListingRequest": { "type": "structure", "required": [ "ClientToken", "InstanceCount", "PriceSchedules", "ReservedInstancesId" ], "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
", "locationName": "clientToken" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
", "locationName": "instanceCount" }, "PriceSchedules": { "shape": "PriceScheduleSpecificationList", "documentation": "A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
", "locationName": "priceSchedules" }, "ReservedInstancesId": { "shape": "ReservationId", "documentation": "The ID of the active Standard Reserved Instance.
", "locationName": "reservedInstancesId" } }, "documentation": "Contains the parameters for CreateReservedInstancesListing.
" }, "CreateReservedInstancesListingResult": { "type": "structure", "members": { "ReservedInstancesListings": { "shape": "ReservedInstancesListingList", "documentation": "Information about the Standard Reserved Instance listing.
", "locationName": "reservedInstancesListingsSet" } }, "documentation": "Contains the output of CreateReservedInstancesListing.
" }, "CreateRestoreImageTaskRequest": { "type": "structure", "required": [ "Bucket", "ObjectKey" ], "members": { "Bucket": { "shape": "String", "documentation": "The name of the Amazon S3 bucket that contains the stored AMI object.
" }, "ObjectKey": { "shape": "String", "documentation": "The name of the stored AMI object in the bucket.
" }, "Name": { "shape": "String", "documentation": "The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
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.
The AMI ID.
", "locationName": "imageId" } } }, "CreateRouteRequest": { "type": "structure", "required": [ "RouteTableId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
", "locationName": "destinationIpv6CidrBlock" }, "DestinationPrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of a prefix list used for the destination match.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
" }, "EgressOnlyInternetGatewayId": { "shape": "EgressOnlyInternetGatewayId", "documentation": "[IPv6 traffic only] The ID of an egress-only internet gateway.
", "locationName": "egressOnlyInternetGatewayId" }, "GatewayId": { "shape": "RouteGatewayId", "documentation": "The ID of an internet gateway or virtual private gateway attached to your VPC.
", "locationName": "gatewayId" }, "InstanceId": { "shape": "InstanceId", "documentation": "The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
", "locationName": "instanceId" }, "NatGatewayId": { "shape": "NatGatewayId", "documentation": "[IPv4 traffic only] The ID of a NAT gateway.
", "locationName": "natGatewayId" }, "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of a transit gateway.
" }, "LocalGatewayId": { "shape": "LocalGatewayId", "documentation": "The ID of the local gateway.
" }, "CarrierGatewayId": { "shape": "CarrierGatewayId", "documentation": "The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of a network interface.
", "locationName": "networkInterfaceId" }, "RouteTableId": { "shape": "RouteTableId", "documentation": "The ID of the route table for the route.
", "locationName": "routeTableId" }, "VpcPeeringConnectionId": { "shape": "VpcPeeringConnectionId", "documentation": "The ID of a VPC peering connection.
", "locationName": "vpcPeeringConnectionId" }, "CoreNetworkArn": { "shape": "CoreNetworkArn", "documentation": "The Amazon Resource Name (ARN) of the core network.
" } } }, "CreateRouteResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the VPC.
", "locationName": "vpcId" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the route table.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "idempotencyToken": true } } }, "CreateRouteTableResult": { "type": "structure", "members": { "RouteTable": { "shape": "RouteTable", "documentation": "Information about the route table.
", "locationName": "routeTable" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "locationName": "clientToken" } } }, "CreateSecurityGroupRequest": { "type": "structure", "required": [ "Description", "GroupName" ], "members": { "Description": { "shape": "String", "documentation": "A description for the security group.
Constraints: Up to 255 characters in length
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", "locationName": "GroupDescription" }, "GroupName": { "shape": "String", "documentation": "The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg-.
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC. Required for a nondefault VPC.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the security group.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the security group.
", "locationName": "groupId" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the security group.
", "locationName": "tagSet" } } }, "CreateSnapshotRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "Description": { "shape": "String", "documentation": "A description for the snapshot.
" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.
To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.
To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.
For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.
" }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the Amazon EBS volume.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the snapshot during creation.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
A description propagated to every snapshot specified by the instance.
" }, "InstanceSpecification": { "shape": "InstanceSpecification", "documentation": "The instance to specify which volumes should be included in the snapshots.
" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.
For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon EBS User Guide.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "Tags to apply to every snapshot specified by the instance.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Copies the tags from the specified volume to corresponding snapshot.
" } } }, "CreateSnapshotsResult": { "type": "structure", "members": { "Snapshots": { "shape": "SnapshotSet", "documentation": "List of snapshots.
", "locationName": "snapshotSet" } } }, "CreateSpotDatafeedSubscriptionRequest": { "type": "structure", "required": [ "Bucket" ], "members": { "Bucket": { "shape": "String", "documentation": "The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.
", "locationName": "bucket" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The prefix for the data feed file names.
", "locationName": "prefix" } }, "documentation": "Contains the parameters for CreateSpotDatafeedSubscription.
" }, "CreateSpotDatafeedSubscriptionResult": { "type": "structure", "members": { "SpotDatafeedSubscription": { "shape": "SpotDatafeedSubscription", "documentation": "The Spot Instance data feed subscription.
", "locationName": "spotDatafeedSubscription" } }, "documentation": "Contains the output of CreateSpotDatafeedSubscription.
" }, "CreateStoreImageTaskRequest": { "type": "structure", "required": [ "ImageId", "Bucket" ], "members": { "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI.
" }, "Bucket": { "shape": "String", "documentation": "The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed.
" }, "S3ObjectTags": { "shape": "S3ObjectTagList", "documentation": "The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.
", "locationName": "S3ObjectTag" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The name of the stored AMI object in the S3 bucket.
", "locationName": "objectKey" } } }, "CreateSubnetCidrReservationRequest": { "type": "structure", "required": [ "SubnetId", "Cidr", "ReservationType" ], "members": { "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet.
" }, "Cidr": { "shape": "String", "documentation": "The IPv4 or IPV6 CIDR range to reserve.
" }, "ReservationType": { "shape": "SubnetCidrReservationType", "documentation": "The type of reservation. The reservation type determines how the reserved IP addresses are assigned to resources.
prefix - Amazon Web Services assigns the reserved IP addresses to network interfaces.
explicit - You assign the reserved IP addresses to network interfaces.
The description to assign to the subnet CIDR reservation.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tags to assign to the subnet CIDR reservation.
", "locationName": "TagSpecification" } } }, "CreateSubnetCidrReservationResult": { "type": "structure", "members": { "SubnetCidrReservation": { "shape": "SubnetCidrReservation", "documentation": "Information about the created subnet CIDR reservation.
", "locationName": "subnetCidrReservation" } } }, "CreateSubnetRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the subnet.
", "locationName": "TagSpecification" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone or Local Zone for the subnet.
Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see 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.
" }, "AvailabilityZoneId": { "shape": "String", "documentation": "The AZ ID or the Local Zone ID of the subnet.
" }, "CidrBlock": { "shape": "String", "documentation": "The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
This parameter is not supported for an IPv6 only subnet.
" }, "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet.
" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether to create an IPv6 only subnet.
" }, "Ipv4IpamPoolId": { "shape": "IpamPoolId", "documentation": "An IPv4 IPAM pool ID for the subnet.
" }, "Ipv4NetmaskLength": { "shape": "NetmaskLength", "documentation": "An IPv4 netmask length for the subnet.
" }, "Ipv6IpamPoolId": { "shape": "IpamPoolId", "documentation": "An IPv6 IPAM pool ID for the subnet.
" }, "Ipv6NetmaskLength": { "shape": "NetmaskLength", "documentation": "An IPv6 netmask length for the subnet.
" } } }, "CreateSubnetResult": { "type": "structure", "members": { "Subnet": { "shape": "Subnet", "documentation": "Information about the subnet.
", "locationName": "subnet" } } }, "CreateTagsRequest": { "type": "structure", "required": [ "Resources", "Tags" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
", "locationName": "ResourceId" }, "Tags": { "shape": "TagList", "documentation": "The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
The description of the Traffic Mirror filter.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to a Traffic Mirror filter.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true } } }, "CreateTrafficMirrorFilterResult": { "type": "structure", "members": { "TrafficMirrorFilter": { "shape": "TrafficMirrorFilter", "documentation": "Information about the Traffic Mirror filter.
", "locationName": "trafficMirrorFilter" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "locationName": "clientToken" } } }, "CreateTrafficMirrorFilterRuleRequest": { "type": "structure", "required": [ "TrafficMirrorFilterId", "TrafficDirection", "RuleNumber", "RuleAction", "DestinationCidrBlock", "SourceCidrBlock" ], "members": { "TrafficMirrorFilterId": { "shape": "TrafficMirrorFilterId", "documentation": "The ID of the filter that this rule is associated with.
" }, "TrafficDirection": { "shape": "TrafficDirection", "documentation": "The type of traffic.
" }, "RuleNumber": { "shape": "Integer", "documentation": "The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
" }, "RuleAction": { "shape": "TrafficMirrorRuleAction", "documentation": "The action to take on the filtered traffic.
" }, "DestinationPortRange": { "shape": "TrafficMirrorPortRangeRequest", "documentation": "The destination port range.
" }, "SourcePortRange": { "shape": "TrafficMirrorPortRangeRequest", "documentation": "The source port range.
" }, "Protocol": { "shape": "Integer", "documentation": "The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
" }, "DestinationCidrBlock": { "shape": "String", "documentation": "The destination CIDR block to assign to the Traffic Mirror rule.
" }, "SourceCidrBlock": { "shape": "String", "documentation": "The source CIDR block to assign to the Traffic Mirror rule.
" }, "Description": { "shape": "String", "documentation": "The description of the Traffic Mirror rule.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true } } }, "CreateTrafficMirrorFilterRuleResult": { "type": "structure", "members": { "TrafficMirrorFilterRule": { "shape": "TrafficMirrorFilterRule", "documentation": "The Traffic Mirror rule.
", "locationName": "trafficMirrorFilterRule" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "locationName": "clientToken" } } }, "CreateTrafficMirrorSessionRequest": { "type": "structure", "required": [ "NetworkInterfaceId", "TrafficMirrorTargetId", "TrafficMirrorFilterId", "SessionNumber" ], "members": { "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the source network interface.
" }, "TrafficMirrorTargetId": { "shape": "TrafficMirrorTargetId", "documentation": "The ID of the Traffic Mirror target.
" }, "TrafficMirrorFilterId": { "shape": "TrafficMirrorFilterId", "documentation": "The ID of the Traffic Mirror filter.
" }, "PacketLength": { "shape": "Integer", "documentation": "The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
" }, "VirtualNetworkId": { "shape": "Integer", "documentation": "The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random.
The description of the Traffic Mirror session.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to a Traffic Mirror session.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true } } }, "CreateTrafficMirrorSessionResult": { "type": "structure", "members": { "TrafficMirrorSession": { "shape": "TrafficMirrorSession", "documentation": "Information about the Traffic Mirror session.
", "locationName": "trafficMirrorSession" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "locationName": "clientToken" } } }, "CreateTrafficMirrorTargetRequest": { "type": "structure", "members": { "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The network interface ID that is associated with the target.
" }, "NetworkLoadBalancerArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
" }, "Description": { "shape": "String", "documentation": "The description of the Traffic Mirror target.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the Traffic Mirror target.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true }, "GatewayLoadBalancerEndpointId": { "shape": "VpcEndpointId", "documentation": "The ID of the Gateway Load Balancer endpoint.
" } } }, "CreateTrafficMirrorTargetResult": { "type": "structure", "members": { "TrafficMirrorTarget": { "shape": "TrafficMirrorTarget", "documentation": "Information about the Traffic Mirror target.
", "locationName": "trafficMirrorTarget" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "locationName": "clientToken" } } }, "CreateTransitGatewayConnectPeerRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId", "PeerAddress", "InsideCidrBlocks" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the Connect attachment.
" }, "TransitGatewayAddress": { "shape": "String", "documentation": "The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
" }, "PeerAddress": { "shape": "String", "documentation": "The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
" }, "BgpOptions": { "shape": "TransitGatewayConnectRequestBgpOptions", "documentation": "The BGP options for the Connect peer.
" }, "InsideCidrBlocks": { "shape": "InsideCidrBlocksStringList", "documentation": "The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.
The tags to apply to the Connect peer.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the Connect peer.
", "locationName": "transitGatewayConnectPeer" } } }, "CreateTransitGatewayConnectRequest": { "type": "structure", "required": [ "TransportTransitGatewayAttachmentId", "Options" ], "members": { "TransportTransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.
" }, "Options": { "shape": "CreateTransitGatewayConnectRequestOptions", "documentation": "The Connect attachment options.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the Connect attachment.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tunnel protocol.
" } }, "documentation": "The options for a Connect attachment.
" }, "CreateTransitGatewayConnectResult": { "type": "structure", "members": { "TransitGatewayConnect": { "shape": "TransitGatewayConnect", "documentation": "Information about the Connect attachment.
", "locationName": "transitGatewayConnect" } } }, "CreateTransitGatewayMulticastDomainRequest": { "type": "structure", "required": [ "TransitGatewayId" ], "members": { "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
" }, "Options": { "shape": "CreateTransitGatewayMulticastDomainRequestOptions", "documentation": "The options for the transit gateway multicast domain.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags for the transit gateway multicast domain.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
" }, "StaticSourcesSupport": { "shape": "StaticSourcesSupportValue", "documentation": "Specify whether to enable support for statically configuring multicast group sources for a domain.
" }, "AutoAcceptSharedAssociations": { "shape": "AutoAcceptSharedAssociationsValue", "documentation": "Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
" } }, "documentation": "The options for the transit gateway multicast domain.
" }, "CreateTransitGatewayMulticastDomainResult": { "type": "structure", "members": { "TransitGatewayMulticastDomain": { "shape": "TransitGatewayMulticastDomain", "documentation": "Information about the transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomain" } } }, "CreateTransitGatewayPeeringAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayId", "PeerTransitGatewayId", "PeerAccountId", "PeerRegion" ], "members": { "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
" }, "PeerTransitGatewayId": { "shape": "TransitAssociationGatewayId", "documentation": "The ID of the peer transit gateway with which to create the peering attachment.
" }, "PeerAccountId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the peer transit gateway.
" }, "PeerRegion": { "shape": "String", "documentation": "The Region where the peer transit gateway is located.
" }, "Options": { "shape": "CreateTransitGatewayPeeringAttachmentRequestOptions", "documentation": "Requests a transit gateway peering attachment.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the transit gateway peering attachment.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether dynamic routing is enabled or disabled.
" } }, "documentation": "Describes whether dynamic routing is enabled or disabled for the transit gateway peering request.
" }, "CreateTransitGatewayPeeringAttachmentResult": { "type": "structure", "members": { "TransitGatewayPeeringAttachment": { "shape": "TransitGatewayPeeringAttachment", "documentation": "The transit gateway peering attachment.
", "locationName": "transitGatewayPeeringAttachment" } } }, "CreateTransitGatewayPolicyTableRequest": { "type": "structure", "required": [ "TransitGatewayId" ], "members": { "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway used for the policy table.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags specification for the transit gateway policy table created during the request.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Describes the created transit gateway policy table.
", "locationName": "transitGatewayPolicyTable" } } }, "CreateTransitGatewayPrefixListReferenceRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId", "PrefixListId" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "PrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list that is used for destination matches.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment to which traffic is routed.
" }, "Blackhole": { "shape": "Boolean", "documentation": "Indicates whether to drop traffic that matches this route.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the prefix list reference.
", "locationName": "transitGatewayPrefixListReference" } } }, "CreateTransitGatewayRequest": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the transit gateway.
" }, "Options": { "shape": "TransitGatewayRequestOptions", "documentation": "The transit gateway options.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the transit gateway.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateway.
", "locationName": "transitGateway" } } }, "CreateTransitGatewayRouteRequest": { "type": "structure", "required": [ "DestinationCidrBlock", "TransitGatewayRouteTableId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.
" }, "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "Blackhole": { "shape": "Boolean", "documentation": "Indicates whether to drop traffic that matches this route.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the route.
", "locationName": "route" } } }, "CreateTransitGatewayRouteTableAnnouncementRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId", "PeeringAttachmentId" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "PeeringAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the peering attachment.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags specifications applied to the transit gateway route table announcement.
", "locationName": "TagSpecification" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Provides details about the transit gateway route table announcement.
", "locationName": "transitGatewayRouteTableAnnouncement" } } }, "CreateTransitGatewayRouteTableRequest": { "type": "structure", "required": [ "TransitGatewayId" ], "members": { "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the transit gateway route table.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateway route table.
", "locationName": "transitGatewayRouteTable" } } }, "CreateTransitGatewayVpcAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayId", "VpcId", "SubnetIds" ], "members": { "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" }, "SubnetIds": { "shape": "TransitGatewaySubnetIdList", "documentation": "The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.
" }, "Options": { "shape": "CreateTransitGatewayVpcAttachmentRequestOptions", "documentation": "The VPC attachment options.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the VPC attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Enable or disable DNS support. The default is enable.
This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
If you don't enable or disable SecurityGroupReferencingSupport in the request, the attachment will inherit the security group referencing support setting on the transit gateway.
" }, "Ipv6Support": { "shape": "Ipv6SupportValue", "documentation": "Enable or disable IPv6 support. The default is disable.
Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.
Describes the options for a VPC attachment.
" }, "CreateTransitGatewayVpcAttachmentResult": { "type": "structure", "members": { "TransitGatewayVpcAttachment": { "shape": "TransitGatewayVpcAttachment", "documentation": "Information about the VPC attachment.
", "locationName": "transitGatewayVpcAttachment" } } }, "CreateVerifiedAccessEndpointEniOptions": { "type": "structure", "members": { "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
" }, "Protocol": { "shape": "VerifiedAccessEndpointProtocol", "documentation": "The IP protocol.
" }, "Port": { "shape": "VerifiedAccessEndpointPortNumber", "documentation": "The IP port number.
" } }, "documentation": "Describes the network interface options when creating an Amazon Web Services Verified Access endpoint using the network-interface type.
The IP protocol.
" }, "Port": { "shape": "VerifiedAccessEndpointPortNumber", "documentation": "The IP port number.
" }, "LoadBalancerArn": { "shape": "LoadBalancerArn", "documentation": "The ARN of the load balancer.
" }, "SubnetIds": { "shape": "CreateVerifiedAccessEndpointSubnetIdList", "documentation": "The IDs of the subnets.
", "locationName": "SubnetId" } }, "documentation": "Describes the load balancer options when creating an Amazon Web Services Verified Access endpoint using the load-balancer type.
The ID of the Verified Access group to associate the endpoint with.
" }, "EndpointType": { "shape": "VerifiedAccessEndpointType", "documentation": "The type of Verified Access endpoint to create.
" }, "AttachmentType": { "shape": "VerifiedAccessEndpointAttachmentType", "documentation": "The type of attachment.
" }, "DomainCertificateArn": { "shape": "CertificateArn", "documentation": "The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.
" }, "ApplicationDomain": { "shape": "String", "documentation": "The DNS name for users to reach your application.
" }, "EndpointDomainPrefix": { "shape": "String", "documentation": "A custom identifier that is prepended to the DNS name that is generated for the endpoint.
" }, "SecurityGroupIds": { "shape": "SecurityGroupIdList", "documentation": "The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.
The load balancer details. This parameter is required if the endpoint type is load-balancer.
The network interface details. This parameter is required if the endpoint type is network-interface.
A description for the Verified Access endpoint.
" }, "PolicyDocument": { "shape": "String", "documentation": "The Verified Access policy document.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the Verified Access endpoint.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The options for server side encryption.
" } } }, "CreateVerifiedAccessEndpointResult": { "type": "structure", "members": { "VerifiedAccessEndpoint": { "shape": "VerifiedAccessEndpoint", "documentation": "Details about the Verified Access endpoint.
", "locationName": "verifiedAccessEndpoint" } } }, "CreateVerifiedAccessEndpointSubnetIdList": { "type": "list", "member": { "shape": "SubnetId", "locationName": "item" } }, "CreateVerifiedAccessGroupRequest": { "type": "structure", "required": [ "VerifiedAccessInstanceId" ], "members": { "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "Description": { "shape": "String", "documentation": "A description for the Verified Access group.
" }, "PolicyDocument": { "shape": "String", "documentation": "The Verified Access policy document.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the Verified Access group.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The options for server side encryption.
" } } }, "CreateVerifiedAccessGroupResult": { "type": "structure", "members": { "VerifiedAccessGroup": { "shape": "VerifiedAccessGroup", "documentation": "Details about the Verified Access group.
", "locationName": "verifiedAccessGroup" } } }, "CreateVerifiedAccessInstanceRequest": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description for the Verified Access instance.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the Verified Access instance.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.
" } } }, "CreateVerifiedAccessInstanceResult": { "type": "structure", "members": { "VerifiedAccessInstance": { "shape": "VerifiedAccessInstance", "documentation": "Details about the Verified Access instance.
", "locationName": "verifiedAccessInstance" } } }, "CreateVerifiedAccessTrustProviderDeviceOptions": { "type": "structure", "members": { "TenantId": { "shape": "String", "documentation": "The ID of the tenant application with the device-identity provider.
" }, "PublicSigningKeyUrl": { "shape": "String", "documentation": "The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.
" } }, "documentation": "Describes the options when creating an Amazon Web Services Verified Access trust provider using the device type.
The OIDC issuer.
" }, "AuthorizationEndpoint": { "shape": "String", "documentation": "The OIDC authorization endpoint.
" }, "TokenEndpoint": { "shape": "String", "documentation": "The OIDC token endpoint.
" }, "UserInfoEndpoint": { "shape": "String", "documentation": "The OIDC user info endpoint.
" }, "ClientId": { "shape": "String", "documentation": "The client identifier.
" }, "ClientSecret": { "shape": "ClientSecretType", "documentation": "The client secret.
" }, "Scope": { "shape": "String", "documentation": "OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.
" } }, "documentation": "Describes the options when creating an Amazon Web Services Verified Access trust provider using the user type.
The type of trust provider.
" }, "UserTrustProviderType": { "shape": "UserTrustProviderType", "documentation": "The type of user-based trust provider. This parameter is required when the provider type is user.
The type of device-based trust provider. This parameter is required when the provider type is device.
The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is user.
The options for a device-based trust provider. This parameter is required when the provider type is device.
The identifier to be used when working with policy rules.
" }, "Description": { "shape": "String", "documentation": "A description for the Verified Access trust provider.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the Verified Access trust provider.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The options for server side encryption.
" } } }, "CreateVerifiedAccessTrustProviderResult": { "type": "structure", "members": { "VerifiedAccessTrustProvider": { "shape": "VerifiedAccessTrustProvider", "documentation": "Details about the Verified Access trust provider.
", "locationName": "verifiedAccessTrustProvider" } } }, "CreateVolumePermission": { "type": "structure", "members": { "Group": { "shape": "PermissionGroup", "documentation": "The group to be added or removed. The possible value is all.
The ID of the Amazon Web Services account to be added or removed.
", "locationName": "userId" } }, "documentation": "Describes the user or group to be added or removed from the list of create volume permissions for a volume.
" }, "CreateVolumePermissionList": { "type": "list", "member": { "shape": "CreateVolumePermission", "locationName": "item" } }, "CreateVolumePermissionModifications": { "type": "structure", "members": { "Add": { "shape": "CreateVolumePermissionList", "documentation": "Adds the specified Amazon Web Services account ID or group to the list.
" }, "Remove": { "shape": "CreateVolumePermissionList", "documentation": "Removes the specified Amazon Web Services account ID or group from the list.
" } }, "documentation": "Describes modifications to the list of create volume permissions for a volume.
" }, "CreateVolumeRequest": { "type": "structure", "required": [ "AvailabilityZone" ], "members": { "AvailabilityZone": { "shape": "AvailabilityZoneName", "documentation": "The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon EBS User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
", "locationName": "encrypted" }, "Iops": { "shape": "Integer", "documentation": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on 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. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
" }, "Size": { "shape": "Integer", "documentation": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
" }, "VolumeType": { "shape": "VolumeType", "documentation": "The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.
For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
Default: gp2
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.
The tags to apply to the volume during creation.
", "locationName": "TagSpecification" }, "MultiAttachEnabled": { "shape": "Boolean", "documentation": "Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
", "idempotencyToken": true } } }, "CreateVpcEndpointConnectionNotificationRequest": { "type": "structure", "required": [ "ConnectionNotificationArn", "ConnectionEvents" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the endpoint service.
" }, "VpcEndpointId": { "shape": "VpcEndpointId", "documentation": "The ID of the endpoint.
" }, "ConnectionNotificationArn": { "shape": "String", "documentation": "The ARN of the SNS topic for the notifications.
" }, "ConnectionEvents": { "shape": "ValueStringList", "documentation": "The endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" } } }, "CreateVpcEndpointConnectionNotificationResult": { "type": "structure", "members": { "ConnectionNotification": { "shape": "ConnectionNotification", "documentation": "Information about the notification.
", "locationName": "connectionNotification" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "locationName": "clientToken" } } }, "CreateVpcEndpointRequest": { "type": "structure", "required": [ "VpcId", "ServiceName" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The type of endpoint.
Default: Gateway
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" }, "ServiceName": { "shape": "String", "documentation": "The name of the endpoint service.
" }, "PolicyDocument": { "shape": "String", "documentation": "(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
" }, "RouteTableIds": { "shape": "VpcEndpointRouteTableIdList", "documentation": "(Gateway endpoint) The route table IDs.
", "locationName": "RouteTableId" }, "SubnetIds": { "shape": "VpcEndpointSubnetIdList", "documentation": "(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.
", "locationName": "SubnetId" }, "SecurityGroupIds": { "shape": "VpcEndpointSecurityGroupIdList", "documentation": "(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.
", "locationName": "SecurityGroupId" }, "IpAddressType": { "shape": "IpAddressType", "documentation": "The IP address type for the endpoint.
" }, "DnsOptions": { "shape": "DnsOptionsSpecification", "documentation": "The DNS options for the endpoint.
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" }, "PrivateDnsEnabled": { "shape": "Boolean", "documentation": "(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: true
The tags to associate with the endpoint.
", "locationName": "TagSpecification" }, "SubnetConfigurations": { "shape": "SubnetConfigurationsList", "documentation": "The subnet configurations for the endpoint.
", "locationName": "SubnetConfiguration" } } }, "CreateVpcEndpointResult": { "type": "structure", "members": { "VpcEndpoint": { "shape": "VpcEndpoint", "documentation": "Information about the endpoint.
", "locationName": "vpcEndpoint" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "locationName": "clientToken" } } }, "CreateVpcEndpointServiceConfigurationRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
" }, "PrivateDnsName": { "shape": "String", "documentation": "(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
" }, "NetworkLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of the Network Load Balancers.
", "locationName": "NetworkLoadBalancerArn" }, "GatewayLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
", "locationName": "GatewayLoadBalancerArn" }, "SupportedIpAddressTypes": { "shape": "ValueStringList", "documentation": "The supported IP address types. The possible values are ipv4 and ipv6.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to associate with the service.
", "locationName": "TagSpecification" } } }, "CreateVpcEndpointServiceConfigurationResult": { "type": "structure", "members": { "ServiceConfiguration": { "shape": "ServiceConfiguration", "documentation": "Information about the service configuration.
", "locationName": "serviceConfiguration" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "locationName": "clientToken" } } }, "CreateVpcPeeringConnectionRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
", "locationName": "peerOwnerId" }, "PeerVpcId": { "shape": "String", "documentation": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
", "locationName": "peerVpcId" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the requester VPC. You must specify this parameter in the request.
", "locationName": "vpcId" }, "PeerRegion": { "shape": "String", "documentation": "The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to assign to the peering connection.
", "locationName": "TagSpecification" } } }, "CreateVpcPeeringConnectionResult": { "type": "structure", "members": { "VpcPeeringConnection": { "shape": "VpcPeeringConnection", "documentation": "Information about the VPC peering connection.
", "locationName": "vpcPeeringConnection" } } }, "CreateVpcRequest": { "type": "structure", "members": { "CidrBlock": { "shape": "String", "documentation": "The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
", "locationName": "amazonProvidedIpv6CidrBlock" }, "Ipv6Pool": { "shape": "Ipv6PoolEc2Id", "documentation": "The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
" }, "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
" }, "Ipv4IpamPoolId": { "shape": "IpamPoolId", "documentation": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "Ipv4NetmaskLength": { "shape": "NetmaskLength", "documentation": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "Ipv6IpamPoolId": { "shape": "IpamPoolId", "documentation": "The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "Ipv6NetmaskLength": { "shape": "NetmaskLength", "documentation": "The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
The tags to assign to the VPC.
", "locationName": "TagSpecification" } } }, "CreateVpcResult": { "type": "structure", "members": { "Vpc": { "shape": "Vpc", "documentation": "Information about the VPC.
", "locationName": "vpc" } } }, "CreateVpnConnectionRequest": { "type": "structure", "required": [ "CustomerGatewayId", "Type" ], "members": { "CustomerGatewayId": { "shape": "CustomerGatewayId", "documentation": "The ID of the customer gateway.
" }, "Type": { "shape": "String", "documentation": "The type of VPN connection (ipsec.1).
The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
" }, "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The options for the VPN connection.
", "locationName": "options" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the VPN connection.
", "locationName": "TagSpecification" } }, "documentation": "Contains the parameters for CreateVpnConnection.
" }, "CreateVpnConnectionResult": { "type": "structure", "members": { "VpnConnection": { "shape": "VpnConnection", "documentation": "Information about the VPN connection.
", "locationName": "vpnConnection" } }, "documentation": "Contains the output of CreateVpnConnection.
" }, "CreateVpnConnectionRouteRequest": { "type": "structure", "required": [ "DestinationCidrBlock", "VpnConnectionId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR block associated with the local subnet of the customer network.
" }, "VpnConnectionId": { "shape": "VpnConnectionId", "documentation": "The ID of the VPN connection.
" } }, "documentation": "Contains the parameters for CreateVpnConnectionRoute.
" }, "CreateVpnGatewayRequest": { "type": "structure", "required": [ "Type" ], "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone for the virtual private gateway.
" }, "Type": { "shape": "GatewayType", "documentation": "The type of VPN connection this virtual private gateway supports.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the virtual private gateway.
", "locationName": "TagSpecification" }, "AmazonSideAsn": { "shape": "Long", "documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for CreateVpnGateway.
" }, "CreateVpnGatewayResult": { "type": "structure", "members": { "VpnGateway": { "shape": "VpnGateway", "documentation": "Information about the virtual private gateway.
", "locationName": "vpnGateway" } }, "documentation": "Contains the output of CreateVpnGateway.
" }, "CreditSpecification": { "type": "structure", "members": { "CpuCredits": { "shape": "String", "documentation": "The credit option for CPU usage of a T instance.
Valid values: standard | unlimited
Describes the credit option for CPU usage of a T instance.
" }, "CreditSpecificationRequest": { "type": "structure", "required": [ "CpuCredits" ], "members": { "CpuCredits": { "shape": "String", "documentation": "The credit option for CPU usage of a T instance.
Valid values: standard | unlimited
The credit option for CPU usage of a T instance.
" }, "CurrencyCodeValues": { "type": "string", "enum": [ "USD" ] }, "CurrentGenerationFlag": { "type": "boolean" }, "CustomerGateway": { "type": "structure", "members": { "BgpAsn": { "shape": "String", "documentation": "The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
", "locationName": "bgpAsn" }, "CustomerGatewayId": { "shape": "String", "documentation": "The ID of the customer gateway.
", "locationName": "customerGatewayId" }, "IpAddress": { "shape": "String", "documentation": "The IP address of the customer gateway device's outside interface.
", "locationName": "ipAddress" }, "CertificateArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) for the customer gateway certificate.
", "locationName": "certificateArn" }, "State": { "shape": "String", "documentation": "The current state of the customer gateway (pending | available | deleting | deleted).
The type of VPN connection the customer gateway supports (ipsec.1).
The name of customer gateway device.
", "locationName": "deviceName" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the customer gateway.
", "locationName": "tagSet" } }, "documentation": "Describes a customer gateway.
" }, "CustomerGatewayId": { "type": "string" }, "CustomerGatewayIdStringList": { "type": "list", "member": { "shape": "CustomerGatewayId", "locationName": "CustomerGatewayId" } }, "CustomerGatewayList": { "type": "list", "member": { "shape": "CustomerGateway", "locationName": "item" } }, "DITMaxResults": { "type": "integer", "max": 100, "min": 5 }, "DITOMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "DataQueries": { "type": "list", "member": { "shape": "DataQuery" } }, "DataQuery": { "type": "structure", "members": { "Id": { "shape": "String", "documentation": "A user-defined ID associated with a data query that's returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01in the query, the dataResponse identifies the query as MyQuery01.
The Region or Availability Zone that's the source for the data query. For example, us-east-1.
The Region or Availability Zone that's the target for the data query. For example, eu-north-1.
The metric, aggregation-latency, indicating that network latency is aggregated for the query. This is the only supported metric.
The metric data aggregation period, p50, between the specified startDate and endDate. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes. p50 is the only supported metric.
The aggregation period used for the data query.
" } }, "documentation": "A query used for retrieving network health data.
" }, "DataResponse": { "type": "structure", "members": { "Id": { "shape": "String", "documentation": "The ID passed in the DataQuery.
The Region or Availability Zone that's the source for the data query. For example, us-east-1.
The Region or Availability Zone that's the destination for the data query. For example, eu-west-1.
The metric used for the network performance request. Only aggregate-latency is supported, which shows network latency during a specified period.
The statistic used for the network performance request.
", "locationName": "statistic" }, "Period": { "shape": "PeriodType", "documentation": "The period used for the network performance request.
", "locationName": "period" }, "MetricPoints": { "shape": "MetricPoints", "documentation": "A list of MetricPoint objects.
The response to a DataQuery.
The ID of the carrier gateway.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the carrier gateway.
", "locationName": "carrierGateway" } } }, "DeleteClientVpnEndpointRequest": { "type": "structure", "required": [ "ClientVpnEndpointId" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN to be deleted.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The current state of the Client VPN endpoint.
", "locationName": "status" } } }, "DeleteClientVpnRouteRequest": { "type": "structure", "required": [ "ClientVpnEndpointId", "DestinationCidrBlock" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint from which the route is to be deleted.
" }, "TargetVpcSubnetId": { "shape": "SubnetId", "documentation": "The ID of the target subnet used by the route.
" }, "DestinationCidrBlock": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation, of the route to be deleted.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The current state of the route.
", "locationName": "status" } } }, "DeleteCoipCidrRequest": { "type": "structure", "required": [ "Cidr", "CoipPoolId" ], "members": { "Cidr": { "shape": "String", "documentation": "A customer-owned IP address range that you want to delete.
" }, "CoipPoolId": { "shape": "Ipv4PoolCoipId", "documentation": "The ID of the customer-owned address pool.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about a range of customer-owned IP addresses.
", "locationName": "coipCidr" } } }, "DeleteCoipPoolRequest": { "type": "structure", "required": [ "CoipPoolId" ], "members": { "CoipPoolId": { "shape": "Ipv4PoolCoipId", "documentation": "The ID of the CoIP pool that you want to delete.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the CoIP address pool.
", "locationName": "coipPool" } } }, "DeleteCustomerGatewayRequest": { "type": "structure", "required": [ "CustomerGatewayId" ], "members": { "CustomerGatewayId": { "shape": "CustomerGatewayId", "documentation": "The ID of the customer gateway.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DeleteCustomerGateway.
" }, "DeleteDhcpOptionsRequest": { "type": "structure", "required": [ "DhcpOptionsId" ], "members": { "DhcpOptionsId": { "shape": "DhcpOptionsId", "documentation": "The ID of the DHCP options set.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
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.
The ID of the egress-only internet gateway.
" } } }, "DeleteEgressOnlyInternetGatewayResult": { "type": "structure", "members": { "ReturnCode": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The description for the error code.
", "locationName": "message" } }, "documentation": "Describes an EC2 Fleet error.
" }, "DeleteFleetErrorCode": { "type": "string", "enum": [ "fleetIdDoesNotExist", "fleetIdMalformed", "fleetNotInDeletableState", "unexpectedError" ] }, "DeleteFleetErrorItem": { "type": "structure", "members": { "Error": { "shape": "DeleteFleetError", "documentation": "The error.
", "locationName": "error" }, "FleetId": { "shape": "FleetId", "documentation": "The ID of the EC2 Fleet.
", "locationName": "fleetId" } }, "documentation": "Describes an EC2 Fleet that was not successfully deleted.
" }, "DeleteFleetErrorSet": { "type": "list", "member": { "shape": "DeleteFleetErrorItem", "locationName": "item" } }, "DeleteFleetSuccessItem": { "type": "structure", "members": { "CurrentFleetState": { "shape": "FleetStateCode", "documentation": "The current state of the EC2 Fleet.
", "locationName": "currentFleetState" }, "PreviousFleetState": { "shape": "FleetStateCode", "documentation": "The previous state of the EC2 Fleet.
", "locationName": "previousFleetState" }, "FleetId": { "shape": "FleetId", "documentation": "The ID of the EC2 Fleet.
", "locationName": "fleetId" } }, "documentation": "Describes an EC2 Fleet that was successfully deleted.
" }, "DeleteFleetSuccessSet": { "type": "list", "member": { "shape": "DeleteFleetSuccessItem", "locationName": "item" } }, "DeleteFleetsRequest": { "type": "structure", "required": [ "FleetIds", "TerminateInstances" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the EC2 Fleets.
Constraints: In a single request, you can specify up to 25 instant fleet IDs and up to 100 maintain or request fleet IDs.
Indicates whether to terminate the associated instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify no-terminate-instances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
Information about the EC2 Fleets that are successfully deleted.
", "locationName": "successfulFleetDeletionSet" }, "UnsuccessfulFleetDeletions": { "shape": "DeleteFleetErrorSet", "documentation": "Information about the EC2 Fleets that are not successfully deleted.
", "locationName": "unsuccessfulFleetDeletionSet" } } }, "DeleteFlowLogsRequest": { "type": "structure", "required": [ "FlowLogIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
", "locationName": "FlowLogId" } } }, "DeleteFlowLogsResult": { "type": "structure", "members": { "Unsuccessful": { "shape": "UnsuccessfulItemSet", "documentation": "Information about the flow logs that could not be deleted successfully.
", "locationName": "unsuccessful" } } }, "DeleteFpgaImageRequest": { "type": "structure", "required": [ "FpgaImageId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the AFI.
" } } }, "DeleteFpgaImageResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Is true if the request succeeds, and an error otherwise.
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.
The ID of the EC2 Instance Connect Endpoint to delete.
" } } }, "DeleteInstanceConnectEndpointResult": { "type": "structure", "members": { "InstanceConnectEndpoint": { "shape": "Ec2InstanceConnectEndpoint", "documentation": "Information about the EC2 Instance Connect Endpoint.
", "locationName": "instanceConnectEndpoint" } } }, "DeleteInstanceEventWindowRequest": { "type": "structure", "required": [ "InstanceEventWindowId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.
The ID of the event window.
" } } }, "DeleteInstanceEventWindowResult": { "type": "structure", "members": { "InstanceEventWindowState": { "shape": "InstanceEventWindowStateChange", "documentation": "The state of the event window.
", "locationName": "instanceEventWindowState" } } }, "DeleteInternetGatewayRequest": { "type": "structure", "required": [ "InternetGatewayId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the internet gateway.
", "locationName": "internetGatewayId" } } }, "DeleteIpamPoolRequest": { "type": "structure", "required": [ "IpamPoolId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the pool to delete.
" }, "Cascade": { "shape": "Boolean", "documentation": "Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
Information about the results of the deletion.
", "locationName": "ipamPool" } } }, "DeleteIpamRequest": { "type": "structure", "required": [ "IpamId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the IPAM to delete.
" }, "Cascade": { "shape": "Boolean", "documentation": "Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:
Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.
No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.
Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.
Deletes all IPAM pools in private scopes.
Deletes all non-default private scopes in the IPAM.
Deletes the default public and private scopes and the IPAM.
A check for 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.
The IPAM resource discovery ID.
" } } }, "DeleteIpamResourceDiscoveryResult": { "type": "structure", "members": { "IpamResourceDiscovery": { "shape": "IpamResourceDiscovery", "documentation": "The IPAM resource discovery.
", "locationName": "ipamResourceDiscovery" } } }, "DeleteIpamResult": { "type": "structure", "members": { "Ipam": { "shape": "Ipam", "documentation": "Information about the results of the deletion.
", "locationName": "ipam" } } }, "DeleteIpamScopeRequest": { "type": "structure", "required": [ "IpamScopeId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the scope to delete.
" } } }, "DeleteIpamScopeResult": { "type": "structure", "members": { "IpamScope": { "shape": "IpamScope", "documentation": "Information about the results of the deletion.
", "locationName": "ipamScope" } } }, "DeleteKeyPairRequest": { "type": "structure", "members": { "KeyName": { "shape": "KeyPairName", "documentation": "The name of the key pair.
" }, "KeyPairId": { "shape": "KeyPairId", "documentation": "The ID of the key pair.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Is true if the request succeeds, and an error otherwise.
The ID of the key pair.
", "locationName": "keyPairId" } } }, "DeleteLaunchTemplateRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "LaunchTemplateName": { "shape": "LaunchTemplateName", "documentation": "The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" } } }, "DeleteLaunchTemplateResult": { "type": "structure", "members": { "LaunchTemplate": { "shape": "LaunchTemplate", "documentation": "Information about the launch template.
", "locationName": "launchTemplate" } } }, "DeleteLaunchTemplateVersionsRequest": { "type": "structure", "required": [ "Versions" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "LaunchTemplateName": { "shape": "LaunchTemplateName", "documentation": "The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "Versions": { "shape": "VersionStringList", "documentation": "The version numbers of one or more launch template versions to delete. You can specify up to 200 launch template version numbers.
", "locationName": "LaunchTemplateVersion" } } }, "DeleteLaunchTemplateVersionsResponseErrorItem": { "type": "structure", "members": { "LaunchTemplateId": { "shape": "String", "documentation": "The ID of the launch template.
", "locationName": "launchTemplateId" }, "LaunchTemplateName": { "shape": "String", "documentation": "The name of the launch template.
", "locationName": "launchTemplateName" }, "VersionNumber": { "shape": "Long", "documentation": "The version number of the launch template.
", "locationName": "versionNumber" }, "ResponseError": { "shape": "ResponseError", "documentation": "Information about the error.
", "locationName": "responseError" } }, "documentation": "Describes a launch template version that could not be deleted.
" }, "DeleteLaunchTemplateVersionsResponseErrorSet": { "type": "list", "member": { "shape": "DeleteLaunchTemplateVersionsResponseErrorItem", "locationName": "item" } }, "DeleteLaunchTemplateVersionsResponseSuccessItem": { "type": "structure", "members": { "LaunchTemplateId": { "shape": "String", "documentation": "The ID of the launch template.
", "locationName": "launchTemplateId" }, "LaunchTemplateName": { "shape": "String", "documentation": "The name of the launch template.
", "locationName": "launchTemplateName" }, "VersionNumber": { "shape": "Long", "documentation": "The version number of the launch template.
", "locationName": "versionNumber" } }, "documentation": "Describes a launch template version that was successfully deleted.
" }, "DeleteLaunchTemplateVersionsResponseSuccessSet": { "type": "list", "member": { "shape": "DeleteLaunchTemplateVersionsResponseSuccessItem", "locationName": "item" } }, "DeleteLaunchTemplateVersionsResult": { "type": "structure", "members": { "SuccessfullyDeletedLaunchTemplateVersions": { "shape": "DeleteLaunchTemplateVersionsResponseSuccessSet", "documentation": "Information about the launch template versions that were successfully deleted.
", "locationName": "successfullyDeletedLaunchTemplateVersionSet" }, "UnsuccessfullyDeletedLaunchTemplateVersions": { "shape": "DeleteLaunchTemplateVersionsResponseErrorSet", "documentation": "Information about the launch template versions that could not be deleted.
", "locationName": "unsuccessfullyDeletedLaunchTemplateVersionSet" } } }, "DeleteLocalGatewayRouteRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR range for the route. This must match the CIDR for the route exactly.
" }, "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.
Information about the route.
", "locationName": "route" } } }, "DeleteLocalGatewayRouteTableRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableId" ], "members": { "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the local gateway route table.
", "locationName": "localGatewayRouteTable" } } }, "DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" ], "members": { "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { "shape": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", "documentation": "The ID of the local gateway route table virtual interface group association.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the association.
", "locationName": "localGatewayRouteTableVirtualInterfaceGroupAssociation" } } }, "DeleteLocalGatewayRouteTableVpcAssociationRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableVpcAssociationId" ], "members": { "LocalGatewayRouteTableVpcAssociationId": { "shape": "LocalGatewayRouteTableVpcAssociationId", "documentation": "The ID of the association.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the association.
", "locationName": "localGatewayRouteTableVpcAssociation" } } }, "DeleteManagedPrefixListRequest": { "type": "structure", "required": [ "PrefixListId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the prefix list.
" } } }, "DeleteManagedPrefixListResult": { "type": "structure", "members": { "PrefixList": { "shape": "ManagedPrefixList", "documentation": "Information about the prefix list.
", "locationName": "prefixList" } } }, "DeleteNatGatewayRequest": { "type": "structure", "required": [ "NatGatewayId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the NAT gateway.
" } } }, "DeleteNatGatewayResult": { "type": "structure", "members": { "NatGatewayId": { "shape": "String", "documentation": "The ID of the NAT gateway.
", "locationName": "natGatewayId" } } }, "DeleteNetworkAclEntryRequest": { "type": "structure", "required": [ "Egress", "NetworkAclId", "RuleNumber" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether the rule is an egress rule.
", "locationName": "egress" }, "NetworkAclId": { "shape": "NetworkAclId", "documentation": "The ID of the network ACL.
", "locationName": "networkAclId" }, "RuleNumber": { "shape": "Integer", "documentation": "The rule number of the entry to delete.
", "locationName": "ruleNumber" } } }, "DeleteNetworkAclRequest": { "type": "structure", "required": [ "NetworkAclId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the network ACL.
", "locationName": "networkAclId" } } }, "DeleteNetworkInsightsAccessScopeAnalysisRequest": { "type": "structure", "required": [ "NetworkInsightsAccessScopeAnalysisId" ], "members": { "NetworkInsightsAccessScopeAnalysisId": { "shape": "NetworkInsightsAccessScopeAnalysisId", "documentation": "The ID of the Network Access Scope analysis.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Network Access Scope analysis.
", "locationName": "networkInsightsAccessScopeAnalysisId" } } }, "DeleteNetworkInsightsAccessScopeRequest": { "type": "structure", "required": [ "NetworkInsightsAccessScopeId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Network Access Scope.
" } } }, "DeleteNetworkInsightsAccessScopeResult": { "type": "structure", "members": { "NetworkInsightsAccessScopeId": { "shape": "NetworkInsightsAccessScopeId", "documentation": "The ID of the Network Access Scope.
", "locationName": "networkInsightsAccessScopeId" } } }, "DeleteNetworkInsightsAnalysisRequest": { "type": "structure", "required": [ "NetworkInsightsAnalysisId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the network insights analysis.
" } } }, "DeleteNetworkInsightsAnalysisResult": { "type": "structure", "members": { "NetworkInsightsAnalysisId": { "shape": "NetworkInsightsAnalysisId", "documentation": "The ID of the network insights analysis.
", "locationName": "networkInsightsAnalysisId" } } }, "DeleteNetworkInsightsPathRequest": { "type": "structure", "required": [ "NetworkInsightsPathId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the path.
" } } }, "DeleteNetworkInsightsPathResult": { "type": "structure", "members": { "NetworkInsightsPathId": { "shape": "NetworkInsightsPathId", "documentation": "The ID of the path.
", "locationName": "networkInsightsPathId" } } }, "DeleteNetworkInterfacePermissionRequest": { "type": "structure", "required": [ "NetworkInterfacePermissionId" ], "members": { "NetworkInterfacePermissionId": { "shape": "NetworkInterfacePermissionId", "documentation": "The ID of the network interface permission.
" }, "Force": { "shape": "Boolean", "documentation": "Specify true to remove the permission even if the network interface is attached to an instance.
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.
Contains the parameters for DeleteNetworkInterfacePermission.
" }, "DeleteNetworkInterfacePermissionResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds, otherwise returns an error.
Contains the output for DeleteNetworkInterfacePermission.
" }, "DeleteNetworkInterfaceRequest": { "type": "structure", "required": [ "NetworkInterfaceId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the network interface.
", "locationName": "networkInterfaceId" } }, "documentation": "Contains the parameters for DeleteNetworkInterface.
" }, "DeletePlacementGroupRequest": { "type": "structure", "required": [ "GroupName" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The name of the placement group.
", "locationName": "groupName" } } }, "DeletePublicIpv4PoolRequest": { "type": "structure", "required": [ "PoolId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the public IPv4 pool you want to delete.
" } } }, "DeletePublicIpv4PoolResult": { "type": "structure", "members": { "ReturnValue": { "shape": "Boolean", "documentation": "Information about the result of deleting the public IPv4 pool.
", "locationName": "returnValue" } } }, "DeleteQueuedReservedInstancesError": { "type": "structure", "members": { "Code": { "shape": "DeleteQueuedReservedInstancesErrorCode", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The error message.
", "locationName": "message" } }, "documentation": "Describes the error for a Reserved Instance whose queued purchase could not be deleted.
" }, "DeleteQueuedReservedInstancesErrorCode": { "type": "string", "enum": [ "reserved-instances-id-invalid", "reserved-instances-not-in-queued-state", "unexpected-error" ] }, "DeleteQueuedReservedInstancesIdList": { "type": "list", "member": { "shape": "ReservationId", "locationName": "item" }, "max": 100, "min": 1 }, "DeleteQueuedReservedInstancesRequest": { "type": "structure", "required": [ "ReservedInstancesIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the Reserved Instances.
", "locationName": "ReservedInstancesId" } } }, "DeleteQueuedReservedInstancesResult": { "type": "structure", "members": { "SuccessfulQueuedPurchaseDeletions": { "shape": "SuccessfulQueuedPurchaseDeletionSet", "documentation": "Information about the queued purchases that were successfully deleted.
", "locationName": "successfulQueuedPurchaseDeletionSet" }, "FailedQueuedPurchaseDeletions": { "shape": "FailedQueuedPurchaseDeletionSet", "documentation": "Information about the queued purchases that could not be deleted.
", "locationName": "failedQueuedPurchaseDeletionSet" } } }, "DeleteRouteRequest": { "type": "structure", "required": [ "RouteTableId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
", "locationName": "destinationCidrBlock" }, "DestinationIpv6CidrBlock": { "shape": "String", "documentation": "The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
", "locationName": "destinationIpv6CidrBlock" }, "DestinationPrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list for the route.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the route table.
", "locationName": "routeTableId" } } }, "DeleteRouteTableRequest": { "type": "structure", "required": [ "RouteTableId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the route table.
", "locationName": "routeTableId" } } }, "DeleteSecurityGroupRequest": { "type": "structure", "members": { "GroupId": { "shape": "SecurityGroupId", "documentation": "The ID of the security group.
" }, "GroupName": { "shape": "SecurityGroupName", "documentation": "[Default VPC] The name of the security group. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, you must specify the security group ID.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the EBS snapshot.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
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.
Contains the parameters for DeleteSpotDatafeedSubscription.
" }, "DeleteSubnetCidrReservationRequest": { "type": "structure", "required": [ "SubnetCidrReservationId" ], "members": { "SubnetCidrReservationId": { "shape": "SubnetCidrReservationId", "documentation": "The ID of the subnet CIDR reservation.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deleted subnet CIDR reservation.
", "locationName": "deletedSubnetCidrReservation" } } }, "DeleteSubnetRequest": { "type": "structure", "required": [ "SubnetId" ], "members": { "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
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.
The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
", "locationName": "resourceId" }, "Tags": { "shape": "TagList", "documentation": "The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).
Constraints: Up to 1000 tags.
", "locationName": "tag" } } }, "DeleteTrafficMirrorFilterRequest": { "type": "structure", "required": [ "TrafficMirrorFilterId" ], "members": { "TrafficMirrorFilterId": { "shape": "TrafficMirrorFilterId", "documentation": "The ID of the Traffic Mirror filter.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Traffic Mirror filter.
", "locationName": "trafficMirrorFilterId" } } }, "DeleteTrafficMirrorFilterRuleRequest": { "type": "structure", "required": [ "TrafficMirrorFilterRuleId" ], "members": { "TrafficMirrorFilterRuleId": { "shape": "TrafficMirrorFilterRuleIdWithResolver", "documentation": "The ID of the Traffic Mirror rule.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the deleted Traffic Mirror rule.
", "locationName": "trafficMirrorFilterRuleId" } } }, "DeleteTrafficMirrorSessionRequest": { "type": "structure", "required": [ "TrafficMirrorSessionId" ], "members": { "TrafficMirrorSessionId": { "shape": "TrafficMirrorSessionId", "documentation": "The ID of the Traffic Mirror session.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the deleted Traffic Mirror session.
", "locationName": "trafficMirrorSessionId" } } }, "DeleteTrafficMirrorTargetRequest": { "type": "structure", "required": [ "TrafficMirrorTargetId" ], "members": { "TrafficMirrorTargetId": { "shape": "TrafficMirrorTargetId", "documentation": "The ID of the Traffic Mirror target.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the deleted Traffic Mirror target.
", "locationName": "trafficMirrorTargetId" } } }, "DeleteTransitGatewayConnectPeerRequest": { "type": "structure", "required": [ "TransitGatewayConnectPeerId" ], "members": { "TransitGatewayConnectPeerId": { "shape": "TransitGatewayConnectPeerId", "documentation": "The ID of the Connect peer.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deleted Connect peer.
", "locationName": "transitGatewayConnectPeer" } } }, "DeleteTransitGatewayConnectRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the Connect attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deleted Connect attachment.
", "locationName": "transitGatewayConnect" } } }, "DeleteTransitGatewayMulticastDomainRequest": { "type": "structure", "required": [ "TransitGatewayMulticastDomainId" ], "members": { "TransitGatewayMulticastDomainId": { "shape": "TransitGatewayMulticastDomainId", "documentation": "The ID of the transit gateway multicast domain.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deleted transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomain" } } }, "DeleteTransitGatewayPeeringAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway peering attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The transit gateway peering attachment.
", "locationName": "transitGatewayPeeringAttachment" } } }, "DeleteTransitGatewayPolicyTableRequest": { "type": "structure", "required": [ "TransitGatewayPolicyTableId" ], "members": { "TransitGatewayPolicyTableId": { "shape": "TransitGatewayPolicyTableId", "documentation": "The transit gateway policy table to delete.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Provides details about the deleted transit gateway policy table.
", "locationName": "transitGatewayPolicyTable" } } }, "DeleteTransitGatewayPrefixListReferenceRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId", "PrefixListId" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the route table.
" }, "PrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deleted prefix list reference.
", "locationName": "transitGatewayPrefixListReference" } } }, "DeleteTransitGatewayRequest": { "type": "structure", "required": [ "TransitGatewayId" ], "members": { "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deleted transit gateway.
", "locationName": "transitGateway" } } }, "DeleteTransitGatewayRouteRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId", "DestinationCidrBlock" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR range for the route. This must match the CIDR for the route exactly.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the route.
", "locationName": "route" } } }, "DeleteTransitGatewayRouteTableAnnouncementRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableAnnouncementId" ], "members": { "TransitGatewayRouteTableAnnouncementId": { "shape": "TransitGatewayRouteTableAnnouncementId", "documentation": "The transit gateway route table ID that's being deleted.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Provides details about a deleted transit gateway route table.
", "locationName": "transitGatewayRouteTableAnnouncement" } } }, "DeleteTransitGatewayRouteTableRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deleted transit gateway route table.
", "locationName": "transitGatewayRouteTable" } } }, "DeleteTransitGatewayVpcAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deleted VPC attachment.
", "locationName": "transitGatewayVpcAttachment" } } }, "DeleteVerifiedAccessEndpointRequest": { "type": "structure", "required": [ "VerifiedAccessEndpointId" ], "members": { "VerifiedAccessEndpointId": { "shape": "VerifiedAccessEndpointId", "documentation": "The ID of the Verified Access endpoint.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access endpoint.
", "locationName": "verifiedAccessEndpoint" } } }, "DeleteVerifiedAccessGroupRequest": { "type": "structure", "required": [ "VerifiedAccessGroupId" ], "members": { "VerifiedAccessGroupId": { "shape": "VerifiedAccessGroupId", "documentation": "The ID of the Verified Access group.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access group.
", "locationName": "verifiedAccessGroup" } } }, "DeleteVerifiedAccessInstanceRequest": { "type": "structure", "required": [ "VerifiedAccessInstanceId" ], "members": { "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true } } }, "DeleteVerifiedAccessInstanceResult": { "type": "structure", "members": { "VerifiedAccessInstance": { "shape": "VerifiedAccessInstance", "documentation": "Details about the Verified Access instance.
", "locationName": "verifiedAccessInstance" } } }, "DeleteVerifiedAccessTrustProviderRequest": { "type": "structure", "required": [ "VerifiedAccessTrustProviderId" ], "members": { "VerifiedAccessTrustProviderId": { "shape": "VerifiedAccessTrustProviderId", "documentation": "The ID of the Verified Access trust provider.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true } } }, "DeleteVerifiedAccessTrustProviderResult": { "type": "structure", "members": { "VerifiedAccessTrustProvider": { "shape": "VerifiedAccessTrustProvider", "documentation": "Details about the Verified Access trust provider.
", "locationName": "verifiedAccessTrustProvider" } } }, "DeleteVolumeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
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.
The IDs of the notifications.
", "locationName": "ConnectionNotificationId" } } }, "DeleteVpcEndpointConnectionNotificationsResult": { "type": "structure", "members": { "Unsuccessful": { "shape": "UnsuccessfulItemSet", "documentation": "Information about the notifications that could not be deleted successfully.
", "locationName": "unsuccessful" } } }, "DeleteVpcEndpointServiceConfigurationsRequest": { "type": "structure", "required": [ "ServiceIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the services.
", "locationName": "ServiceId" } } }, "DeleteVpcEndpointServiceConfigurationsResult": { "type": "structure", "members": { "Unsuccessful": { "shape": "UnsuccessfulItemSet", "documentation": "Information about the service configurations that were not deleted, if applicable.
", "locationName": "unsuccessful" } } }, "DeleteVpcEndpointsRequest": { "type": "structure", "required": [ "VpcEndpointIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the VPC endpoints.
", "locationName": "VpcEndpointId" } } }, "DeleteVpcEndpointsResult": { "type": "structure", "members": { "Unsuccessful": { "shape": "UnsuccessfulItemSet", "documentation": "Information about the VPC endpoints that were not successfully deleted.
", "locationName": "unsuccessful" } } }, "DeleteVpcPeeringConnectionRequest": { "type": "structure", "required": [ "VpcPeeringConnectionId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC peering connection.
", "locationName": "vpcPeeringConnectionId" } } }, "DeleteVpcPeeringConnectionResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The ID of the VPC.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPN connection.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DeleteVpnConnection.
" }, "DeleteVpnConnectionRouteRequest": { "type": "structure", "required": [ "DestinationCidrBlock", "VpnConnectionId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR block associated with the local subnet of the customer network.
" }, "VpnConnectionId": { "shape": "VpnConnectionId", "documentation": "The ID of the VPN connection.
" } }, "documentation": "Contains the parameters for DeleteVpnConnectionRoute.
" }, "DeleteVpnGatewayRequest": { "type": "structure", "required": [ "VpnGatewayId" ], "members": { "VpnGatewayId": { "shape": "VpnGatewayId", "documentation": "The ID of the virtual private gateway.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DeleteVpnGateway.
" }, "DeprovisionByoipCidrRequest": { "type": "structure", "required": [ "Cidr" ], "members": { "Cidr": { "shape": "String", "documentation": "The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the address range.
", "locationName": "byoipCidr" } } }, "DeprovisionIpamByoasnRequest": { "type": "structure", "required": [ "IpamId", "Asn" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IPAM ID.
" }, "Asn": { "shape": "String", "documentation": "An ASN.
" } } }, "DeprovisionIpamByoasnResult": { "type": "structure", "members": { "Byoasn": { "shape": "Byoasn", "documentation": "An ASN and BYOIP CIDR association.
", "locationName": "byoasn" } } }, "DeprovisionIpamPoolCidrRequest": { "type": "structure", "required": [ "IpamPoolId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the pool that has the CIDR you want to deprovision.
" }, "Cidr": { "shape": "String", "documentation": "The CIDR which you want to deprovision from the pool.
" } } }, "DeprovisionIpamPoolCidrResult": { "type": "structure", "members": { "IpamPoolCidr": { "shape": "IpamPoolCidr", "documentation": "The deprovisioned pool CIDR.
", "locationName": "ipamPoolCidr" } } }, "DeprovisionPublicIpv4PoolCidrRequest": { "type": "structure", "required": [ "PoolId", "Cidr" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the pool that you want to deprovision the CIDR from.
" }, "Cidr": { "shape": "String", "documentation": "The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.
The ID of the pool that you deprovisioned the CIDR from.
", "locationName": "poolId" }, "DeprovisionedAddresses": { "shape": "DeprovisionedAddressSet", "documentation": "The deprovisioned CIDRs.
", "locationName": "deprovisionedAddressSet" } } }, "DeprovisionedAddressSet": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "DeregisterImageRequest": { "type": "structure", "required": [ "ImageId" ], "members": { "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DeregisterImage.
" }, "DeregisterInstanceEventNotificationAttributesRequest": { "type": "structure", "required": [ "InstanceTagAttribute" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the tag keys to deregister.
" } } }, "DeregisterInstanceEventNotificationAttributesResult": { "type": "structure", "members": { "InstanceTagAttribute": { "shape": "InstanceTagNotificationAttribute", "documentation": "The resulting set of tag keys.
", "locationName": "instanceTagAttribute" } } }, "DeregisterInstanceTagAttributeRequest": { "type": "structure", "members": { "IncludeAllTagsOfInstance": { "shape": "Boolean", "documentation": "Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
Information about the tag keys to deregister.
", "locationName": "InstanceTagKey" } }, "documentation": "Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
The ID of the transit gateway multicast domain.
" }, "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
" }, "NetworkInterfaceIds": { "shape": "TransitGatewayNetworkInterfaceIdList", "documentation": "The IDs of the group members' network interfaces.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deregistered members.
", "locationName": "deregisteredMulticastGroupMembers" } } }, "DeregisterTransitGatewayMulticastGroupSourcesRequest": { "type": "structure", "members": { "TransitGatewayMulticastDomainId": { "shape": "TransitGatewayMulticastDomainId", "documentation": "The ID of the transit gateway multicast domain.
" }, "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
" }, "NetworkInterfaceIds": { "shape": "TransitGatewayNetworkInterfaceIdList", "documentation": "The IDs of the group sources' network interfaces.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the deregistered group sources.
", "locationName": "deregisteredMulticastGroupSources" } } }, "DescribeAccountAttributesRequest": { "type": "structure", "members": { "AttributeNames": { "shape": "AccountAttributeNameStringList", "documentation": "The account attribute names.
", "locationName": "attributeName" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the account attributes.
", "locationName": "accountAttributeSet" } } }, "DescribeAddressTransfersMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "DescribeAddressTransfersRequest": { "type": "structure", "members": { "AllocationIds": { "shape": "AllocationIdList", "documentation": "The allocation IDs of Elastic IP addresses.
", "locationName": "AllocationId" }, "NextToken": { "shape": "String", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
" }, "MaxResults": { "shape": "DescribeAddressTransfersMaxResults", "documentation": "The maximum number of address transfers to return in one page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The Elastic IP address transfer.
", "locationName": "addressTransferSet" }, "NextToken": { "shape": "String", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", "locationName": "nextToken" } } }, "DescribeAddressesAttributeRequest": { "type": "structure", "members": { "AllocationIds": { "shape": "AllocationIds", "documentation": "[EC2-VPC] The allocation IDs.
", "locationName": "AllocationId" }, "Attribute": { "shape": "AddressAttributeName", "documentation": "The attribute of the IP address.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "MaxResults": { "shape": "AddressMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
Information about the IP addresses.
", "locationName": "addressSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
One or more filters. Filter names and values are case-sensitive.
allocation-id - The allocation ID for the address.
association-id - The association ID for the address.
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
", "locationName": "PublicIp" }, "AllocationIds": { "shape": "AllocationIdList", "documentation": "Information about the allocation IDs.
", "locationName": "AllocationId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the Elastic IP addresses.
", "locationName": "addressesSet" } } }, "DescribeAggregateIdFormatRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.
Information about each resource's ID format.
", "locationName": "statusSet" } } }, "DescribeAvailabilityZonesRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).
parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).
The names of the Availability Zones, Local Zones, and Wavelength Zones.
", "locationName": "ZoneName" }, "ZoneIds": { "shape": "ZoneIdStringList", "documentation": "The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
", "locationName": "ZoneId" }, "AllAvailabilityZones": { "shape": "Boolean", "documentation": "Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the Availability Zones, Local Zones, and Wavelength Zones.
", "locationName": "availabilityZoneInfo" } } }, "DescribeAwsNetworkPerformanceMetricSubscriptionsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResultsParam", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
", "locationName": "Filter" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the current Infrastructure Performance subscriptions.
", "locationName": "subscriptionSet" } } }, "DescribeBundleTasksRequest": { "type": "structure", "members": { "BundleIds": { "shape": "BundleIdStringList", "documentation": "The bundle task IDs.
Default: Describes all your bundle tasks.
", "locationName": "BundleId" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
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.
Information about the bundle tasks.
", "locationName": "bundleInstanceTasksSet" } } }, "DescribeByoipCidrsMaxResults": { "type": "integer", "max": 100, "min": 1 }, "DescribeByoipCidrsRequest": { "type": "structure", "required": [ "MaxResults" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" } } }, "DescribeByoipCidrsResult": { "type": "structure", "members": { "ByoipCidrs": { "shape": "ByoipCidrSet", "documentation": "Information about your address ranges.
", "locationName": "byoipCidrSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
The type of instance for which the Capacity Block offering reserves capacity.
" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of instances for which to reserve capacity.
" }, "StartDateRange": { "shape": "MillisecondDateTime", "documentation": "The earliest start date for the Capacity Block offering.
" }, "EndDateRange": { "shape": "MillisecondDateTime", "documentation": "The latest end date for the Capacity Block offering.
" }, "CapacityDurationHours": { "shape": "Integer", "documentation": "The number of hours for which to reserve Capacity Block.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" }, "MaxResults": { "shape": "DescribeCapacityBlockOfferingsMaxResults", "documentation": "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.
" } } }, "DescribeCapacityBlockOfferingsResult": { "type": "structure", "members": { "CapacityBlockOfferings": { "shape": "CapacityBlockOfferingSet", "documentation": "The recommended Capacity Block offering for the dates specified.
", "locationName": "capacityBlockOfferingSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the Capacity Reservation Fleets to describe.
", "locationName": "CapacityReservationFleetId" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" }, "MaxResults": { "shape": "DescribeCapacityReservationFleetsMaxResults", "documentation": "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.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
tenancy - The tenancy of the Fleet (default | dedicated).
allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
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.
Information about the Capacity Reservation Fleets.
", "locationName": "capacityReservationFleetSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Capacity Reservation.
", "locationName": "CapacityReservationId" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" }, "MaxResults": { "shape": "DescribeCapacityReservationsMaxResults", "documentation": "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.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
start-date - The date and time at which the Capacity Reservation was started.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
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.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the Capacity Reservations.
", "locationName": "capacityReservationSet" } } }, "DescribeCarrierGatewaysRequest": { "type": "structure", "members": { "CarrierGatewayIds": { "shape": "CarrierGatewayIdSet", "documentation": "One or more carrier gateway IDs.
", "locationName": "CarrierGatewayId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
carrier-gateway-id - The ID of the carrier gateway.
state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC associated with the carrier gateway.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the carrier gateway.
", "locationName": "carrierGatewaySet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
group-id - The ID of a VPC security group that's associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
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.
The instance IDs. Must be instances linked to a VPC through ClassicLink.
", "locationName": "InstanceId" }, "MaxResults": { "shape": "DescribeClassicLinkInstancesMaxResults", "documentation": "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.
Constraint: If the value is greater than 1000, we return only 1000 items.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName": "nextToken" } } }, "DescribeClassicLinkInstancesResult": { "type": "structure", "members": { "Instances": { "shape": "ClassicLinkInstanceList", "documentation": "Information about one or more linked EC2-Classic instances.
", "locationName": "instancesSet" }, "NextToken": { "shape": "String", "documentation": "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.
The ID of the Client VPN endpoint.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token to retrieve the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
description - The description of the authorization rule.
destination-cidr - The CIDR of the network to which the authorization rule applies.
group-id - The ID of the Active Directory group to which the authorization rule grants access.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" } } }, "DescribeClientVpnAuthorizationRulesResult": { "type": "structure", "members": { "AuthorizationRules": { "shape": "AuthorizationRuleSet", "documentation": "Information about the authorization rules.
", "locationName": "authorizationRule" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
connection-id - The ID of the connection.
username - For Active Directory client authentication, the user name of the client who established the client connection.
The token to retrieve the next page of results.
" }, "MaxResults": { "shape": "DescribeClientVpnConnectionsMaxResults", "documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the active and terminated client connections.
", "locationName": "connections" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
", "locationName": "ClientVpnEndpointId" }, "MaxResults": { "shape": "DescribeClientVpnEndpointMaxResults", "documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token to retrieve the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint.
transport-protocol - The transport protocol (tcp | udp).
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.
Information about the Client VPN endpoints.
", "locationName": "clientVpnEndpoint" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
destination-cidr - The CIDR of the route destination.
origin - How the route was associated with the Client VPN endpoint (associate | add-route).
target-subnet - The ID of the subnet through which traffic is routed.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token to retrieve the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the Client VPN endpoint routes.
", "locationName": "routes" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
" }, "AssociationIds": { "shape": "ValueStringList", "documentation": "The IDs of the target network associations.
" }, "MaxResults": { "shape": "DescribeClientVpnTargetNetworksMaxResults", "documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token to retrieve the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
association-id - The ID of the association.
target-network-id - The ID of the subnet specified as the target network.
vpc-id - The ID of the VPC in which the target network is located.
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.
Information about the associated target networks.
", "locationName": "clientVpnTargetNetworks" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the address pools.
", "locationName": "PoolId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the address pools.
", "locationName": "coipPoolSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The conversion task IDs.
", "locationName": "conversionTaskId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the conversion tasks.
", "locationName": "conversionTasks" } } }, "DescribeCustomerGatewaysRequest": { "type": "structure", "members": { "CustomerGatewayIds": { "shape": "CustomerGatewayIdStringList", "documentation": "One or more customer gateway IDs.
Default: Describes all your customer gateways.
", "locationName": "CustomerGatewayId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway device's external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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.
Contains the parameters for DescribeCustomerGateways.
" }, "DescribeCustomerGatewaysResult": { "type": "structure", "members": { "CustomerGateways": { "shape": "CustomerGatewayList", "documentation": "Information about one or more customer gateways.
", "locationName": "customerGatewaySet" } }, "documentation": "Contains the output of DescribeCustomerGateways.
" }, "DescribeDhcpOptionsMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "DescribeDhcpOptionsRequest": { "type": "structure", "members": { "DhcpOptionsIds": { "shape": "DhcpOptionsIdStringList", "documentation": "The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
", "locationName": "DhcpOptionsId" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeDhcpOptionsMaxResults", "documentation": "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.
" } } }, "DescribeDhcpOptionsResult": { "type": "structure", "members": { "DhcpOptions": { "shape": "DhcpOptionsList", "documentation": "Information about one or more DHCP options sets.
", "locationName": "dhcpOptionsSet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
The IDs of the egress-only internet gateways.
", "locationName": "EgressOnlyInternetGatewayId" }, "MaxResults": { "shape": "DescribeEgressOnlyInternetGatewaysMaxResults", "documentation": "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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Information about the egress-only internet gateways.
", "locationName": "egressOnlyInternetGatewaySet" }, "NextToken": { "shape": "String", "documentation": "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.
The Elastic Graphics accelerator IDs.
", "locationName": "ElasticGpuId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The filters.
availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.
elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).
elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).
elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.
instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000.
The token to request the next page of results.
" } } }, "DescribeElasticGpusResult": { "type": "structure", "members": { "ElasticGpuSet": { "shape": "ElasticGpuSet", "documentation": "Information about the Elastic Graphics accelerators.
", "locationName": "elasticGpuSet" }, "MaxResults": { "shape": "Integer", "documentation": "The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.
The IDs of the export image tasks.
", "locationName": "ExportImageTaskId" }, "MaxResults": { "shape": "DescribeExportImageTasksMaxResults", "documentation": "The maximum number of results to return in a single call.
" }, "NextToken": { "shape": "NextToken", "documentation": "A token that indicates the next page of results.
" } } }, "DescribeExportImageTasksResult": { "type": "structure", "members": { "ExportImageTasks": { "shape": "ExportImageTaskList", "documentation": "Information about the export image tasks.
", "locationName": "exportImageTaskSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to get the next page of results. This value is null when there are no more results to return.
The export task IDs.
", "locationName": "exportTaskId" }, "Filters": { "shape": "FilterList", "documentation": "the filters for the export tasks.
", "locationName": "Filter" } } }, "DescribeExportTasksResult": { "type": "structure", "members": { "ExportTasks": { "shape": "ExportTaskList", "documentation": "Information about the export tasks.
", "locationName": "exportTaskSet" } } }, "DescribeFastLaunchImagesRequest": { "type": "structure", "members": { "ImageIds": { "shape": "FastLaunchImageIdList", "documentation": "Specify one or more Windows AMI image IDs for the request.
", "locationName": "ImageId" }, "Filters": { "shape": "FilterList", "documentation": "Use the following filters to streamline results.
resource-type - The resource type for pre-provisioning.
owner-id - The owner ID for the pre-provisioning resource.
state - The current state of fast launching for the Windows AMI.
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.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
A collection of details about the fast-launch enabled Windows images that meet the requested criteria.
", "locationName": "fastLaunchImageSet" }, "NextToken": { "shape": "NextToken", "documentation": "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.
The image ID that identifies the Windows fast launch enabled image.
", "locationName": "imageId" }, "ResourceType": { "shape": "FastLaunchResourceType", "documentation": "The resource type that Amazon EC2 uses for pre-provisioning the Windows AMI. Supported values include: snapshot.
A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots.
", "locationName": "snapshotConfiguration" }, "LaunchTemplate": { "shape": "FastLaunchLaunchTemplateSpecificationResponse", "documentation": "The launch template that the Windows fast launch enabled AMI uses when it launches Windows instances from pre-provisioned snapshots.
", "locationName": "launchTemplate" }, "MaxParallelLaunches": { "shape": "Integer", "documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch.
", "locationName": "maxParallelLaunches" }, "OwnerId": { "shape": "String", "documentation": "The owner ID for the Windows fast launch enabled AMI.
", "locationName": "ownerId" }, "State": { "shape": "FastLaunchStateCode", "documentation": "The current state of Windows fast launch for the specified Windows AMI.
", "locationName": "state" }, "StateTransitionReason": { "shape": "String", "documentation": "The reason that Windows fast launch for the AMI changed to the current state.
", "locationName": "stateTransitionReason" }, "StateTransitionTime": { "shape": "MillisecondDateTime", "documentation": "The time that Windows fast launch for the AMI changed to the current state.
", "locationName": "stateTransitionTime" } }, "documentation": "Describe details about a Windows image with Windows fast launch enabled that meets the requested criteria. Criteria are defined by the DescribeFastLaunchImages action filters.
The ID of the snapshot.
", "locationName": "snapshotId" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "State": { "shape": "FastSnapshotRestoreStateCode", "documentation": "The state of fast snapshot restores.
", "locationName": "state" }, "StateTransitionReason": { "shape": "String", "documentation": "The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
", "locationName": "ownerId" }, "OwnerAlias": { "shape": "String", "documentation": "The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
", "locationName": "ownerAlias" }, "EnablingTime": { "shape": "MillisecondDateTime", "documentation": "The time at which fast snapshot restores entered the enabling state.
The time at which fast snapshot restores entered the optimizing state.
The time at which fast snapshot restores entered the enabled state.
The time at which fast snapshot restores entered the disabling state.
The time at which fast snapshot restores entered the disabled state.
Describes fast snapshot restores for a snapshot.
" }, "DescribeFastSnapshotRestoreSuccessSet": { "type": "list", "member": { "shape": "DescribeFastSnapshotRestoreSuccessItem", "locationName": "item" } }, "DescribeFastSnapshotRestoresMaxResults": { "type": "integer", "max": 200, "min": 0 }, "DescribeFastSnapshotRestoresRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters. The possible values are:
availability-zone: The Availability Zone of the snapshot.
owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.
snapshot-id: The ID of the snapshot.
state: The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled | disabling | disabled).
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.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the state of fast snapshot restores.
", "locationName": "fastSnapshotRestoreSet" }, "NextToken": { "shape": "NextToken", "documentation": "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.
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
", "locationName": "launchTemplateAndOverrides" }, "Lifecycle": { "shape": "InstanceLifecycle", "documentation": "Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
", "locationName": "lifecycle" }, "ErrorCode": { "shape": "String", "documentation": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", "locationName": "errorCode" }, "ErrorMessage": { "shape": "String", "documentation": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", "locationName": "errorMessage" } }, "documentation": "Describes the instances that could not be launched by the fleet.
" }, "DescribeFleetHistoryRequest": { "type": "structure", "required": [ "FleetId", "StartTime" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The type of events to describe. By default, all events are described.
" }, "MaxResults": { "shape": "Integer", "documentation": "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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "FleetId": { "shape": "FleetId", "documentation": "The ID of the EC2 Fleet.
" }, "StartTime": { "shape": "DateTime", "documentation": "The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
" } } }, "DescribeFleetHistoryResult": { "type": "structure", "members": { "HistoryRecords": { "shape": "HistoryRecordSet", "documentation": "Information about the events in the history of the EC2 Fleet.
", "locationName": "historyRecordSet" }, "LastEvaluatedTime": { "shape": "DateTime", "documentation": "The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more items, this value is not present.
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.
The ID of the EC Fleet.
", "locationName": "fleetId" }, "StartTime": { "shape": "DateTime", "documentation": "The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "startTime" } } }, "DescribeFleetInstancesRequest": { "type": "structure", "required": [ "FleetId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "FleetId": { "shape": "FleetId", "documentation": "The ID of the EC2 Fleet.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
instance-type - The instance type.
The running instances. This list is refreshed periodically and might be out of date.
", "locationName": "activeInstanceSet" }, "NextToken": { "shape": "String", "documentation": "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.
The ID of the EC2 Fleet.
", "locationName": "fleetId" } } }, "DescribeFleetsErrorSet": { "type": "list", "member": { "shape": "DescribeFleetError", "locationName": "item" } }, "DescribeFleetsInstances": { "type": "structure", "members": { "LaunchTemplateAndOverrides": { "shape": "LaunchTemplateAndOverridesResponse", "documentation": "The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
", "locationName": "launchTemplateAndOverrides" }, "Lifecycle": { "shape": "InstanceLifecycle", "documentation": "Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
", "locationName": "lifecycle" }, "InstanceIds": { "shape": "InstanceIdsSet", "documentation": "The IDs of the instances.
", "locationName": "instanceIds" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
", "locationName": "instanceType" }, "Platform": { "shape": "PlatformValues", "documentation": "The value is Windows for Windows instances. Otherwise, the value is blank.
Describes the instances that were launched by the fleet.
" }, "DescribeFleetsInstancesSet": { "type": "list", "member": { "shape": "DescribeFleetsInstances", "locationName": "item" } }, "DescribeFleetsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "FleetIds": { "shape": "FleetIdSet", "documentation": "The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
The filters.
activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).
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.
Information about the EC2 Fleets.
", "locationName": "fleetSet" } } }, "DescribeFlowLogsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination for the flow log data (cloud-watch-logs | s3 | kinesis-data-firehose).
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
", "locationName": "FlowLogId" }, "MaxResults": { "shape": "Integer", "documentation": "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.
" }, "NextToken": { "shape": "String", "documentation": "The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.
" } } }, "DescribeFlowLogsResult": { "type": "structure", "members": { "FlowLogs": { "shape": "FlowLogSet", "documentation": "Information about the flow logs.
", "locationName": "flowLogSet" }, "NextToken": { "shape": "String", "documentation": "The token to request the next page of items. This value is null when there are no more items to return.
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.
The ID of the AFI.
" }, "Attribute": { "shape": "FpgaImageAttributeName", "documentation": "The AFI attribute.
" } } }, "DescribeFpgaImageAttributeResult": { "type": "structure", "members": { "FpgaImageAttribute": { "shape": "FpgaImageAttribute", "documentation": "Information about the attribute.
", "locationName": "fpgaImageAttribute" } } }, "DescribeFpgaImagesMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "DescribeFpgaImagesRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The AFI IDs.
", "locationName": "FpgaImageId" }, "Owners": { "shape": "OwnerStringList", "documentation": "Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).
The filters.
create-time - The creation time of the AFI.
fpga-image-id - The FPGA image identifier (AFI ID).
fpga-image-global-id - The global FPGA image identifier (AGFI ID).
name - The name of the AFI.
owner-id - The Amazon Web Services account ID of the AFI owner.
product-code - The product code.
shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
state - The state of the AFI (pending | failed | available | unavailable).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
update-time - The time of the most recent update.
The token to retrieve the next page of results.
" }, "MaxResults": { "shape": "DescribeFpgaImagesMaxResults", "documentation": "The maximum number of results to return in a single call.
" } } }, "DescribeFpgaImagesResult": { "type": "structure", "members": { "FpgaImages": { "shape": "FpgaImageList", "documentation": "Information about the FPGA images.
", "locationName": "fpgaImageSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
instance-family - The instance family of the offering (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
" }, "MaxResults": { "shape": "DescribeHostReservationsMaxResults", "documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" }, "OfferingId": { "shape": "OfferingId", "documentation": "The ID of the reservation offering.
" } } }, "DescribeHostReservationOfferingsResult": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the offerings.
", "locationName": "offeringSet" } } }, "DescribeHostReservationsMaxResults": { "type": "integer", "max": 500, "min": 5 }, "DescribeHostReservationsRequest": { "type": "structure", "members": { "Filter": { "shape": "FilterList", "documentation": "The filters.
instance-family - The instance family (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
state - The state of the reservation (payment-pending | payment-failed | active | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The host reservation IDs.
" }, "MaxResults": { "shape": "Integer", "documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The token to use to retrieve the next page of results.
" } } }, "DescribeHostReservationsResult": { "type": "structure", "members": { "HostReservationSet": { "shape": "HostReservationSet", "documentation": "Details about the reservation's configuration.
", "locationName": "hostReservationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
", "locationName": "hostId" }, "MaxResults": { "shape": "Integer", "documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "locationName": "nextToken" } } }, "DescribeHostsResult": { "type": "structure", "members": { "Hosts": { "shape": "HostList", "documentation": "Information about the Dedicated Hosts.
", "locationName": "hostSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IAM instance profile associations.
", "locationName": "AssociationId" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating).
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.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "DescribeIamInstanceProfileAssociationsResult": { "type": "structure", "members": { "IamInstanceProfileAssociations": { "shape": "IamInstanceProfileAssociationSet", "documentation": "Information about the IAM instance profile associations.
", "locationName": "iamInstanceProfileAssociationSet" }, "NextToken": { "shape": "NextToken", "documentation": "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.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway
Information about the ID format for the resource.
", "locationName": "statusSet" } } }, "DescribeIdentityIdFormatRequest": { "type": "structure", "required": [ "PrincipalArn" ], "members": { "PrincipalArn": { "shape": "String", "documentation": "The ARN of the principal, which can be an IAM role, IAM user, or the root user.
", "locationName": "principalArn" }, "Resource": { "shape": "String", "documentation": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway
Information about the ID format for the resources.
", "locationName": "statusSet" } } }, "DescribeImageAttributeRequest": { "type": "structure", "required": [ "Attribute", "ImageId" ], "members": { "Attribute": { "shape": "ImageAttributeName", "documentation": "The AMI attribute.
Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.
The ID of the AMI.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DescribeImageAttribute.
" }, "DescribeImagesRequest": { "type": "structure", "members": { "ExecutableUsers": { "shape": "ExecutableByStringList", "documentation": "Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. The only supported value is windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage.
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
", "locationName": "ImageId" }, "Owners": { "shape": "OwnerStringList", "documentation": "Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.
Specifies whether to include deprecated AMIs.
Default: No deprecated AMIs are included in the response.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.
Specifies whether to include disabled AMIs.
Default: No disabled AMIs are included in the response.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "DescribeImagesResult": { "type": "structure", "members": { "Images": { "shape": "ImageList", "documentation": "Information about the images.
", "locationName": "imagesSet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.
The IDs of the import image tasks.
", "locationName": "ImportTaskId" }, "MaxResults": { "shape": "Integer", "documentation": "The maximum number of results to return in a single call.
" }, "NextToken": { "shape": "String", "documentation": "A token that indicates the next page of results.
" } } }, "DescribeImportImageTasksResult": { "type": "structure", "members": { "ImportImageTasks": { "shape": "ImportImageTaskList", "documentation": "A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.
", "locationName": "importImageTaskSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to get the next page of results. This value is null when there are no more results to return.
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.
The filters.
" }, "ImportTaskIds": { "shape": "ImportSnapshotTaskIdList", "documentation": "A list of import snapshot task IDs.
", "locationName": "ImportTaskId" }, "MaxResults": { "shape": "Integer", "documentation": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
A token that indicates the next page of results.
" } } }, "DescribeImportSnapshotTasksResult": { "type": "structure", "members": { "ImportSnapshotTasks": { "shape": "ImportSnapshotTaskList", "documentation": "A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
", "locationName": "importSnapshotTaskSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to get the next page of results. This value is null when there are no more results to return.
The instance attribute.
Note: The enaSupport attribute is not supported at this time.
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.
The ID of the instance.
", "locationName": "instanceId" } } }, "DescribeInstanceConnectEndpointsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
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.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
instance-connect-endpoint-id - The ID of the EC2 Instance Connect Endpoint.
state - The state of the EC2 Instance Connect Endpoint (create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).
subnet-id - The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key.
vpc-id - The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
One or more EC2 Instance Connect Endpoint IDs.
", "locationName": "InstanceConnectEndpointId" } } }, "DescribeInstanceConnectEndpointsResult": { "type": "structure", "members": { "InstanceConnectEndpoints": { "shape": "InstanceConnectEndpointSet", "documentation": "Information about the EC2 Instance Connect Endpoints.
", "locationName": "instanceConnectEndpointSet" }, "NextToken": { "shape": "NextToken", "documentation": "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.
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.
The filters.
instance-id - The ID of the instance.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
", "locationName": "InstanceId" }, "MaxResults": { "shape": "DescribeInstanceCreditSpecificationsMaxResults", "documentation": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same call.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "DescribeInstanceCreditSpecificationsResult": { "type": "structure", "members": { "InstanceCreditSpecifications": { "shape": "InstanceCreditSpecificationList", "documentation": "Information about the credit option for CPU usage of an instance.
", "locationName": "instanceCreditSpecificationSet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
Information about the registered tag keys.
", "locationName": "instanceTagAttribute" } } }, "DescribeInstanceEventWindowsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the event windows.
", "locationName": "InstanceEventWindowId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
event-window-name - The event windows associated with the specified names.
instance-id - The event windows associated with the specified instance ID.
instance-tag - The event windows associated with the specified tag and value.
instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.
The token to request the next page of results.
" } }, "documentation": "Information about the event windows.
", "locationName": "instanceEventWindowSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
", "locationName": "InstanceId" }, "MaxResults": { "shape": "Integer", "documentation": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
Information about the status of the instances.
", "locationName": "instanceStatusSet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeInstanceTopologyMaxResults", "documentation": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You can't specify this parameter and the instance IDs parameter in the same request.
Default: 20
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
", "locationName": "InstanceId" }, "GroupNames": { "shape": "DescribeInstanceTopologyGroupNameSet", "documentation": "The name of the placement group that each instance is in.
Constraints: Maximum 100 explicitly specified placement group names.
", "locationName": "GroupName" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.
instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.
zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.
Information about the topology of each instance.
", "locationName": "instanceSet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
The location type.
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.
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.
One or more filters. Filter names and values are case-sensitive.
instance-type - The instance type. For a list of possible values, see Instance.
location - The location. For a list of possible identifiers, see Regions and Zones.
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.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "DescribeInstanceTypeOfferingsResult": { "type": "structure", "members": { "InstanceTypeOfferings": { "shape": "InstanceTypeOfferingsList", "documentation": "The instance types offered in the location.
", "locationName": "instanceTypeOfferingSet" }, "NextToken": { "shape": "NextToken", "documentation": "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.
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.
The instance types.
", "locationName": "InstanceType" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
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).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.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).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.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.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support - Indicates whether Nitro Enclaves 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).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
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.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "DescribeInstanceTypesResult": { "type": "structure", "members": { "InstanceTypes": { "shape": "InstanceTypeInfoList", "documentation": "The instance type.
", "locationName": "instanceTypeSet" }, "NextToken": { "shape": "NextToken", "documentation": "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.
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi | uefi-preferred).
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity Reservation preference (open | none).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.
client-token - The idempotency token you provided when you launched the instance.
current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (legacy-bios | uefi).
dns-name - The public DNS name of the instance.
ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
iam-instance-profile.name - The instance profile associated with the instance. Specified as an name.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot | scheduled | capacity-block).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
ipv6-address - The IPv6 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (disabled | default).
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (disabled | enabled).
metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (disabled | enabled).
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
metadata-options.state - The state of the metadata option changes (pending | applied).
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.association.allocation-id - The allocation ID.
network-interface.addresses.association.association-id - The association ID.
network-interface.addresses.association.carrier-ip - The carrier IP address.
network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name - The public DNS name.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name - The private DNS name.
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip - The customer-owned IP address.
network-interface.association.customer-owned-ip - The customer-owned IP address.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name - The public DNS name.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index - The index of the network card.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.outpost-arn - The ARN of the Outpost.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.private-ip-address - The private IPv4 address.
network-interface.public-dns-name - The public DNS name.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.tag-key - The key of a tag assigned to the network interface.
network-interface.tag-value - The value of a tag assigned to the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
usage-operation - The usage operation value for the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
", "locationName": "InstanceId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName": "nextToken" } } }, "DescribeInstancesResult": { "type": "structure", "members": { "Reservations": { "shape": "ReservationList", "documentation": "Information about the reservations.
", "locationName": "reservationSet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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.
The IDs of the internet gateways.
Default: Describes all your internet gateways.
", "locationName": "internetGatewayId" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeInternetGatewaysMaxResults", "documentation": "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.
" } } }, "DescribeInternetGatewaysResult": { "type": "structure", "members": { "InternetGateways": { "shape": "InternetGatewayList", "documentation": "Information about one or more internet gateways.
", "locationName": "internetGatewaySet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" } } }, "DescribeIpamByoasnResult": { "type": "structure", "members": { "Byoasns": { "shape": "ByoasnSet", "documentation": "ASN and BYOIP CIDR associations.
", "locationName": "byoasnSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A check for 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.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "locationName": "Filter" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of results to return in the request.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "IpamPoolIds": { "shape": "ValueStringList", "documentation": "The IDs of the IPAM pools you would like information on.
", "locationName": "IpamPoolId" } } }, "DescribeIpamPoolsResult": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the IPAM pools.
", "locationName": "ipamPoolSet" } } }, "DescribeIpamResourceDiscoveriesRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The IPAM resource discovery IDs.
", "locationName": "IpamResourceDiscoveryId" }, "NextToken": { "shape": "NextToken", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of resource discoveries to return in one page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "The resource discovery filters.
", "locationName": "Filter" } } }, "DescribeIpamResourceDiscoveriesResult": { "type": "structure", "members": { "IpamResourceDiscoveries": { "shape": "IpamResourceDiscoverySet", "documentation": "The resource discoveries.
", "locationName": "ipamResourceDiscoverySet" }, "NextToken": { "shape": "NextToken", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", "locationName": "nextToken" } } }, "DescribeIpamResourceDiscoveryAssociationsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The resource discovery association IDs.
", "locationName": "IpamResourceDiscoveryAssociationId" }, "NextToken": { "shape": "NextToken", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of resource discovery associations to return in one page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "The resource discovery association filters.
", "locationName": "Filter" } } }, "DescribeIpamResourceDiscoveryAssociationsResult": { "type": "structure", "members": { "IpamResourceDiscoveryAssociations": { "shape": "IpamResourceDiscoveryAssociationSet", "documentation": "The resource discovery associations.
", "locationName": "ipamResourceDiscoveryAssociationSet" }, "NextToken": { "shape": "NextToken", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", "locationName": "nextToken" } } }, "DescribeIpamScopesRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "locationName": "Filter" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of results to return in the request.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "IpamScopeIds": { "shape": "ValueStringList", "documentation": "The IDs of the scopes you want information on.
", "locationName": "IpamScopeId" } } }, "DescribeIpamScopesResult": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The scopes you want information on.
", "locationName": "ipamScopeSet" } } }, "DescribeIpamsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "locationName": "Filter" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of results to return in the request.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "IpamIds": { "shape": "ValueStringList", "documentation": "The IDs of the IPAMs you want information on.
", "locationName": "IpamId" } } }, "DescribeIpamsResult": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the IPAMs.
", "locationName": "ipamSet" } } }, "DescribeIpv6PoolsRequest": { "type": "structure", "members": { "PoolIds": { "shape": "Ipv6PoolIdList", "documentation": "The IDs of the IPv6 address pools.
", "locationName": "PoolId" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "MaxResults": { "shape": "Ipv6PoolMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Information about the IPv6 address pools.
", "locationName": "ipv6PoolSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The key pair names.
Default: Describes all of your key pairs.
", "locationName": "KeyName" }, "KeyPairIds": { "shape": "KeyPairIdStringList", "documentation": "The IDs of the key pairs.
", "locationName": "KeyPairId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
If true, the public key material is included in the response.
Default: false
Information about the key pairs.
", "locationName": "keySet" } } }, "DescribeLaunchTemplateVersionsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
" }, "LaunchTemplateName": { "shape": "LaunchTemplateName", "documentation": "The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the launch template name or the launch template ID, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
" }, "Versions": { "shape": "VersionStringList", "documentation": "One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same request. You cannot specify numbers.
The version number after which to describe launch template versions.
" }, "MaxVersion": { "shape": "String", "documentation": "The version number up to which to describe launch template versions.
" }, "NextToken": { "shape": "String", "documentation": "The token to request the next page of results.
" }, "MaxResults": { "shape": "Integer", "documentation": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.
One or more filters.
create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
http-tokens - The state of token usage for your instance metadata requests (optional | required).
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
license-configuration-arn - The ARN of the license configuration.
network-card-index - The index of the network card.
ram-disk-id - The RAM disk ID.
If true, and if a Systems Manager parameter is specified for ImageId, the AMI ID is displayed in the response for imageId.
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.
Default: false
Information about the launch template versions.
", "locationName": "launchTemplateVersionSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
One or more launch template IDs.
", "locationName": "LaunchTemplateId" }, "LaunchTemplateNames": { "shape": "LaunchTemplateNameStringList", "documentation": "One or more launch template names.
", "locationName": "LaunchTemplateName" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
create-time - The time the launch template was created.
launch-template-name - The name of the launch template.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The token to request the next page of results.
" }, "MaxResults": { "shape": "DescribeLaunchTemplatesMaxResults", "documentation": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.
Information about the launch templates.
", "locationName": "launchTemplates" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the associations.
", "locationName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
state - The state of the association.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the associations.
", "locationName": "localGatewayRouteTableVirtualInterfaceGroupAssociationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the associations.
", "locationName": "LocalGatewayRouteTableVpcAssociationId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the association.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id - The ID of the association.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table for the association.
state - The state of the association.
vpc-id - The ID of the VPC.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the associations.
", "locationName": "localGatewayRouteTableVpcAssociationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the local gateway route tables.
", "locationName": "LocalGatewayRouteTableId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.
local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.
state - The state of the local gateway route table.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the local gateway route tables.
", "locationName": "localGatewayRouteTableSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the virtual interface groups.
", "locationName": "LocalGatewayVirtualInterfaceGroupId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The virtual interface groups.
", "locationName": "localGatewayVirtualInterfaceGroupSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the virtual interfaces.
", "locationName": "LocalGatewayVirtualInterfaceId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
local-address - The local address.
local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local-gateway-id - The ID of the local gateway.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
vlan - The ID of the VLAN.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the virtual interfaces.
", "locationName": "localGatewayVirtualInterfaceSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the local gateways.
", "locationName": "LocalGatewayId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the local gateways.
", "locationName": "localGatewaySet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
lock-state - The state of the snapshot lock (compliance-cooloff | governance | compliance | expired).
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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "SnapshotIds": { "shape": "SnapshotIdStringList", "documentation": "The IDs of the snapshots for which to view the lock status.
", "locationName": "SnapshotId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the snapshots.
", "locationName": "snapshotSet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters.
availability-zone - The Availability Zone of the EC2 Mac Dedicated Host.
instance-type - The instance type size that the EC2 Mac Dedicated Host is configured to support.
The IDs of the EC2 Mac Dedicated Hosts.
", "locationName": "HostId" }, "MaxResults": { "shape": "DescribeMacHostsRequestMaxResults", "documentation": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The token to use to retrieve the next page of results.
" } } }, "DescribeMacHostsRequestMaxResults": { "type": "integer", "max": 500, "min": 5 }, "DescribeMacHostsResult": { "type": "structure", "members": { "MacHosts": { "shape": "MacHostList", "documentation": "Information about the EC2 Mac Dedicated Hosts.
", "locationName": "macHostSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
", "locationName": "nextToken" } } }, "DescribeManagedPrefixListsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
One or more filters.
owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the prefix list.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "PrefixListIds": { "shape": "ValueStringList", "documentation": "One or more prefix list IDs.
", "locationName": "PrefixListId" } } }, "DescribeManagedPrefixListsResult": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the prefix lists.
", "locationName": "prefixListSet" } } }, "DescribeMovingAddressesMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "DescribeMovingAddressesRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
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.
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token for the next page of results.
", "locationName": "nextToken" }, "PublicIps": { "shape": "ValueStringList", "documentation": "One or more Elastic IP addresses.
", "locationName": "publicIp" } } }, "DescribeMovingAddressesResult": { "type": "structure", "members": { "MovingAddressStatuses": { "shape": "MovingAddressStatusSet", "documentation": "The status for each Elastic IP address.
", "locationName": "movingAddressStatusSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
The filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
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.
" }, "NatGatewayIds": { "shape": "NatGatewayIdStringList", "documentation": "The IDs of the NAT gateways.
", "locationName": "NatGatewayId" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "DescribeNatGatewaysResult": { "type": "structure", "members": { "NatGateways": { "shape": "NatGatewayList", "documentation": "Information about the NAT gateways.
", "locationName": "natGatewaySet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.egress - A Boolean that indicates the type of rule. Specify true for egress rules, or false for ingress rules.
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
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.
The IDs of the network ACLs.
Default: Describes all your network ACLs.
", "locationName": "NetworkAclId" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeNetworkAclsMaxResults", "documentation": "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.
" } } }, "DescribeNetworkAclsResult": { "type": "structure", "members": { "NetworkAcls": { "shape": "NetworkAclList", "documentation": "Information about one or more network ACLs.
", "locationName": "networkAclSet" }, "NextToken": { "shape": "String", "documentation": "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.
The IDs of the Network Access Scope analyses.
", "locationName": "NetworkInsightsAccessScopeAnalysisId" }, "NetworkInsightsAccessScopeId": { "shape": "NetworkInsightsAccessScopeId", "documentation": "The ID of the Network Access Scope.
" }, "AnalysisStartTimeBegin": { "shape": "MillisecondDateTime", "documentation": "Filters the results based on the start time. The analysis must have started on or after this time.
" }, "AnalysisStartTimeEnd": { "shape": "MillisecondDateTime", "documentation": "Filters the results based on the start time. The analysis must have started on or before this time.
" }, "Filters": { "shape": "FilterList", "documentation": "There are no supported filters.
", "locationName": "Filter" }, "MaxResults": { "shape": "NetworkInsightsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
The token for the next page of results.
" } } }, "DescribeNetworkInsightsAccessScopeAnalysesResult": { "type": "structure", "members": { "NetworkInsightsAccessScopeAnalyses": { "shape": "NetworkInsightsAccessScopeAnalysisList", "documentation": "The Network Access Scope analyses.
", "locationName": "networkInsightsAccessScopeAnalysisSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the Network Access Scopes.
", "locationName": "NetworkInsightsAccessScopeId" }, "Filters": { "shape": "FilterList", "documentation": "There are no supported filters.
", "locationName": "Filter" }, "MaxResults": { "shape": "NetworkInsightsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
The token for the next page of results.
" } } }, "DescribeNetworkInsightsAccessScopesResult": { "type": "structure", "members": { "NetworkInsightsAccessScopes": { "shape": "NetworkInsightsAccessScopeList", "documentation": "The Network Access Scopes.
", "locationName": "networkInsightsAccessScopeSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
", "locationName": "NetworkInsightsAnalysisId" }, "NetworkInsightsPathId": { "shape": "NetworkInsightsPathId", "documentation": "The ID of the path. You must specify either a path ID or analysis IDs.
" }, "AnalysisStartTime": { "shape": "MillisecondDateTime", "documentation": "The time when the network insights analyses started.
" }, "AnalysisEndTime": { "shape": "MillisecondDateTime", "documentation": "The time when the network insights analyses ended.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters. The following are the possible values:
path-found - A Boolean value that indicates whether a feasible path is found.
status - The status of the analysis (running | succeeded | failed).
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
The token for the next page of results.
" } } }, "DescribeNetworkInsightsAnalysesResult": { "type": "structure", "members": { "NetworkInsightsAnalyses": { "shape": "NetworkInsightsAnalysisList", "documentation": "Information about the network insights analyses.
", "locationName": "networkInsightsAnalysisSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the paths.
", "locationName": "NetworkInsightsPathId" }, "Filters": { "shape": "FilterList", "documentation": "The filters. The following are the possible values:
destination - The ID of the resource.
filter-at-source.source-address - The source IPv4 address at the source.
filter-at-source.source-port-range - The source port range at the source.
filter-at-source.destination-address - The destination IPv4 address at the source.
filter-at-source.destination-port-range - The destination port range at the source.
filter-at-destination.source-address - The source IPv4 address at the destination.
filter-at-destination.source-port-range - The source port range at the destination.
filter-at-destination.destination-address - The destination IPv4 address at the destination.
filter-at-destination.destination-port-range - The destination port range at the destination.
protocol - The protocol.
source - The ID of the resource.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
The token for the next page of results.
" } } }, "DescribeNetworkInsightsPathsResult": { "type": "structure", "members": { "NetworkInsightsPaths": { "shape": "NetworkInsightsPathList", "documentation": "Information about the paths.
", "locationName": "networkInsightsPathSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The attribute of the network interface. This parameter is required.
", "locationName": "attribute" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the network interface.
", "locationName": "networkInterfaceId" } }, "documentation": "Contains the parameters for DescribeNetworkInterfaceAttribute.
" }, "DescribeNetworkInterfaceAttributeResult": { "type": "structure", "members": { "Attachment": { "shape": "NetworkInterfaceAttachment", "documentation": "The attachment (if any) of the network interface.
", "locationName": "attachment" }, "Description": { "shape": "AttributeValue", "documentation": "The description of the network interface.
", "locationName": "description" }, "Groups": { "shape": "GroupIdentifierList", "documentation": "The security groups associated with the network interface.
", "locationName": "groupSet" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "SourceDestCheck": { "shape": "AttributeBooleanValue", "documentation": "Indicates whether source/destination checking is enabled.
", "locationName": "sourceDestCheck" }, "AssociatePublicIpAddress": { "shape": "Boolean", "documentation": "Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
", "locationName": "associatePublicIpAddress" } }, "documentation": "Contains the output of DescribeNetworkInterfaceAttribute.
" }, "DescribeNetworkInterfacePermissionsMaxResults": { "type": "integer", "max": 255, "min": 5 }, "DescribeNetworkInterfacePermissionsRequest": { "type": "structure", "members": { "NetworkInterfacePermissionIds": { "shape": "NetworkInterfacePermissionIdList", "documentation": "The network interface permission IDs.
", "locationName": "NetworkInterfacePermissionId" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeNetworkInterfacePermissionsMaxResults", "documentation": "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. If this parameter is not specified, up to 50 results are returned by default. For more information, see Pagination.
" } }, "documentation": "Contains the parameters for DescribeNetworkInterfacePermissions.
" }, "DescribeNetworkInterfacePermissionsResult": { "type": "structure", "members": { "NetworkInterfacePermissions": { "shape": "NetworkInterfacePermissionList", "documentation": "The network interface permissions.
", "locationName": "networkInterfacePermissions" }, "NextToken": { "shape": "String", "documentation": "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.
Contains the output for DescribeNetworkInterfacePermissions.
" }, "DescribeNetworkInterfacesMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "DescribeNetworkInterfacesRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "One or more filters.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.attachment-id - The ID of the interface attachment.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-dns-name - The private DNS name of the network interface (IPv4).
private-ip-address - The private IPv4 address or addresses of the network interface.
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
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.
The network interface IDs.
Default: Describes all your network interfaces.
", "locationName": "NetworkInterfaceId" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeNetworkInterfacesMaxResults", "documentation": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.
" } }, "documentation": "Contains the parameters for DescribeNetworkInterfaces.
" }, "DescribeNetworkInterfacesResult": { "type": "structure", "members": { "NetworkInterfaces": { "shape": "NetworkInterfaceList", "documentation": "Information about the network interfaces.
", "locationName": "networkInterfaceSet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group (host | rack).
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
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.
The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
", "locationName": "groupName" }, "GroupIds": { "shape": "PlacementGroupIdStringList", "documentation": "The IDs of the placement groups.
", "locationName": "GroupId" } } }, "DescribePlacementGroupsResult": { "type": "structure", "members": { "PlacementGroups": { "shape": "PlacementGroupList", "documentation": "Information about the placement groups.
", "locationName": "placementGroupSet" } } }, "DescribePrefixListsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
One or more filters.
prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "PrefixListIds": { "shape": "PrefixListResourceIdStringList", "documentation": "One or more prefix list IDs.
", "locationName": "PrefixListId" } } }, "DescribePrefixListsResult": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
All available prefix lists.
", "locationName": "prefixListSet" } } }, "DescribePrincipalIdFormatMaxResults": { "type": "integer", "max": 1000, "min": 1 }, "DescribePrincipalIdFormatRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
" }, "NextToken": { "shape": "String", "documentation": "The token to request the next page of results.
" } } }, "DescribePrincipalIdFormatResult": { "type": "structure", "members": { "Principals": { "shape": "PrincipalIdFormatList", "documentation": "Information about the ID format settings for the ARN.
", "locationName": "principalSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", "locationName": "nextToken" } } }, "DescribePublicIpv4PoolsRequest": { "type": "structure", "members": { "PoolIds": { "shape": "PublicIpv4PoolIdStringList", "documentation": "The IDs of the address pools.
", "locationName": "PoolId" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "MaxResults": { "shape": "PoolMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Information about the address pools.
", "locationName": "publicIpv4PoolSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
", "locationName": "RegionName" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether to display all Regions, including Regions that are disabled for your account.
" } } }, "DescribeRegionsResult": { "type": "structure", "members": { "Regions": { "shape": "RegionList", "documentation": "Information about the Regions.
", "locationName": "regionInfo" } } }, "DescribeReplaceRootVolumeTasksMaxResults": { "type": "integer", "max": 50, "min": 1 }, "DescribeReplaceRootVolumeTasksRequest": { "type": "structure", "members": { "ReplaceRootVolumeTaskIds": { "shape": "ReplaceRootVolumeTaskIds", "documentation": "The ID of the root volume replacement task to view.
", "locationName": "ReplaceRootVolumeTaskId" }, "Filters": { "shape": "FilterList", "documentation": "Filter to use:
instance-id - The ID of the instance for which the root volume replacement task was created.
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.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the root volume replacement task.
", "locationName": "replaceRootVolumeTaskSet" }, "NextToken": { "shape": "String", "documentation": "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.
One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
One or more Reserved Instance IDs.
", "locationName": "reservedInstancesId" }, "ReservedInstancesListingId": { "shape": "ReservedInstancesListingId", "documentation": "One or more Reserved Instance listing IDs.
", "locationName": "reservedInstancesListingId" } }, "documentation": "Contains the parameters for DescribeReservedInstancesListings.
" }, "DescribeReservedInstancesListingsResult": { "type": "structure", "members": { "ReservedInstancesListings": { "shape": "ReservedInstancesListingList", "documentation": "Information about the Reserved Instance listing.
", "locationName": "reservedInstancesListingsSet" } }, "documentation": "Contains the output of DescribeReservedInstancesListings.
" }, "DescribeReservedInstancesModificationsRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
IDs for the submitted modification request.
", "locationName": "ReservedInstancesModificationId" }, "NextToken": { "shape": "String", "documentation": "The token to retrieve the next page of results.
", "locationName": "nextToken" } }, "documentation": "Contains the parameters for DescribeReservedInstancesModifications.
" }, "DescribeReservedInstancesModificationsResult": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The Reserved Instance modification information.
", "locationName": "reservedInstancesModificationsSet" } }, "documentation": "Contains the output of DescribeReservedInstancesModifications.
" }, "DescribeReservedInstancesOfferingsRequest": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which the Reserved Instance can be used.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
Include Reserved Instance Marketplace offerings in the response.
" }, "InstanceType": { "shape": "InstanceType", "documentation": "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 maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
" }, "MaxInstanceCount": { "shape": "Integer", "documentation": "The maximum number of instances to filter when searching for offerings.
Default: 20
" }, "MinDuration": { "shape": "Long", "documentation": "The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
" }, "OfferingClass": { "shape": "OfferingClassType", "documentation": "The offering class of the Reserved Instance. Can be standard or convertible.
The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
One or more Reserved Instances offering IDs.
", "locationName": "ReservedInstancesOfferingId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token to retrieve the next page of results.
", "locationName": "nextToken" }, "OfferingType": { "shape": "OfferingTypeValues", "documentation": "The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
Contains the parameters for DescribeReservedInstancesOfferings.
" }, "DescribeReservedInstancesOfferingsResult": { "type": "structure", "members": { "ReservedInstancesOfferings": { "shape": "ReservedInstancesOfferingList", "documentation": "A list of Reserved Instances offerings.
", "locationName": "reservedInstancesOfferingsSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the output of DescribeReservedInstancesOfferings.
" }, "DescribeReservedInstancesRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
Describes whether the Reserved Instance is Standard or Convertible.
" }, "ReservedInstancesIds": { "shape": "ReservedInstancesIdStringList", "documentation": "One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
", "locationName": "ReservedInstancesId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
Contains the parameters for DescribeReservedInstances.
" }, "DescribeReservedInstancesResult": { "type": "structure", "members": { "ReservedInstances": { "shape": "ReservedInstancesList", "documentation": "A list of Reserved Instances.
", "locationName": "reservedInstancesSet" } }, "documentation": "Contains the output for DescribeReservedInstances.
" }, "DescribeRouteTablesMaxResults": { "type": "integer", "max": 100, "min": 5 }, "DescribeRouteTablesRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters.
association.gateway-id - The ID of the gateway involved in the association.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the route table.
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.
The IDs of the route tables.
Default: Describes all your route tables.
", "locationName": "RouteTableId" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeRouteTablesMaxResults", "documentation": "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.
" } } }, "DescribeRouteTablesResult": { "type": "structure", "members": { "RouteTables": { "shape": "RouteTableList", "documentation": "Information about one or more route tables.
", "locationName": "routeTableSet" }, "NextToken": { "shape": "String", "documentation": "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.
Contains the output of DescribeRouteTables.
" }, "DescribeScheduledInstanceAvailabilityMaxResults": { "type": "integer", "max": 300, "min": 5 }, "DescribeScheduledInstanceAvailabilityRequest": { "type": "structure", "required": [ "FirstSlotStartTimeRange", "Recurrence" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
platform - The platform (Linux/UNIX or Windows).
The time period for the first schedule to start.
" }, "MaxResults": { "shape": "DescribeScheduledInstanceAvailabilityMaxResults", "documentation": "The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.
The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
" }, "NextToken": { "shape": "String", "documentation": "The token for the next set of results.
" }, "Recurrence": { "shape": "ScheduledInstanceRecurrenceRequest", "documentation": "The schedule recurrence.
" } }, "documentation": "Contains the parameters for DescribeScheduledInstanceAvailability.
" }, "DescribeScheduledInstanceAvailabilityResult": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token required to retrieve the next set of results. This value is null when there are no more results to return.
Information about the available Scheduled Instances.
", "locationName": "scheduledInstanceAvailabilitySet" } }, "documentation": "Contains the output of DescribeScheduledInstanceAvailability.
" }, "DescribeScheduledInstancesRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
platform - The platform (Linux/UNIX or Windows).
The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.
The token for the next set of results.
" }, "ScheduledInstanceIds": { "shape": "ScheduledInstanceIdRequestSet", "documentation": "The Scheduled Instance IDs.
", "locationName": "ScheduledInstanceId" }, "SlotStartTimeRange": { "shape": "SlotStartTimeRangeRequest", "documentation": "The time period for the first schedule to start.
" } }, "documentation": "Contains the parameters for DescribeScheduledInstances.
" }, "DescribeScheduledInstancesResult": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token required to retrieve the next set of results. This value is null when there are no more results to return.
Information about the Scheduled Instances.
", "locationName": "scheduledInstanceSet" } }, "documentation": "Contains the output of DescribeScheduledInstances.
" }, "DescribeSecurityGroupReferencesRequest": { "type": "structure", "required": [ "GroupId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the security groups in your account.
" } } }, "DescribeSecurityGroupReferencesResult": { "type": "structure", "members": { "SecurityGroupReferenceSet": { "shape": "SecurityGroupReferences", "documentation": "Information about the VPCs with the referencing security groups.
", "locationName": "securityGroupReferenceSet" } } }, "DescribeSecurityGroupRulesMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "DescribeSecurityGroupRulesRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "One or more filters.
group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The IDs of the security group rules.
", "locationName": "SecurityGroupRuleId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeSecurityGroupRulesMaxResults", "documentation": "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 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.
" } } }, "DescribeSecurityGroupRulesResult": { "type": "structure", "members": { "SecurityGroupRules": { "shape": "SecurityGroupRuleList", "documentation": "Information about security group rules.
", "locationName": "securityGroupRuleSet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
owner-id - The Amazon Web Services account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
", "locationName": "GroupId" }, "GroupNames": { "shape": "GroupNameStringList", "documentation": "[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.
Default: Describes all of your security groups.
", "locationName": "GroupName" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeSecurityGroupsMaxResults", "documentation": "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 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.
" } } }, "DescribeSecurityGroupsResult": { "type": "structure", "members": { "SecurityGroups": { "shape": "SecurityGroupList", "documentation": "Information about the security groups.
", "locationName": "securityGroupInfo" }, "NextToken": { "shape": "String", "documentation": "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.
The snapshot attribute you would like to view.
" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the EBS snapshot.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The users and groups that have the permissions for creating volumes from the snapshot.
", "locationName": "createVolumePermission" }, "ProductCodes": { "shape": "ProductCodeList", "documentation": "The product codes.
", "locationName": "productCodes" }, "SnapshotId": { "shape": "String", "documentation": "The ID of the EBS snapshot.
", "locationName": "snapshotId" } } }, "DescribeSnapshotTierStatusMaxResults": { "type": "integer" }, "DescribeSnapshotTierStatusRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters.
snapshot-id - The snapshot ID.
volume-id - The ID of the volume the snapshot is for.
last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)
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.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeSnapshotTierStatusMaxResults", "documentation": "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.
" } } }, "DescribeSnapshotTierStatusResult": { "type": "structure", "members": { "SnapshotTierStatuses": { "shape": "snapshotTierStatusSet", "documentation": "Information about the snapshot's storage tier.
", "locationName": "snapshotTierStatusSet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters.
description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true | false)
owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
storage-tier - The storage tier of the snapshot (archive | standard).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "OwnerIds": { "shape": "OwnerStringList", "documentation": "Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
", "locationName": "RestorableBy" }, "SnapshotIds": { "shape": "SnapshotIdStringList", "documentation": "The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
", "locationName": "SnapshotId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the snapshots.
", "locationName": "snapshotSet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
Contains the parameters for DescribeSpotDatafeedSubscription.
" }, "DescribeSpotDatafeedSubscriptionResult": { "type": "structure", "members": { "SpotDatafeedSubscription": { "shape": "SpotDatafeedSubscription", "documentation": "The Spot Instance data feed subscription.
", "locationName": "spotDatafeedSubscription" } }, "documentation": "Contains the output of DescribeSpotDatafeedSubscription.
" }, "DescribeSpotFleetInstancesMaxResults": { "type": "integer", "max": 1000, "min": 1 }, "DescribeSpotFleetInstancesRequest": { "type": "structure", "required": [ "SpotFleetRequestId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
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.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "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.
The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" } }, "documentation": "Contains the parameters for DescribeSpotFleetInstances.
" }, "DescribeSpotFleetInstancesResponse": { "type": "structure", "members": { "ActiveInstances": { "shape": "ActiveInstanceSet", "documentation": "The running instances. This list is refreshed periodically and might be out of date.
", "locationName": "activeInstanceSet" }, "NextToken": { "shape": "String", "documentation": "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.
The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" } }, "documentation": "Contains the output of DescribeSpotFleetInstances.
" }, "DescribeSpotFleetRequestHistoryMaxResults": { "type": "integer", "max": 1000, "min": 1 }, "DescribeSpotFleetRequestHistoryRequest": { "type": "structure", "required": [ "SpotFleetRequestId", "StartTime" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The type of events to describe. By default, all events are described.
", "locationName": "eventType" }, "MaxResults": { "shape": "DescribeSpotFleetRequestHistoryMaxResults", "documentation": "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.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "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.
The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" }, "StartTime": { "shape": "DateTime", "documentation": "The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "startTime" } }, "documentation": "Contains the parameters for DescribeSpotFleetRequestHistory.
" }, "DescribeSpotFleetRequestHistoryResponse": { "type": "structure", "members": { "HistoryRecords": { "shape": "HistoryRecords", "documentation": "Information about the events in the history of the Spot Fleet request.
", "locationName": "historyRecordSet" }, "LastEvaluatedTime": { "shape": "DateTime", "documentation": "The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more items, this value is not present.
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.
The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" }, "StartTime": { "shape": "DateTime", "documentation": "The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "startTime" } }, "documentation": "Contains the output of DescribeSpotFleetRequestHistory.
" }, "DescribeSpotFleetRequestsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
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.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "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.
The IDs of the Spot Fleet requests.
", "locationName": "spotFleetRequestId" } }, "documentation": "Contains the parameters for DescribeSpotFleetRequests.
" }, "DescribeSpotFleetRequestsResponse": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "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.
Information about the configuration of your Spot Fleet.
", "locationName": "spotFleetRequestConfigSet" } }, "documentation": "Contains the output of DescribeSpotFleetRequests.
" }, "DescribeSpotInstanceRequestsRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 or gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic.
launch.group-id - The ID of the security group for the instance.
launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of Spot Instance request (one-time | persistent).
valid-from - The start date of the request.
valid-until - The end date of the request.
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.
The IDs of the Spot Instance requests.
", "locationName": "SpotInstanceRequestId" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "Integer", "documentation": "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.
" } }, "documentation": "Contains the parameters for DescribeSpotInstanceRequests.
" }, "DescribeSpotInstanceRequestsResult": { "type": "structure", "members": { "SpotInstanceRequests": { "shape": "SpotInstanceRequestList", "documentation": "The Spot Instance requests.
", "locationName": "spotInstanceRequestSet" }, "NextToken": { "shape": "String", "documentation": "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.
Contains the output of DescribeSpotInstanceRequests.
" }, "DescribeSpotPriceHistoryRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, ddd MMM dd HH:mm:ss UTC YYYY). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
Filters the results by the specified Availability Zone.
", "locationName": "availabilityZone" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "endTime" }, "InstanceTypes": { "shape": "InstanceTypeList", "documentation": "Filters the results by the specified instance types.
", "locationName": "InstanceType" }, "MaxResults": { "shape": "Integer", "documentation": "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.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName": "nextToken" }, "ProductDescriptions": { "shape": "ProductDescriptionList", "documentation": "Filters the results by the specified basic product descriptions.
", "locationName": "ProductDescription" }, "StartTime": { "shape": "DateTime", "documentation": "The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "startTime" } }, "documentation": "Contains the parameters for DescribeSpotPriceHistory.
" }, "DescribeSpotPriceHistoryResult": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to include in another request to get the next page of items. This value is an empty string (\"\") or null when there are no more items to return.
The historical Spot prices.
", "locationName": "spotPriceHistorySet" } }, "documentation": "Contains the output of DescribeSpotPriceHistory.
" }, "DescribeStaleSecurityGroupsMaxResults": { "type": "integer", "max": 255, "min": 5 }, "DescribeStaleSecurityGroupsNextToken": { "type": "string", "max": 1024, "min": 1 }, "DescribeStaleSecurityGroupsRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
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.
" }, "NextToken": { "shape": "DescribeStaleSecurityGroupsNextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" } } }, "DescribeStaleSecurityGroupsResult": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "The token to include in another request to get the next page of items. If there are no additional items to return, the string is empty.
", "locationName": "nextToken" }, "StaleSecurityGroupSet": { "shape": "StaleSecurityGroupSet", "documentation": "Information about the stale security groups.
", "locationName": "staleSecurityGroupSet" } } }, "DescribeStoreImageTasksRequest": { "type": "structure", "members": { "ImageIds": { "shape": "ImageIdList", "documentation": "The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
", "locationName": "ImageId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The filters.
task-state - Returns tasks in a certain state (InProgress | Completed | Failed)
bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.
When you specify the ImageIds parameter, any filters that you specify are ignored. To use the filters, you must remove the ImageIds parameter.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeStoreImageTasksRequestMaxResults", "documentation": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the ImageIds parameter in the same call.
The information about the AMI store tasks.
", "locationName": "storeImageTaskResultSet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.
default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.
enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the subnet.
private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).
private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
The IDs of the subnets.
Default: Describes all your subnets.
", "locationName": "SubnetId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeSubnetsMaxResults", "documentation": "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.
" } } }, "DescribeSubnetsResult": { "type": "structure", "members": { "Subnets": { "shape": "SubnetList", "documentation": "Information about one or more subnets.
", "locationName": "subnetSet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify \"tag:Owner\" for the filter name and \"TeamA\" for the filter value to find resources with the tag \"Owner=TeamA\".
value - The tag value.
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName": "nextToken" } } }, "DescribeTagsResult": { "type": "structure", "members": { "NextToken": { "shape": "String", "documentation": "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.
The tags.
", "locationName": "tagSet" } } }, "DescribeTrafficMirrorFiltersRequest": { "type": "structure", "members": { "TrafficMirrorFilterIds": { "shape": "TrafficMirrorFilterIdList", "documentation": "The ID of the Traffic Mirror filter.
", "locationName": "TrafficMirrorFilterId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
One or more filters. The possible values are:
description: The Traffic Mirror filter description.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" } } }, "DescribeTrafficMirrorFiltersResult": { "type": "structure", "members": { "TrafficMirrorFilters": { "shape": "TrafficMirrorFilterSet", "documentation": "Information about one or more Traffic Mirror filters.
", "locationName": "trafficMirrorFilterSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The ID of the Traffic Mirror session.
", "locationName": "TrafficMirrorSessionId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
One or more filters. The possible values are:
description: The Traffic Mirror session description.
network-interface-id: The ID of the Traffic Mirror session network interface.
owner-id: The ID of the account that owns the Traffic Mirror session.
packet-length: The assigned number of packets to mirror.
session-number: The assigned session number.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
traffic-mirror-session-id: The ID of the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
virtual-network-id: The virtual network ID of the Traffic Mirror session.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" } } }, "DescribeTrafficMirrorSessionsResult": { "type": "structure", "members": { "TrafficMirrorSessions": { "shape": "TrafficMirrorSessionSet", "documentation": "Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
", "locationName": "trafficMirrorSessionSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The ID of the Traffic Mirror targets.
", "locationName": "TrafficMirrorTargetId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
One or more filters. The possible values are:
description: The Traffic Mirror target description.
network-interface-id: The ID of the Traffic Mirror session network interface.
network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
owner-id: The ID of the account that owns the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" } } }, "DescribeTrafficMirrorTargetsResult": { "type": "structure", "members": { "TrafficMirrorTargets": { "shape": "TrafficMirrorTargetSet", "documentation": "Information about one or more Traffic Mirror targets.
", "locationName": "trafficMirrorTargetSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The IDs of the attachments.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the attachments.
", "locationName": "transitGatewayAttachments" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the Connect peers.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
state - The state of the Connect peer (pending | available | deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the Connect peers.
", "locationName": "transitGatewayConnectPeerSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the attachments.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
options.protocol - The tunnel protocol (gre).
state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment.
transit-gateway-id - The ID of the transit gateway.
transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the Connect attachments.
", "locationName": "transitGatewayConnectSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway multicast domain.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateway multicast domains.
", "locationName": "transitGatewayMulticastDomains" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
One or more IDs of the transit gateway peering attachments.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The transit gateway peering attachments.
", "locationName": "transitGatewayPeeringAttachments" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the transit gateway policy tables.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters associated with the transit gateway policy table.
", "locationName": "Filter" }, "MaxResults": { "shape": "TransitGatewayMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Describes the transit gateway policy tables.
", "locationName": "transitGatewayPolicyTables" }, "NextToken": { "shape": "String", "documentation": "The token for the next page of results.
", "locationName": "nextToken" } } }, "DescribeTransitGatewayRouteTableAnnouncementsRequest": { "type": "structure", "members": { "TransitGatewayRouteTableAnnouncementIds": { "shape": "TransitGatewayRouteTableAnnouncementIdStringList", "documentation": "The IDs of the transit gateway route tables that are being advertised.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters associated with the transit gateway policy table.
", "locationName": "Filter" }, "MaxResults": { "shape": "TransitGatewayMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Describes the transit gateway route table announcement.
", "locationName": "transitGatewayRouteTableAnnouncements" }, "NextToken": { "shape": "String", "documentation": "The token for the next page of results.
", "locationName": "nextToken" } } }, "DescribeTransitGatewayRouteTablesRequest": { "type": "structure", "members": { "TransitGatewayRouteTableIds": { "shape": "TransitGatewayRouteTableIdStringList", "documentation": "The IDs of the transit gateway route tables.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
state - The state of the route table (available | deleting | deleted | pending).
transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateway route tables.
", "locationName": "transitGatewayRouteTables" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the attachments.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
vpc-id - The ID of the VPC.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the VPC attachments.
", "locationName": "transitGatewayVpcAttachments" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the transit gateways.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateways.
", "locationName": "transitGatewaySet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the associations.
", "locationName": "AssociationId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
One or more filters.
gre-key - The ID of a trunk interface association.
interface-protocol - The interface protocol. Valid values are VLAN and GRE.
The token for the next page of results.
" }, "MaxResults": { "shape": "DescribeTrunkInterfaceAssociationsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Information about the trunk associations.
", "locationName": "interfaceAssociationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Verified Access endpoint.
", "locationName": "VerifiedAccessEndpointId" }, "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "VerifiedAccessGroupId": { "shape": "VerifiedAccessGroupId", "documentation": "The ID of the Verified Access group.
" }, "MaxResults": { "shape": "DescribeVerifiedAccessEndpointsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
", "locationName": "Filter" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access endpoints.
", "locationName": "verifiedAccessEndpointSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Verified Access groups.
", "locationName": "VerifiedAccessGroupId" }, "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "MaxResults": { "shape": "DescribeVerifiedAccessGroupMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
", "locationName": "Filter" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access groups.
", "locationName": "verifiedAccessGroupSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the Verified Access instances.
", "locationName": "VerifiedAccessInstanceId" }, "MaxResults": { "shape": "DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
", "locationName": "Filter" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The logging configuration for the Verified Access instances.
", "locationName": "loggingConfigurationSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the Verified Access instances.
", "locationName": "VerifiedAccessInstanceId" }, "MaxResults": { "shape": "DescribeVerifiedAccessInstancesMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
", "locationName": "Filter" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access instances.
", "locationName": "verifiedAccessInstanceSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the Verified Access trust providers.
", "locationName": "VerifiedAccessTrustProviderId" }, "MaxResults": { "shape": "DescribeVerifiedAccessTrustProvidersMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. Filter names and values are case-sensitive.
", "locationName": "Filter" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access trust providers.
", "locationName": "verifiedAccessTrustProviderSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The attribute of the volume. This parameter is required.
" }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The state of autoEnableIO attribute.
A list of product codes.
", "locationName": "productCodes" }, "VolumeId": { "shape": "String", "documentation": "The ID of the volume.
", "locationName": "volumeId" } } }, "DescribeVolumeStatusRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "VolumeIds": { "shape": "VolumeIdStringList", "documentation": "The IDs of the volumes.
Default: Describes all your volumes.
", "locationName": "VolumeId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
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.
Information about the status of the volumes.
", "locationName": "volumeStatusSet" } } }, "DescribeVolumesModificationsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the volumes.
", "locationName": "VolumeId" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
modification-state - The current modification state (modifying | optimizing | completed | failed).
original-iops - The original IOPS rate of the volume.
original-size - The original size of the volume, in GiB.
original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
start-time - The modification start time.
target-iops - The target IOPS rate of the volume.
target-size - The target size of the volume, in GiB.
target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
volume-id - The ID of the volume.
The token returned by a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "Integer", "documentation": "The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see Pagination.
" } } }, "DescribeVolumesModificationsResult": { "type": "structure", "members": { "VolumesModifications": { "shape": "VolumeModificationList", "documentation": "Information about the volume modifications.
", "locationName": "volumeModificationSet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
The volume IDs.
", "locationName": "VolumeId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
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.
", "locationName": "maxResults" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
", "locationName": "nextToken" } } }, "DescribeVolumesResult": { "type": "structure", "members": { "Volumes": { "shape": "VolumeList", "documentation": "Information about the volumes.
", "locationName": "volumeSet" }, "NextToken": { "shape": "String", "documentation": "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.
The VPC attribute.
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC.
", "locationName": "vpcId" }, "EnableDnsHostnames": { "shape": "AttributeBooleanValue", "documentation": "Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
Indicates whether Network Address Usage metrics are enabled for your VPC.
", "locationName": "enableNetworkAddressUsageMetrics" } } }, "DescribeVpcClassicLinkDnsSupportMaxResults": { "type": "integer", "max": 255, "min": 5 }, "DescribeVpcClassicLinkDnsSupportNextToken": { "type": "string", "max": 1024, "min": 1 }, "DescribeVpcClassicLinkDnsSupportRequest": { "type": "structure", "members": { "MaxResults": { "shape": "DescribeVpcClassicLinkDnsSupportMaxResults", "documentation": "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.
", "locationName": "maxResults" }, "NextToken": { "shape": "DescribeVpcClassicLinkDnsSupportNextToken", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName": "nextToken" }, "VpcIds": { "shape": "VpcClassicLinkIdList", "documentation": "The IDs of the VPCs.
" } } }, "DescribeVpcClassicLinkDnsSupportResult": { "type": "structure", "members": { "NextToken": { "shape": "DescribeVpcClassicLinkDnsSupportNextToken", "documentation": "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.
Information about the ClassicLink DNS support status of the VPCs.
", "locationName": "vpcs" } } }, "DescribeVpcClassicLinkRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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.
The VPCs for which you want to describe the ClassicLink status.
", "locationName": "VpcId" } } }, "DescribeVpcClassicLinkResult": { "type": "structure", "members": { "Vpcs": { "shape": "VpcClassicLinkList", "documentation": "The ClassicLink status of the VPCs.
", "locationName": "vpcSet" } } }, "DescribeVpcEndpointConnectionNotificationsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the notification.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
connection-notification-arn - The ARN of the SNS topic for the notification.
connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification (Enabled | Disabled).
connection-notification-type - The type of notification (Topic).
service-id - The ID of the endpoint service.
vpc-endpoint-id - The ID of the VPC endpoint.
The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.
The token to request the next page of results.
" } } }, "DescribeVpcEndpointConnectionNotificationsResult": { "type": "structure", "members": { "ConnectionNotificationSet": { "shape": "ConnectionNotificationSet", "documentation": "The notifications.
", "locationName": "connectionNotificationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
The token to retrieve the next page of results.
" } } }, "DescribeVpcEndpointConnectionsResult": { "type": "structure", "members": { "VpcEndpointConnections": { "shape": "VpcEndpointConnectionSet", "documentation": "Information about the VPC endpoint connections.
", "locationName": "vpcEndpointConnectionSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
The IDs of the endpoint services.
", "locationName": "ServiceId" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
The token to retrieve the next page of results.
" } } }, "DescribeVpcEndpointServiceConfigurationsResult": { "type": "structure", "members": { "ServiceConfigurations": { "shape": "ServiceConfigurationSet", "documentation": "Information about the services.
", "locationName": "serviceConfigurationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
The ID of the service.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
principal - The ARN of the principal.
principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
The token to retrieve the next page of results.
" } } }, "DescribeVpcEndpointServicePermissionsResult": { "type": "structure", "members": { "AllowedPrincipals": { "shape": "AllowedPrincipalSet", "documentation": "Information about the allowed principals.
", "locationName": "allowedPrincipals" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
The service names.
", "locationName": "ServiceName" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name of the service.
service-type - The type of service (Interface | Gateway | GatewayLoadBalancer).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
" }, "NextToken": { "shape": "String", "documentation": "The token for the next set of items to return. (You received this token from a prior call.)
" } } }, "DescribeVpcEndpointServicesResult": { "type": "structure", "members": { "ServiceNames": { "shape": "ValueStringList", "documentation": "The supported services.
", "locationName": "serviceNameSet" }, "ServiceDetails": { "shape": "ServiceDetailSet", "documentation": "Information about the service.
", "locationName": "serviceDetailSet" }, "NextToken": { "shape": "String", "documentation": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", "locationName": "nextToken" } } }, "DescribeVpcEndpointsRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the VPC endpoints.
", "locationName": "VpcEndpointId" }, "Filters": { "shape": "FilterList", "documentation": "The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
" }, "NextToken": { "shape": "String", "documentation": "The token for the next set of items to return. (You received this token from a prior call.)
" } } }, "DescribeVpcEndpointsResult": { "type": "structure", "members": { "VpcEndpoints": { "shape": "VpcEndpointSet", "documentation": "Information about the endpoints.
", "locationName": "vpcEndpointSet" }, "NextToken": { "shape": "String", "documentation": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", "locationName": "nextToken" } } }, "DescribeVpcPeeringConnectionsMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "DescribeVpcPeeringConnectionsRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "The filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
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.
The IDs of the VPC peering connections.
Default: Describes all your VPC peering connections.
", "locationName": "VpcPeeringConnectionId" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeVpcPeeringConnectionsMaxResults", "documentation": "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.
" } } }, "DescribeVpcPeeringConnectionsResult": { "type": "structure", "members": { "VpcPeeringConnections": { "shape": "VpcPeeringConnectionList", "documentation": "Information about the VPC peering connections.
", "locationName": "vpcPeeringConnectionSet" }, "NextToken": { "shape": "String", "documentation": "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.
The filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
The IDs of the VPCs.
Default: Describes all your VPCs.
", "locationName": "VpcId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "DescribeVpcsMaxResults", "documentation": "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.
" } } }, "DescribeVpcsResult": { "type": "structure", "members": { "Vpcs": { "shape": "VpcList", "documentation": "Information about one or more VPCs.
", "locationName": "vpcSet" }, "NextToken": { "shape": "String", "documentation": "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.
One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
One or more VPN connection IDs.
Default: Describes your VPN connections.
", "locationName": "VpnConnectionId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DescribeVpnConnections.
" }, "DescribeVpnConnectionsResult": { "type": "structure", "members": { "VpnConnections": { "shape": "VpnConnectionList", "documentation": "Information about one or more VPN connections.
", "locationName": "vpnConnectionSet" } }, "documentation": "Contains the output of DescribeVpnConnections.
" }, "DescribeVpnGatewaysRequest": { "type": "structure", "members": { "Filters": { "shape": "FilterList", "documentation": "One or more filters.
amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
", "locationName": "VpnGatewayId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DescribeVpnGateways.
" }, "DescribeVpnGatewaysResult": { "type": "structure", "members": { "VpnGateways": { "shape": "VpnGatewayList", "documentation": "Information about one or more virtual private gateways.
", "locationName": "vpnGatewaySet" } }, "documentation": "Contains the output of DescribeVpnGateways.
" }, "DestinationFileFormat": { "type": "string", "enum": [ "plain-text", "parquet" ] }, "DestinationOptionsRequest": { "type": "structure", "members": { "FileFormat": { "shape": "DestinationFileFormat", "documentation": "The format for the flow log. The default is plain-text.
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is false.
Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false.
Describes the destination options for a flow log.
" }, "DestinationOptionsResponse": { "type": "structure", "members": { "FileFormat": { "shape": "DestinationFileFormat", "documentation": "The format for the flow log.
", "locationName": "fileFormat" }, "HiveCompatiblePartitions": { "shape": "Boolean", "documentation": "Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
", "locationName": "hiveCompatiblePartitions" }, "PerHourPartition": { "shape": "Boolean", "documentation": "Indicates whether to partition the flow log per hour.
", "locationName": "perHourPartition" } }, "documentation": "Describes the destination options for a flow log.
" }, "DetachClassicLinkVpcRequest": { "type": "structure", "required": [ "InstanceId", "VpcId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance to unlink from the VPC.
", "locationName": "instanceId" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC to which the instance is linked.
", "locationName": "vpcId" } } }, "DetachClassicLinkVpcResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the internet gateway.
", "locationName": "internetGatewayId" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
", "locationName": "vpcId" } } }, "DetachNetworkInterfaceRequest": { "type": "structure", "required": [ "AttachmentId" ], "members": { "AttachmentId": { "shape": "NetworkInterfaceAttachmentId", "documentation": "The ID of the attachment.
", "locationName": "attachmentId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Specifies whether to force a detachment.
Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
Contains the parameters for DetachNetworkInterface.
" }, "DetachVerifiedAccessTrustProviderRequest": { "type": "structure", "required": [ "VerifiedAccessInstanceId", "VerifiedAccessTrustProviderId" ], "members": { "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "VerifiedAccessTrustProviderId": { "shape": "VerifiedAccessTrustProviderId", "documentation": "The ID of the Verified Access trust provider.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access trust provider.
", "locationName": "verifiedAccessTrustProvider" }, "VerifiedAccessInstance": { "shape": "VerifiedAccessInstance", "documentation": "Details about the Verified Access instance.
", "locationName": "verifiedAccessInstance" } } }, "DetachVolumeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "Device": { "shape": "String", "documentation": "The device name.
" }, "Force": { "shape": "Boolean", "documentation": "Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.
" }, "InstanceId": { "shape": "InstanceIdForResolver", "documentation": "The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
" }, "VolumeId": { "shape": "VolumeIdWithResolver", "documentation": "The ID of the volume.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC.
" }, "VpnGatewayId": { "shape": "VpnGatewayId", "documentation": "The ID of the virtual private gateway.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DetachVpnGateway.
" }, "DeviceOptions": { "type": "structure", "members": { "TenantId": { "shape": "String", "documentation": "The ID of the tenant application with the device-identity provider.
", "locationName": "tenantId" }, "PublicSigningKeyUrl": { "shape": "String", "documentation": "The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.
", "locationName": "publicSigningKeyUrl" } }, "documentation": "Describes the options for an Amazon Web Services Verified Access device-identity based trust provider.
" }, "DeviceTrustProviderType": { "type": "string", "enum": [ "jamf", "crowdstrike", "jumpcloud" ] }, "DeviceType": { "type": "string", "enum": [ "ebs", "instance-store" ] }, "DhcpConfiguration": { "type": "structure", "members": { "Key": { "shape": "String", "documentation": "The name of a DHCP option.
", "locationName": "key" }, "Values": { "shape": "DhcpConfigurationValueList", "documentation": "The values for the DHCP option.
", "locationName": "valueSet" } }, "documentation": "Describes a DHCP configuration option.
" }, "DhcpConfigurationList": { "type": "list", "member": { "shape": "DhcpConfiguration", "locationName": "item" } }, "DhcpConfigurationValueList": { "type": "list", "member": { "shape": "AttributeValue", "locationName": "item" } }, "DhcpOptions": { "type": "structure", "members": { "DhcpConfigurations": { "shape": "DhcpConfigurationList", "documentation": "The DHCP options in the set.
", "locationName": "dhcpConfigurationSet" }, "DhcpOptionsId": { "shape": "String", "documentation": "The ID of the set of DHCP options.
", "locationName": "dhcpOptionsId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the DHCP options set.
", "locationName": "ownerId" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the DHCP options set.
", "locationName": "tagSet" } }, "documentation": "The set of DHCP options.
" }, "DhcpOptionsId": { "type": "string" }, "DhcpOptionsIdStringList": { "type": "list", "member": { "shape": "DhcpOptionsId", "locationName": "DhcpOptionsId" } }, "DhcpOptionsList": { "type": "list", "member": { "shape": "DhcpOptions", "locationName": "item" } }, "DirectoryServiceAuthentication": { "type": "structure", "members": { "DirectoryId": { "shape": "String", "documentation": "The ID of the Active Directory used for authentication.
", "locationName": "directoryId" } }, "documentation": "Describes an Active Directory.
" }, "DirectoryServiceAuthenticationRequest": { "type": "structure", "members": { "DirectoryId": { "shape": "String", "documentation": "The ID of the Active Directory to be used for authentication.
" } }, "documentation": "Describes the Active Directory to be used for client authentication.
" }, "DisableAddressTransferRequest": { "type": "structure", "required": [ "AllocationId" ], "members": { "AllocationId": { "shape": "AllocationId", "documentation": "The allocation ID of an Elastic IP address.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
An Elastic IP address transfer.
", "locationName": "addressTransfer" } } }, "DisableAwsNetworkPerformanceMetricSubscriptionRequest": { "type": "structure", "members": { "Source": { "shape": "String", "documentation": "The source Region or Availability Zone that the metric subscription is disabled for. For example, us-east-1.
The target Region or Availability Zone that the metric subscription is disabled for. For example, eu-north-1.
The metric used for the disabled subscription.
" }, "Statistic": { "shape": "StatisticType", "documentation": "The statistic used for the disabled subscription.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether the unsubscribe action was successful.
", "locationName": "output" } } }, "DisableEbsEncryptionByDefaultRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The updated status of encryption by default.
", "locationName": "ebsEncryptionByDefault" } } }, "DisableFastLaunchRequest": { "type": "structure", "required": [ "ImageId" ], "members": { "ImageId": { "shape": "ImageId", "documentation": "Specify the ID of the image for which to disable Windows fast launch.
" }, "Force": { "shape": "Boolean", "documentation": "Forces the image settings to turn off Windows fast launch for your Windows AMI. This parameter overrides any errors that are encountered while cleaning up resources in your account.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the image for which Windows fast launch was disabled.
", "locationName": "imageId" }, "ResourceType": { "shape": "FastLaunchResourceType", "documentation": "The pre-provisioning resource type that must be cleaned after turning off Windows fast launch for the Windows AMI. Supported values include: snapshot.
Parameters that were used for Windows fast launch for the Windows AMI before Windows fast launch was disabled. This informs the clean-up process.
", "locationName": "snapshotConfiguration" }, "LaunchTemplate": { "shape": "FastLaunchLaunchTemplateSpecificationResponse", "documentation": "The launch template that was used to launch Windows instances from pre-provisioned snapshots.
", "locationName": "launchTemplate" }, "MaxParallelLaunches": { "shape": "Integer", "documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch.
", "locationName": "maxParallelLaunches" }, "OwnerId": { "shape": "String", "documentation": "The owner of the Windows AMI for which Windows fast launch was disabled.
", "locationName": "ownerId" }, "State": { "shape": "FastLaunchStateCode", "documentation": "The current state of Windows fast launch for the specified Windows AMI.
", "locationName": "state" }, "StateTransitionReason": { "shape": "String", "documentation": "The reason that the state changed for Windows fast launch for the Windows AMI.
", "locationName": "stateTransitionReason" }, "StateTransitionTime": { "shape": "MillisecondDateTime", "documentation": "The time that the state changed for Windows fast launch for the Windows AMI.
", "locationName": "stateTransitionTime" } } }, "DisableFastSnapshotRestoreErrorItem": { "type": "structure", "members": { "SnapshotId": { "shape": "String", "documentation": "The ID of the snapshot.
", "locationName": "snapshotId" }, "FastSnapshotRestoreStateErrors": { "shape": "DisableFastSnapshotRestoreStateErrorSet", "documentation": "The errors.
", "locationName": "fastSnapshotRestoreStateErrorSet" } }, "documentation": "Contains information about the errors that occurred when disabling fast snapshot restores.
" }, "DisableFastSnapshotRestoreErrorSet": { "type": "list", "member": { "shape": "DisableFastSnapshotRestoreErrorItem", "locationName": "item" } }, "DisableFastSnapshotRestoreStateError": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The error message.
", "locationName": "message" } }, "documentation": "Describes an error that occurred when disabling fast snapshot restores.
" }, "DisableFastSnapshotRestoreStateErrorItem": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "Error": { "shape": "DisableFastSnapshotRestoreStateError", "documentation": "The error.
", "locationName": "error" } }, "documentation": "Contains information about an error that occurred when disabling fast snapshot restores.
" }, "DisableFastSnapshotRestoreStateErrorSet": { "type": "list", "member": { "shape": "DisableFastSnapshotRestoreStateErrorItem", "locationName": "item" } }, "DisableFastSnapshotRestoreSuccessItem": { "type": "structure", "members": { "SnapshotId": { "shape": "String", "documentation": "The ID of the snapshot.
", "locationName": "snapshotId" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "State": { "shape": "FastSnapshotRestoreStateCode", "documentation": "The state of fast snapshot restores for the snapshot.
", "locationName": "state" }, "StateTransitionReason": { "shape": "String", "documentation": "The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
", "locationName": "ownerId" }, "OwnerAlias": { "shape": "String", "documentation": "The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
", "locationName": "ownerAlias" }, "EnablingTime": { "shape": "MillisecondDateTime", "documentation": "The time at which fast snapshot restores entered the enabling state.
The time at which fast snapshot restores entered the optimizing state.
The time at which fast snapshot restores entered the enabled state.
The time at which fast snapshot restores entered the disabling state.
The time at which fast snapshot restores entered the disabled state.
Describes fast snapshot restores that were successfully disabled.
" }, "DisableFastSnapshotRestoreSuccessSet": { "type": "list", "member": { "shape": "DisableFastSnapshotRestoreSuccessItem", "locationName": "item" } }, "DisableFastSnapshotRestoresRequest": { "type": "structure", "required": [ "AvailabilityZones", "SourceSnapshotIds" ], "members": { "AvailabilityZones": { "shape": "AvailabilityZoneStringList", "documentation": "One or more Availability Zones. For example, us-east-2a.
The IDs of one or more snapshots. For example, snap-1234567890abcdef0.
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.
Information about the snapshots for which fast snapshot restores were successfully disabled.
", "locationName": "successful" }, "Unsuccessful": { "shape": "DisableFastSnapshotRestoreErrorSet", "documentation": "Information about the snapshots for which fast snapshot restores could not be disabled.
", "locationName": "unsuccessful" } } }, "DisableImageBlockPublicAccessRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Returns unblocked if the request succeeds; otherwise, it returns an error.
The ID of the AMI.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the AMI.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the AMI.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
A check for 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.
The Organizations member account ID that you want to disable as IPAM account.
" } } }, "DisableIpamOrganizationAdminAccountResult": { "type": "structure", "members": { "Success": { "shape": "Boolean", "documentation": "The result of disabling the IPAM account.
", "locationName": "success" } } }, "DisableSerialConsoleAccessRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.
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.
Returns unblocked if the request succeeds.
The ID of the propagation route table.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the route table announcement.
" } } }, "DisableTransitGatewayRouteTablePropagationResult": { "type": "structure", "members": { "Propagation": { "shape": "TransitGatewayPropagation", "documentation": "Information about route propagation.
", "locationName": "propagation" } } }, "DisableVgwRoutePropagationRequest": { "type": "structure", "required": [ "GatewayId", "RouteTableId" ], "members": { "GatewayId": { "shape": "VpnGatewayId", "documentation": "The ID of the virtual private gateway.
" }, "RouteTableId": { "shape": "RouteTableId", "documentation": "The ID of the route table.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for DisableVgwRoutePropagation.
" }, "DisableVpcClassicLinkDnsSupportRequest": { "type": "structure", "members": { "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" } } }, "DisableVpcClassicLinkDnsSupportResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the VPC.
", "locationName": "vpcId" } } }, "DisableVpcClassicLinkResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The association ID. This parameter is required.
" }, "PublicIp": { "shape": "EipAllocationPublicIp", "documentation": "Deprecated.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Client VPN endpoint from which to disassociate the target network.
" }, "AssociationId": { "shape": "String", "documentation": "The ID of the target network association.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the target network association.
", "locationName": "associationId" }, "Status": { "shape": "AssociationStatus", "documentation": "The current state of the target network association.
", "locationName": "status" } } }, "DisassociateEnclaveCertificateIamRoleRequest": { "type": "structure", "required": [ "CertificateArn", "RoleArn" ], "members": { "CertificateArn": { "shape": "CertificateId", "documentation": "The ARN of the ACM certificate from which to disassociate the IAM role.
" }, "RoleArn": { "shape": "RoleId", "documentation": "The ARN of the IAM role to disassociate.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the IAM instance profile association.
" } } }, "DisassociateIamInstanceProfileResult": { "type": "structure", "members": { "IamInstanceProfileAssociation": { "shape": "IamInstanceProfileAssociation", "documentation": "Information about the IAM instance profile association.
", "locationName": "iamInstanceProfileAssociation" } } }, "DisassociateInstanceEventWindowRequest": { "type": "structure", "required": [ "InstanceEventWindowId", "AssociationTarget" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the event window.
" }, "AssociationTarget": { "shape": "InstanceEventWindowDisassociationRequest", "documentation": "One or more targets to disassociate from the specified event window.
" } } }, "DisassociateInstanceEventWindowResult": { "type": "structure", "members": { "InstanceEventWindow": { "shape": "InstanceEventWindow", "documentation": "Information about the event window.
", "locationName": "instanceEventWindow" } } }, "DisassociateIpamByoasnRequest": { "type": "structure", "required": [ "Asn", "Cidr" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
A public 2-byte or 4-byte ASN.
" }, "Cidr": { "shape": "String", "documentation": "A BYOIP CIDR.
" } } }, "DisassociateIpamByoasnResult": { "type": "structure", "members": { "AsnAssociation": { "shape": "AsnAssociation", "documentation": "An ASN and BYOIP CIDR association.
", "locationName": "asnAssociation" } } }, "DisassociateIpamResourceDiscoveryRequest": { "type": "structure", "required": [ "IpamResourceDiscoveryAssociationId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
A resource discovery association ID.
" } } }, "DisassociateIpamResourceDiscoveryResult": { "type": "structure", "members": { "IpamResourceDiscoveryAssociation": { "shape": "IpamResourceDiscoveryAssociation", "documentation": "A resource discovery association.
", "locationName": "ipamResourceDiscoveryAssociation" } } }, "DisassociateNatGatewayAddressRequest": { "type": "structure", "required": [ "NatGatewayId", "AssociationIds" ], "members": { "NatGatewayId": { "shape": "NatGatewayId", "documentation": "The ID of the NAT gateway.
" }, "AssociationIds": { "shape": "EipAssociationIdList", "documentation": "The association IDs of EIPs that have been associated with the NAT gateway.
", "locationName": "AssociationId" }, "MaxDrainDurationSeconds": { "shape": "DrainSeconds", "documentation": "The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the NAT gateway.
", "locationName": "natGatewayId" }, "NatGatewayAddresses": { "shape": "NatGatewayAddressList", "documentation": "Information about the NAT gateway IP addresses.
", "locationName": "natGatewayAddressSet" } } }, "DisassociateRouteTableRequest": { "type": "structure", "required": [ "AssociationId" ], "members": { "AssociationId": { "shape": "RouteTableAssociationId", "documentation": "The association ID representing the current association between the route table and subnet or gateway.
", "locationName": "associationId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The association ID for the CIDR block.
", "locationName": "associationId" } } }, "DisassociateSubnetCidrBlockResult": { "type": "structure", "members": { "Ipv6CidrBlockAssociation": { "shape": "SubnetIpv6CidrBlockAssociation", "documentation": "Information about the IPv6 CIDR block association.
", "locationName": "ipv6CidrBlockAssociation" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" } } }, "DisassociateTransitGatewayMulticastDomainRequest": { "type": "structure", "required": [ "TransitGatewayMulticastDomainId", "TransitGatewayAttachmentId", "SubnetIds" ], "members": { "TransitGatewayMulticastDomainId": { "shape": "TransitGatewayMulticastDomainId", "documentation": "The ID of the transit gateway multicast domain.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "SubnetIds": { "shape": "TransitGatewaySubnetIdList", "documentation": "The IDs of the subnets;
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the association.
", "locationName": "associations" } } }, "DisassociateTransitGatewayPolicyTableRequest": { "type": "structure", "required": [ "TransitGatewayPolicyTableId", "TransitGatewayAttachmentId" ], "members": { "TransitGatewayPolicyTableId": { "shape": "TransitGatewayPolicyTableId", "documentation": "The ID of the disassociated policy table.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway attachment to disassociate from the policy table.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns details about the transit gateway policy table disassociation.
", "locationName": "association" } } }, "DisassociateTransitGatewayRouteTableRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId", "TransitGatewayAttachmentId" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the association.
", "locationName": "association" } } }, "DisassociateTrunkInterfaceRequest": { "type": "structure", "required": [ "AssociationId" ], "members": { "AssociationId": { "shape": "TrunkInterfaceAssociationId", "documentation": "The ID of the association
" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", "locationName": "clientToken" } } }, "DisassociateVpcCidrBlockRequest": { "type": "structure", "required": [ "AssociationId" ], "members": { "AssociationId": { "shape": "VpcCidrAssociationId", "documentation": "The association ID for the CIDR block.
", "locationName": "associationId" } } }, "DisassociateVpcCidrBlockResult": { "type": "structure", "members": { "Ipv6CidrBlockAssociation": { "shape": "VpcIpv6CidrBlockAssociation", "documentation": "Information about the IPv6 CIDR block association.
", "locationName": "ipv6CidrBlockAssociation" }, "CidrBlockAssociation": { "shape": "VpcCidrBlockAssociation", "documentation": "Information about the IPv4 CIDR block association.
", "locationName": "cidrBlockAssociation" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" } } }, "DiskCount": { "type": "integer" }, "DiskImage": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the disk image.
" }, "Image": { "shape": "DiskImageDetail", "documentation": "Information about the disk image.
" }, "Volume": { "shape": "VolumeDetail", "documentation": "Information about the volume.
" } }, "documentation": "Describes a disk image.
" }, "DiskImageDescription": { "type": "structure", "members": { "Checksum": { "shape": "String", "documentation": "The checksum computed for the disk image.
", "locationName": "checksum" }, "Format": { "shape": "DiskImageFormat", "documentation": "The disk image format.
", "locationName": "format" }, "ImportManifestUrl": { "shape": "ImportManifestUrl", "documentation": "A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
", "locationName": "importManifestUrl" }, "Size": { "shape": "Long", "documentation": "The size of the disk image, in GiB.
", "locationName": "size" } }, "documentation": "Describes a disk image.
" }, "DiskImageDetail": { "type": "structure", "required": [ "Bytes", "Format", "ImportManifestUrl" ], "members": { "Bytes": { "shape": "Long", "documentation": "The size of the disk image, in GiB.
", "locationName": "bytes" }, "Format": { "shape": "DiskImageFormat", "documentation": "The disk image format.
", "locationName": "format" }, "ImportManifestUrl": { "shape": "ImportManifestUrl", "documentation": "A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
", "locationName": "importManifestUrl" } }, "documentation": "Describes a disk image.
" }, "DiskImageFormat": { "type": "string", "enum": [ "VMDK", "RAW", "VHD" ] }, "DiskImageList": { "type": "list", "member": { "shape": "DiskImage" } }, "DiskImageVolumeDescription": { "type": "structure", "members": { "Id": { "shape": "String", "documentation": "The volume identifier.
", "locationName": "id" }, "Size": { "shape": "Long", "documentation": "The size of the volume, in GiB.
", "locationName": "size" } }, "documentation": "Describes a disk image volume.
" }, "DiskInfo": { "type": "structure", "members": { "SizeInGB": { "shape": "DiskSize", "documentation": "The size of the disk in GB.
", "locationName": "sizeInGB" }, "Count": { "shape": "DiskCount", "documentation": "The number of disks with this configuration.
", "locationName": "count" }, "Type": { "shape": "DiskType", "documentation": "The type of disk.
", "locationName": "type" } }, "documentation": "Describes a disk.
" }, "DiskInfoList": { "type": "list", "member": { "shape": "DiskInfo", "locationName": "item" } }, "DiskSize": { "type": "long" }, "DiskType": { "type": "string", "enum": [ "hdd", "ssd" ] }, "DnsEntry": { "type": "structure", "members": { "DnsName": { "shape": "String", "documentation": "The DNS name.
", "locationName": "dnsName" }, "HostedZoneId": { "shape": "String", "documentation": "The ID of the private hosted zone.
", "locationName": "hostedZoneId" } }, "documentation": "Describes a DNS entry.
" }, "DnsEntrySet": { "type": "list", "member": { "shape": "DnsEntry", "locationName": "item" } }, "DnsNameState": { "type": "string", "enum": [ "pendingVerification", "verified", "failed" ] }, "DnsOptions": { "type": "structure", "members": { "DnsRecordIpType": { "shape": "DnsRecordIpType", "documentation": "The DNS records created for the endpoint.
", "locationName": "dnsRecordIpType" }, "PrivateDnsOnlyForInboundResolverEndpoint": { "shape": "Boolean", "documentation": "Indicates whether to enable private DNS only for inbound endpoints.
", "locationName": "privateDnsOnlyForInboundResolverEndpoint" } }, "documentation": "Describes the DNS options for an endpoint.
" }, "DnsOptionsSpecification": { "type": "structure", "members": { "DnsRecordIpType": { "shape": "DnsRecordIpType", "documentation": "The DNS records created for the endpoint.
" }, "PrivateDnsOnlyForInboundResolverEndpoint": { "shape": "Boolean", "documentation": "Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
" } }, "documentation": "Describes the DNS options for an endpoint.
" }, "DnsRecordIpType": { "type": "string", "enum": [ "ipv4", "dualstack", "ipv6", "service-defined" ] }, "DnsServersOptionsModifyStructure": { "type": "structure", "members": { "CustomDnsServers": { "shape": "ValueStringList", "documentation": "The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.
" }, "Enabled": { "shape": "Boolean", "documentation": "Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
Information about the DNS server to be used.
" }, "DnsSupportValue": { "type": "string", "enum": [ "enable", "disable" ] }, "DomainType": { "type": "string", "enum": [ "vpc", "standard" ] }, "Double": { "type": "double" }, "DoubleWithConstraints": { "type": "double", "max": 99.999, "min": 0.001 }, "DrainSeconds": { "type": "integer", "max": 4000, "min": 1 }, "DynamicRoutingValue": { "type": "string", "enum": [ "enable", "disable" ] }, "EbsBlockDevice": { "type": "structure", "members": { "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
", "locationName": "deleteOnTermination" }, "Iops": { "shape": "Integer", "documentation": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on 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.
The ID of the snapshot.
", "locationName": "snapshotId" }, "VolumeSize": { "shape": "Integer", "documentation": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported sizes for each volume type:
gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
", "locationName": "volumeType" }, "KmsKeyId": { "shape": "String", "documentation": "Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
", "locationName": "throughput" }, "OutpostArn": { "shape": "String", "documentation": "The ARN of the Outpost on which the snapshot is stored.
This parameter is not supported when using CreateImage.
", "locationName": "outpostArn" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Describes a block device for an EBS volume.
" }, "EbsEncryptionSupport": { "type": "string", "enum": [ "unsupported", "supported" ] }, "EbsInfo": { "type": "structure", "members": { "EbsOptimizedSupport": { "shape": "EbsOptimizedSupport", "documentation": "Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide.
", "locationName": "ebsOptimizedSupport" }, "EncryptionSupport": { "shape": "EbsEncryptionSupport", "documentation": "Indicates whether Amazon EBS encryption is supported.
", "locationName": "encryptionSupport" }, "EbsOptimizedInfo": { "shape": "EbsOptimizedInfo", "documentation": "Describes the optimized EBS performance for the instance type.
", "locationName": "ebsOptimizedInfo" }, "NvmeSupport": { "shape": "EbsNvmeSupport", "documentation": "Indicates whether non-volatile memory express (NVMe) is supported.
", "locationName": "nvmeSupport" } }, "documentation": "Describes the Amazon EBS features supported by the instance type.
" }, "EbsInstanceBlockDevice": { "type": "structure", "members": { "AttachTime": { "shape": "DateTime", "documentation": "The time stamp when the attachment initiated.
", "locationName": "attachTime" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the volume is deleted on instance termination.
", "locationName": "deleteOnTermination" }, "Status": { "shape": "AttachmentStatus", "documentation": "The attachment state.
", "locationName": "status" }, "VolumeId": { "shape": "String", "documentation": "The ID of the EBS volume.
", "locationName": "volumeId" }, "AssociatedResource": { "shape": "String", "documentation": "The ARN of the Amazon ECS or Fargate task to which the volume is attached.
", "locationName": "associatedResource" }, "VolumeOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the volume.
This parameter is returned only for volumes that are attached to Fargate tasks.
", "locationName": "volumeOwnerId" } }, "documentation": "Describes a parameter used to set up an EBS volume in a block device mapping.
" }, "EbsInstanceBlockDeviceSpecification": { "type": "structure", "members": { "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the volume is deleted on instance termination.
", "locationName": "deleteOnTermination" }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the EBS volume.
", "locationName": "volumeId" } }, "documentation": "Describes information used to set up an EBS volume specified in a block device mapping.
" }, "EbsNvmeSupport": { "type": "string", "enum": [ "unsupported", "supported", "required" ] }, "EbsOptimizedInfo": { "type": "structure", "members": { "BaselineBandwidthInMbps": { "shape": "BaselineBandwidthInMbps", "documentation": "The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
", "locationName": "baselineBandwidthInMbps" }, "BaselineThroughputInMBps": { "shape": "BaselineThroughputInMBps", "documentation": "The baseline throughput performance for an EBS-optimized instance type, in MB/s.
", "locationName": "baselineThroughputInMBps" }, "BaselineIops": { "shape": "BaselineIops", "documentation": "The baseline input/output storage operations per seconds for an EBS-optimized instance type.
", "locationName": "baselineIops" }, "MaximumBandwidthInMbps": { "shape": "MaximumBandwidthInMbps", "documentation": "The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
", "locationName": "maximumBandwidthInMbps" }, "MaximumThroughputInMBps": { "shape": "MaximumThroughputInMBps", "documentation": "The maximum throughput performance for an EBS-optimized instance type, in MB/s.
", "locationName": "maximumThroughputInMBps" }, "MaximumIops": { "shape": "MaximumIops", "documentation": "The maximum input/output storage operations per second for an EBS-optimized instance type.
", "locationName": "maximumIops" } }, "documentation": "Describes the optimized EBS performance for supported instance types.
" }, "EbsOptimizedSupport": { "type": "string", "enum": [ "unsupported", "supported", "default" ] }, "Ec2InstanceConnectEndpoint": { "type": "structure", "members": { "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.
", "locationName": "ownerId" }, "InstanceConnectEndpointId": { "shape": "InstanceConnectEndpointId", "documentation": "The ID of the EC2 Instance Connect Endpoint.
", "locationName": "instanceConnectEndpointId" }, "InstanceConnectEndpointArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.
", "locationName": "instanceConnectEndpointArn" }, "State": { "shape": "Ec2InstanceConnectEndpointState", "documentation": "The current state of the EC2 Instance Connect Endpoint.
", "locationName": "state" }, "StateMessage": { "shape": "String", "documentation": "The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.
", "locationName": "stateMessage" }, "DnsName": { "shape": "String", "documentation": "The DNS name of the EC2 Instance Connect Endpoint.
", "locationName": "dnsName" }, "FipsDnsName": { "shape": "String", "documentation": "", "locationName": "fipsDnsName" }, "NetworkInterfaceIds": { "shape": "NetworkInterfaceIdSet", "documentation": "The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.
", "locationName": "networkInterfaceIdSet" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
", "locationName": "vpcId" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone of the EC2 Instance Connect Endpoint.
", "locationName": "availabilityZone" }, "CreatedAt": { "shape": "MillisecondDateTime", "documentation": "The date and time that the EC2 Instance Connect Endpoint was created.
", "locationName": "createdAt" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
", "locationName": "subnetId" }, "PreserveClientIp": { "shape": "Boolean", "documentation": "Indicates whether your client's IP address is preserved as the source. The value is true or false.
If true, your client's IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true
The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.
", "locationName": "securityGroupIdSet" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the EC2 Instance Connect Endpoint.
", "locationName": "tagSet" } }, "documentation": "The EC2 Instance Connect Endpoint.
" }, "Ec2InstanceConnectEndpointState": { "type": "string", "enum": [ "create-in-progress", "create-complete", "create-failed", "delete-in-progress", "delete-complete", "delete-failed" ] }, "EfaInfo": { "type": "structure", "members": { "MaximumEfaInterfaces": { "shape": "MaximumEfaInterfaces", "documentation": "The maximum number of Elastic Fabric Adapters for the instance type.
", "locationName": "maximumEfaInterfaces" } }, "documentation": "Describes the Elastic Fabric Adapters for the instance type.
" }, "EfaSupportedFlag": { "type": "boolean" }, "EgressOnlyInternetGateway": { "type": "structure", "members": { "Attachments": { "shape": "InternetGatewayAttachmentList", "documentation": "Information about the attachment of the egress-only internet gateway.
", "locationName": "attachmentSet" }, "EgressOnlyInternetGatewayId": { "shape": "EgressOnlyInternetGatewayId", "documentation": "The ID of the egress-only internet gateway.
", "locationName": "egressOnlyInternetGatewayId" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the egress-only internet gateway.
", "locationName": "tagSet" } }, "documentation": "Describes an egress-only internet gateway.
" }, "EgressOnlyInternetGatewayId": { "type": "string" }, "EgressOnlyInternetGatewayIdList": { "type": "list", "member": { "shape": "EgressOnlyInternetGatewayId", "locationName": "item" } }, "EgressOnlyInternetGatewayList": { "type": "list", "member": { "shape": "EgressOnlyInternetGateway", "locationName": "item" } }, "EipAllocationPublicIp": { "type": "string" }, "EipAssociationIdList": { "type": "list", "member": { "shape": "ElasticIpAssociationId", "locationName": "item" } }, "ElasticGpuAssociation": { "type": "structure", "members": { "ElasticGpuId": { "shape": "ElasticGpuId", "documentation": "The ID of the Elastic Graphics accelerator.
", "locationName": "elasticGpuId" }, "ElasticGpuAssociationId": { "shape": "String", "documentation": "The ID of the association.
", "locationName": "elasticGpuAssociationId" }, "ElasticGpuAssociationState": { "shape": "String", "documentation": "The state of the association between the instance and the Elastic Graphics accelerator.
", "locationName": "elasticGpuAssociationState" }, "ElasticGpuAssociationTime": { "shape": "String", "documentation": "The time the Elastic Graphics accelerator was associated with the instance.
", "locationName": "elasticGpuAssociationTime" } }, "documentation": "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.
Describes the association between an instance and an Elastic Graphics accelerator.
" }, "ElasticGpuAssociationList": { "type": "list", "member": { "shape": "ElasticGpuAssociation", "locationName": "item" } }, "ElasticGpuHealth": { "type": "structure", "members": { "Status": { "shape": "ElasticGpuStatus", "documentation": "The health status.
", "locationName": "status" } }, "documentation": "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.
Describes the status of an Elastic Graphics accelerator.
" }, "ElasticGpuId": { "type": "string" }, "ElasticGpuIdSet": { "type": "list", "member": { "shape": "ElasticGpuId", "locationName": "item" } }, "ElasticGpuSet": { "type": "list", "member": { "shape": "ElasticGpus", "locationName": "item" } }, "ElasticGpuSpecification": { "type": "structure", "required": [ "Type" ], "members": { "Type": { "shape": "String", "documentation": "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.
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.
A specification for an Elastic Graphics accelerator.
" }, "ElasticGpuSpecificationList": { "type": "list", "member": { "shape": "ElasticGpuSpecification", "locationName": "ElasticGpuSpecification" } }, "ElasticGpuSpecificationResponse": { "type": "structure", "members": { "Type": { "shape": "String", "documentation": "Deprecated.
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.
Deprecated.
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.
The ID of the Elastic Graphics accelerator.
", "locationName": "elasticGpuId" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in the which the Elastic Graphics accelerator resides.
", "locationName": "availabilityZone" }, "ElasticGpuType": { "shape": "String", "documentation": "The type of Elastic Graphics accelerator.
", "locationName": "elasticGpuType" }, "ElasticGpuHealth": { "shape": "ElasticGpuHealth", "documentation": "The status of the Elastic Graphics accelerator.
", "locationName": "elasticGpuHealth" }, "ElasticGpuState": { "shape": "ElasticGpuState", "documentation": "The state of the Elastic Graphics accelerator.
", "locationName": "elasticGpuState" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance to which the Elastic Graphics accelerator is attached.
", "locationName": "instanceId" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the Elastic Graphics accelerator.
", "locationName": "tagSet" } }, "documentation": "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.
Describes an Elastic Graphics accelerator.
" }, "ElasticInferenceAccelerator": { "type": "structure", "required": [ "Type" ], "members": { "Type": { "shape": "String", "documentation": " The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, eia1.xlarge, eia2.medium, eia2.large, and eia2.xlarge.
The number of elastic inference accelerators to attach to the instance.
Default: 1
" } }, "documentation": "Describes an elastic inference accelerator.
" }, "ElasticInferenceAcceleratorAssociation": { "type": "structure", "members": { "ElasticInferenceAcceleratorArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the elastic inference accelerator.
", "locationName": "elasticInferenceAcceleratorArn" }, "ElasticInferenceAcceleratorAssociationId": { "shape": "String", "documentation": "The ID of the association.
", "locationName": "elasticInferenceAcceleratorAssociationId" }, "ElasticInferenceAcceleratorAssociationState": { "shape": "String", "documentation": "The state of the elastic inference accelerator.
", "locationName": "elasticInferenceAcceleratorAssociationState" }, "ElasticInferenceAcceleratorAssociationTime": { "shape": "DateTime", "documentation": "The time at which the elastic inference accelerator is associated with an instance.
", "locationName": "elasticInferenceAcceleratorAssociationTime" } }, "documentation": "Describes the association between an instance and an elastic inference accelerator.
" }, "ElasticInferenceAcceleratorAssociationList": { "type": "list", "member": { "shape": "ElasticInferenceAcceleratorAssociation", "locationName": "item" } }, "ElasticInferenceAcceleratorCount": { "type": "integer", "min": 1 }, "ElasticInferenceAccelerators": { "type": "list", "member": { "shape": "ElasticInferenceAccelerator", "locationName": "item" } }, "ElasticIpAssociationId": { "type": "string" }, "EnaSrdSpecification": { "type": "structure", "members": { "EnaSrdEnabled": { "shape": "Boolean", "documentation": "Indicates whether ENA Express is enabled for the network interface.
" }, "EnaSrdUdpSpecification": { "shape": "EnaSrdUdpSpecification", "documentation": "Configures ENA Express for UDP network traffic.
" } }, "documentation": "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. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.
To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.
" }, "EnaSrdSpecificationRequest": { "type": "structure", "members": { "EnaSrdEnabled": { "shape": "Boolean", "documentation": "Specifies whether ENA Express is enabled for the network interface when you launch an instance from your launch template.
" }, "EnaSrdUdpSpecification": { "shape": "EnaSrdUdpSpecificationRequest", "documentation": "Contains ENA Express settings for UDP network traffic in your launch template.
" } }, "documentation": "Launch instances with ENA Express settings configured from your launch template.
" }, "EnaSrdSupported": { "type": "boolean" }, "EnaSrdUdpSpecification": { "type": "structure", "members": { "EnaSrdUdpEnabled": { "shape": "Boolean", "documentation": "Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
" } }, "documentation": "ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.
" }, "EnaSrdUdpSpecificationRequest": { "type": "structure", "members": { "EnaSrdUdpEnabled": { "shape": "Boolean", "documentation": "Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set EnaSrdEnabled in the EnaSrdSpecificationRequest to true in your launch template.
Configures ENA Express for UDP network traffic from your launch template.
" }, "EnaSupport": { "type": "string", "enum": [ "unsupported", "supported", "required" ] }, "EnableAddressTransferRequest": { "type": "structure", "required": [ "AllocationId", "TransferAccountId" ], "members": { "AllocationId": { "shape": "AllocationId", "documentation": "The allocation ID of an Elastic IP address.
" }, "TransferAccountId": { "shape": "String", "documentation": "The ID of the account that you want to transfer the Elastic IP address to.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
An Elastic IP address transfer.
", "locationName": "addressTransfer" } } }, "EnableAwsNetworkPerformanceMetricSubscriptionRequest": { "type": "structure", "members": { "Source": { "shape": "String", "documentation": "The source Region (like us-east-1) or Availability Zone ID (like use1-az1) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region.
The target Region (like us-east-2) or Availability Zone ID (like use2-az2) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region.
The metric used for the enabled subscription.
" }, "Statistic": { "shape": "StatisticType", "documentation": "The statistic used for the enabled subscription.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether the subscribe action was successful.
", "locationName": "output" } } }, "EnableEbsEncryptionByDefaultRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The updated status of encryption by default.
", "locationName": "ebsEncryptionByDefault" } } }, "EnableFastLaunchRequest": { "type": "structure", "required": [ "ImageId" ], "members": { "ImageId": { "shape": "ImageId", "documentation": "Specify the ID of the image for which to enable Windows fast launch.
" }, "ResourceType": { "shape": "String", "documentation": "The type of resource to use for pre-provisioning the AMI for Windows fast launch. Supported values include: snapshot, which is the default value.
Configuration settings for creating and managing the snapshots that are used for pre-provisioning the AMI for Windows fast launch. The associated ResourceType must be snapshot.
The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both.
" }, "MaxParallelLaunches": { "shape": "Integer", "documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch. Value must be 6 or greater.
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.
The image ID that identifies the AMI for which Windows fast launch was enabled.
", "locationName": "imageId" }, "ResourceType": { "shape": "FastLaunchResourceType", "documentation": "The type of resource that was defined for pre-provisioning the AMI for Windows fast launch.
", "locationName": "resourceType" }, "SnapshotConfiguration": { "shape": "FastLaunchSnapshotConfigurationResponse", "documentation": "Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster launches from the Windows AMI. This property is returned when the associated resourceType is snapshot.
The launch template that is used when launching Windows instances from pre-provisioned snapshots.
", "locationName": "launchTemplate" }, "MaxParallelLaunches": { "shape": "Integer", "documentation": "The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch.
", "locationName": "maxParallelLaunches" }, "OwnerId": { "shape": "String", "documentation": "The owner ID for the AMI for which Windows fast launch was enabled.
", "locationName": "ownerId" }, "State": { "shape": "FastLaunchStateCode", "documentation": "The current state of Windows fast launch for the specified AMI.
", "locationName": "state" }, "StateTransitionReason": { "shape": "String", "documentation": "The reason that the state changed for Windows fast launch for the AMI.
", "locationName": "stateTransitionReason" }, "StateTransitionTime": { "shape": "MillisecondDateTime", "documentation": "The time that the state changed for Windows fast launch for the AMI.
", "locationName": "stateTransitionTime" } } }, "EnableFastSnapshotRestoreErrorItem": { "type": "structure", "members": { "SnapshotId": { "shape": "String", "documentation": "The ID of the snapshot.
", "locationName": "snapshotId" }, "FastSnapshotRestoreStateErrors": { "shape": "EnableFastSnapshotRestoreStateErrorSet", "documentation": "The errors.
", "locationName": "fastSnapshotRestoreStateErrorSet" } }, "documentation": "Contains information about the errors that occurred when enabling fast snapshot restores.
" }, "EnableFastSnapshotRestoreErrorSet": { "type": "list", "member": { "shape": "EnableFastSnapshotRestoreErrorItem", "locationName": "item" } }, "EnableFastSnapshotRestoreStateError": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The error message.
", "locationName": "message" } }, "documentation": "Describes an error that occurred when enabling fast snapshot restores.
" }, "EnableFastSnapshotRestoreStateErrorItem": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "Error": { "shape": "EnableFastSnapshotRestoreStateError", "documentation": "The error.
", "locationName": "error" } }, "documentation": "Contains information about an error that occurred when enabling fast snapshot restores.
" }, "EnableFastSnapshotRestoreStateErrorSet": { "type": "list", "member": { "shape": "EnableFastSnapshotRestoreStateErrorItem", "locationName": "item" } }, "EnableFastSnapshotRestoreSuccessItem": { "type": "structure", "members": { "SnapshotId": { "shape": "String", "documentation": "The ID of the snapshot.
", "locationName": "snapshotId" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "State": { "shape": "FastSnapshotRestoreStateCode", "documentation": "The state of fast snapshot restores.
", "locationName": "state" }, "StateTransitionReason": { "shape": "String", "documentation": "The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
", "locationName": "ownerId" }, "OwnerAlias": { "shape": "String", "documentation": "The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
", "locationName": "ownerAlias" }, "EnablingTime": { "shape": "MillisecondDateTime", "documentation": "The time at which fast snapshot restores entered the enabling state.
The time at which fast snapshot restores entered the optimizing state.
The time at which fast snapshot restores entered the enabled state.
The time at which fast snapshot restores entered the disabling state.
The time at which fast snapshot restores entered the disabled state.
Describes fast snapshot restores that were successfully enabled.
" }, "EnableFastSnapshotRestoreSuccessSet": { "type": "list", "member": { "shape": "EnableFastSnapshotRestoreSuccessItem", "locationName": "item" } }, "EnableFastSnapshotRestoresRequest": { "type": "structure", "required": [ "AvailabilityZones", "SourceSnapshotIds" ], "members": { "AvailabilityZones": { "shape": "AvailabilityZoneStringList", "documentation": "One or more Availability Zones. For example, us-east-2a.
The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify a snapshot that was shared with you from another Amazon Web Services account.
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.
Information about the snapshots for which fast snapshot restores were successfully enabled.
", "locationName": "successful" }, "Unsuccessful": { "shape": "EnableFastSnapshotRestoreErrorSet", "documentation": "Information about the snapshots for which fast snapshot restores could not be enabled.
", "locationName": "unsuccessful" } } }, "EnableImageBlockPublicAccessRequest": { "type": "structure", "required": [ "ImageBlockPublicAccessState" ], "members": { "ImageBlockPublicAccessState": { "shape": "ImageBlockPublicAccessEnabledState", "documentation": "Specify block-new-sharing to enable block public access for AMIs at the account level in the specified Region. This will block any attempt to publicly share your AMIs in the specified Region.
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.
Returns block-new-sharing if the request succeeds; otherwise, it returns an error.
The ID of the AMI.
" }, "DeprecateAt": { "shape": "MillisecondDateTime", "documentation": "The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
You can’t specify a date in the past. The upper limit for DeprecateAt is 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date.
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.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the AMI.
" }, "WithCooldown": { "shape": "Boolean", "documentation": "If true, enforces deregistration protection for 24 hours after deregistration protection is disabled.
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.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the AMI.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
A check for 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.
The Organizations member account ID that you want to enable as the IPAM account.
" } } }, "EnableIpamOrganizationAdminAccountResult": { "type": "structure", "members": { "Success": { "shape": "Boolean", "documentation": "The result of enabling the IPAM account.
", "locationName": "success" } } }, "EnableReachabilityAnalyzerOrganizationSharingRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, returns an error.
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.
If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.
The mode in which to enable block public access for snapshots for the Region. Specify one of the following values:
block-all-sharing - Prevents all public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. Additionally, snapshots that are already publicly shared are treated as private and they are no longer publicly available.
If you enable block public access for snapshots in block-all-sharing mode, it does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.
block-new-sharing - Prevents only new public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. However, snapshots that are already publicly shared, remain publicly available.
unblocked is not a valid value for EnableSnapshotBlockPublicAccess.
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.
The state of block public access for snapshots for the account and Region. Returns either block-all-sharing or block-new-sharing if the request succeeds.
The ID of the propagation route table.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the transit gateway route table announcement.
" } } }, "EnableTransitGatewayRouteTablePropagationResult": { "type": "structure", "members": { "Propagation": { "shape": "TransitGatewayPropagation", "documentation": "Information about route propagation.
", "locationName": "propagation" } } }, "EnableVgwRoutePropagationRequest": { "type": "structure", "required": [ "GatewayId", "RouteTableId" ], "members": { "GatewayId": { "shape": "VpnGatewayId", "documentation": "The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.
" }, "RouteTableId": { "shape": "RouteTableId", "documentation": "The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for EnableVgwRoutePropagation.
" }, "EnableVolumeIORequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the volume.
", "locationName": "volumeId" } } }, "EnableVpcClassicLinkDnsSupportRequest": { "type": "structure", "members": { "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" } } }, "EnableVpcClassicLinkDnsSupportResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the VPC.
", "locationName": "vpcId" } } }, "EnableVpcClassicLinkResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
" }, "EnclaveOptionsRequest": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
" }, "EncryptionInTransitSupported": { "type": "boolean" }, "EndDateType": { "type": "string", "enum": [ "unlimited", "limited" ] }, "EndpointSet": { "type": "list", "member": { "shape": "ClientVpnEndpoint", "locationName": "item" } }, "EphemeralNvmeSupport": { "type": "string", "enum": [ "unsupported", "supported", "required" ] }, "ErrorSet": { "type": "list", "member": { "shape": "ValidationError", "locationName": "item" } }, "EventCode": { "type": "string", "enum": [ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "EventInformation": { "type": "structure", "members": { "EventDescription": { "shape": "String", "documentation": "The description of the event.
", "locationName": "eventDescription" }, "EventSubType": { "shape": "String", "documentation": "The event.
error events:
iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.
allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.
spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch.
spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.
fleetRequestChange events:
active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.
deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.
deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.
deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.
expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.
modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.
modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.
progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
instanceChange events:
launched - A new instance was launched.
terminated - An instance was terminated by the user.
termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.
Information events:
fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.
launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.
launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.
registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.
The ID of the instance. This information is available only for instanceChange events.
Describes an EC2 Fleet or Spot Fleet event.
" }, "EventType": { "type": "string", "enum": [ "instanceChange", "fleetRequestChange", "error", "information" ] }, "ExcessCapacityTerminationPolicy": { "type": "string", "enum": [ "noTermination", "default" ] }, "ExcludedInstanceType": { "type": "string", "max": 30, "min": 1, "pattern": "[a-zA-Z0-9\\.\\*\\-]+" }, "ExcludedInstanceTypeSet": { "type": "list", "member": { "shape": "ExcludedInstanceType", "locationName": "item" }, "max": 400, "min": 0 }, "ExecutableByStringList": { "type": "list", "member": { "shape": "String", "locationName": "ExecutableBy" } }, "Explanation": { "type": "structure", "members": { "Acl": { "shape": "AnalysisComponent", "documentation": "The network ACL.
", "locationName": "acl" }, "AclRule": { "shape": "AnalysisAclRule", "documentation": "The network ACL rule.
", "locationName": "aclRule" }, "Address": { "shape": "IpAddress", "documentation": "The IPv4 address, in CIDR notation.
", "locationName": "address" }, "Addresses": { "shape": "IpAddressList", "documentation": "The IPv4 addresses, in CIDR notation.
", "locationName": "addressSet" }, "AttachedTo": { "shape": "AnalysisComponent", "documentation": "The resource to which the component is attached.
", "locationName": "attachedTo" }, "AvailabilityZones": { "shape": "ValueStringList", "documentation": "The Availability Zones.
", "locationName": "availabilityZoneSet" }, "Cidrs": { "shape": "ValueStringList", "documentation": "The CIDR ranges.
", "locationName": "cidrSet" }, "Component": { "shape": "AnalysisComponent", "documentation": "The component.
", "locationName": "component" }, "CustomerGateway": { "shape": "AnalysisComponent", "documentation": "The customer gateway.
", "locationName": "customerGateway" }, "Destination": { "shape": "AnalysisComponent", "documentation": "The destination.
", "locationName": "destination" }, "DestinationVpc": { "shape": "AnalysisComponent", "documentation": "The destination VPC.
", "locationName": "destinationVpc" }, "Direction": { "shape": "String", "documentation": "The direction. The following are the possible values:
egress
ingress
The explanation code.
", "locationName": "explanationCode" }, "IngressRouteTable": { "shape": "AnalysisComponent", "documentation": "The route table.
", "locationName": "ingressRouteTable" }, "InternetGateway": { "shape": "AnalysisComponent", "documentation": "The internet gateway.
", "locationName": "internetGateway" }, "LoadBalancerArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the load balancer.
", "locationName": "loadBalancerArn" }, "ClassicLoadBalancerListener": { "shape": "AnalysisLoadBalancerListener", "documentation": "The listener for a Classic Load Balancer.
", "locationName": "classicLoadBalancerListener" }, "LoadBalancerListenerPort": { "shape": "Port", "documentation": "The listener port of the load balancer.
", "locationName": "loadBalancerListenerPort" }, "LoadBalancerTarget": { "shape": "AnalysisLoadBalancerTarget", "documentation": "The target.
", "locationName": "loadBalancerTarget" }, "LoadBalancerTargetGroup": { "shape": "AnalysisComponent", "documentation": "The target group.
", "locationName": "loadBalancerTargetGroup" }, "LoadBalancerTargetGroups": { "shape": "AnalysisComponentList", "documentation": "The target groups.
", "locationName": "loadBalancerTargetGroupSet" }, "LoadBalancerTargetPort": { "shape": "Port", "documentation": "The target port.
", "locationName": "loadBalancerTargetPort" }, "ElasticLoadBalancerListener": { "shape": "AnalysisComponent", "documentation": "The load balancer listener.
", "locationName": "elasticLoadBalancerListener" }, "MissingComponent": { "shape": "String", "documentation": "The missing component.
", "locationName": "missingComponent" }, "NatGateway": { "shape": "AnalysisComponent", "documentation": "The NAT gateway.
", "locationName": "natGateway" }, "NetworkInterface": { "shape": "AnalysisComponent", "documentation": "The network interface.
", "locationName": "networkInterface" }, "PacketField": { "shape": "String", "documentation": "The packet field.
", "locationName": "packetField" }, "VpcPeeringConnection": { "shape": "AnalysisComponent", "documentation": "The VPC peering connection.
", "locationName": "vpcPeeringConnection" }, "Port": { "shape": "Port", "documentation": "The port.
", "locationName": "port" }, "PortRanges": { "shape": "PortRangeList", "documentation": "The port ranges.
", "locationName": "portRangeSet" }, "PrefixList": { "shape": "AnalysisComponent", "documentation": "The prefix list.
", "locationName": "prefixList" }, "Protocols": { "shape": "StringList", "documentation": "The protocols.
", "locationName": "protocolSet" }, "RouteTableRoute": { "shape": "AnalysisRouteTableRoute", "documentation": "The route table route.
", "locationName": "routeTableRoute" }, "RouteTable": { "shape": "AnalysisComponent", "documentation": "The route table.
", "locationName": "routeTable" }, "SecurityGroup": { "shape": "AnalysisComponent", "documentation": "The security group.
", "locationName": "securityGroup" }, "SecurityGroupRule": { "shape": "AnalysisSecurityGroupRule", "documentation": "The security group rule.
", "locationName": "securityGroupRule" }, "SecurityGroups": { "shape": "AnalysisComponentList", "documentation": "The security groups.
", "locationName": "securityGroupSet" }, "SourceVpc": { "shape": "AnalysisComponent", "documentation": "The source VPC.
", "locationName": "sourceVpc" }, "State": { "shape": "String", "documentation": "The state.
", "locationName": "state" }, "Subnet": { "shape": "AnalysisComponent", "documentation": "The subnet.
", "locationName": "subnet" }, "SubnetRouteTable": { "shape": "AnalysisComponent", "documentation": "The route table for the subnet.
", "locationName": "subnetRouteTable" }, "Vpc": { "shape": "AnalysisComponent", "documentation": "The component VPC.
", "locationName": "vpc" }, "VpcEndpoint": { "shape": "AnalysisComponent", "documentation": "The VPC endpoint.
", "locationName": "vpcEndpoint" }, "VpnConnection": { "shape": "AnalysisComponent", "documentation": "The VPN connection.
", "locationName": "vpnConnection" }, "VpnGateway": { "shape": "AnalysisComponent", "documentation": "The VPN gateway.
", "locationName": "vpnGateway" }, "TransitGateway": { "shape": "AnalysisComponent", "documentation": "The transit gateway.
", "locationName": "transitGateway" }, "TransitGatewayRouteTable": { "shape": "AnalysisComponent", "documentation": "The transit gateway route table.
", "locationName": "transitGatewayRouteTable" }, "TransitGatewayRouteTableRoute": { "shape": "TransitGatewayRouteTableRoute", "documentation": "The transit gateway route table route.
", "locationName": "transitGatewayRouteTableRoute" }, "TransitGatewayAttachment": { "shape": "AnalysisComponent", "documentation": "The transit gateway attachment.
", "locationName": "transitGatewayAttachment" }, "ComponentAccount": { "shape": "ComponentAccount", "documentation": "The Amazon Web Services account for the component.
", "locationName": "componentAccount" }, "ComponentRegion": { "shape": "ComponentRegion", "documentation": "The Region for the component.
", "locationName": "componentRegion" }, "FirewallStatelessRule": { "shape": "FirewallStatelessRule", "documentation": "The Network Firewall stateless rule.
", "locationName": "firewallStatelessRule" }, "FirewallStatefulRule": { "shape": "FirewallStatefulRule", "documentation": "The Network Firewall stateful rule.
", "locationName": "firewallStatefulRule" } }, "documentation": "Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.
" }, "ExplanationList": { "type": "list", "member": { "shape": "Explanation", "locationName": "item" } }, "ExportClientVpnClientCertificateRevocationListRequest": { "type": "structure", "required": [ "ClientVpnEndpointId" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the client certificate revocation list.
", "locationName": "certificateRevocationList" }, "Status": { "shape": "ClientCertificateRevocationListStatus", "documentation": "The current state of the client certificate revocation list.
", "locationName": "status" } } }, "ExportClientVpnClientConfigurationRequest": { "type": "structure", "required": [ "ClientVpnEndpointId" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The contents of the Client VPN endpoint configuration file.
", "locationName": "clientConfiguration" } } }, "ExportEnvironment": { "type": "string", "enum": [ "citrix", "vmware", "microsoft" ] }, "ExportImageRequest": { "type": "structure", "required": [ "DiskImageFormat", "ImageId", "S3ExportLocation" ], "members": { "ClientToken": { "shape": "String", "documentation": "Token to enable idempotency for export image requests.
", "idempotencyToken": true }, "Description": { "shape": "String", "documentation": "A description of the image being exported. The maximum length is 255 characters.
" }, "DiskImageFormat": { "shape": "DiskImageFormat", "documentation": "The disk image format.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the image.
" }, "S3ExportLocation": { "shape": "ExportTaskS3LocationRequest", "documentation": "The Amazon S3 bucket for the destination image. The destination bucket must exist.
" }, "RoleName": { "shape": "String", "documentation": "The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the export image task during creation.
", "locationName": "TagSpecification" } } }, "ExportImageResult": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the image being exported.
", "locationName": "description" }, "DiskImageFormat": { "shape": "DiskImageFormat", "documentation": "The disk image format for the exported image.
", "locationName": "diskImageFormat" }, "ExportImageTaskId": { "shape": "String", "documentation": "The ID of the export image task.
", "locationName": "exportImageTaskId" }, "ImageId": { "shape": "String", "documentation": "The ID of the image.
", "locationName": "imageId" }, "RoleName": { "shape": "String", "documentation": "The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
", "locationName": "roleName" }, "Progress": { "shape": "String", "documentation": "The percent complete of the export image task.
", "locationName": "progress" }, "S3ExportLocation": { "shape": "ExportTaskS3Location", "documentation": "Information about the destination Amazon S3 bucket.
", "locationName": "s3ExportLocation" }, "Status": { "shape": "String", "documentation": "The status of the export image task. The possible values are active, completed, deleting, and deleted.
The status message for the export image task.
", "locationName": "statusMessage" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the export image task.
", "locationName": "tagSet" } } }, "ExportImageTask": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the image being exported.
", "locationName": "description" }, "ExportImageTaskId": { "shape": "String", "documentation": "The ID of the export image task.
", "locationName": "exportImageTaskId" }, "ImageId": { "shape": "String", "documentation": "The ID of the image.
", "locationName": "imageId" }, "Progress": { "shape": "String", "documentation": "The percent complete of the export image task.
", "locationName": "progress" }, "S3ExportLocation": { "shape": "ExportTaskS3Location", "documentation": "Information about the destination Amazon S3 bucket.
", "locationName": "s3ExportLocation" }, "Status": { "shape": "String", "documentation": "The status of the export image task. The possible values are active, completed, deleting, and deleted.
The status message for the export image task.
", "locationName": "statusMessage" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the export image task.
", "locationName": "tagSet" } }, "documentation": "Describes an export image task.
" }, "ExportImageTaskId": { "type": "string" }, "ExportImageTaskIdList": { "type": "list", "member": { "shape": "ExportImageTaskId", "locationName": "ExportImageTaskId" } }, "ExportImageTaskList": { "type": "list", "member": { "shape": "ExportImageTask", "locationName": "item" } }, "ExportTask": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the resource being exported.
", "locationName": "description" }, "ExportTaskId": { "shape": "String", "documentation": "The ID of the export task.
", "locationName": "exportTaskId" }, "ExportToS3Task": { "shape": "ExportToS3Task", "documentation": "Information about the export task.
", "locationName": "exportToS3" }, "InstanceExportDetails": { "shape": "InstanceExportDetails", "documentation": "Information about the instance to export.
", "locationName": "instanceExport" }, "State": { "shape": "ExportTaskState", "documentation": "The state of the export task.
", "locationName": "state" }, "StatusMessage": { "shape": "String", "documentation": "The status message related to the export task.
", "locationName": "statusMessage" }, "Tags": { "shape": "TagList", "documentation": "The tags for the export task.
", "locationName": "tagSet" } }, "documentation": "Describes an export instance task.
" }, "ExportTaskId": { "type": "string" }, "ExportTaskIdStringList": { "type": "list", "member": { "shape": "ExportTaskId", "locationName": "ExportTaskId" } }, "ExportTaskList": { "type": "list", "member": { "shape": "ExportTask", "locationName": "item" } }, "ExportTaskS3Location": { "type": "structure", "members": { "S3Bucket": { "shape": "String", "documentation": "The destination Amazon S3 bucket.
", "locationName": "s3Bucket" }, "S3Prefix": { "shape": "String", "documentation": "The prefix (logical hierarchy) in the bucket.
", "locationName": "s3Prefix" } }, "documentation": "Describes the destination for an export image task.
" }, "ExportTaskS3LocationRequest": { "type": "structure", "required": [ "S3Bucket" ], "members": { "S3Bucket": { "shape": "String", "documentation": "The destination Amazon S3 bucket.
" }, "S3Prefix": { "shape": "String", "documentation": "The prefix (logical hierarchy) in the bucket.
" } }, "documentation": "Describes the destination for an export image task.
" }, "ExportTaskState": { "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task": { "type": "structure", "members": { "ContainerFormat": { "shape": "ContainerFormat", "documentation": "The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
", "locationName": "containerFormat" }, "DiskImageFormat": { "shape": "DiskImageFormat", "documentation": "The format for the exported image.
", "locationName": "diskImageFormat" }, "S3Bucket": { "shape": "String", "documentation": "The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
The encryption key for your S3 bucket.
", "locationName": "s3Key" } }, "documentation": "Describes the format and location for the export task.
" }, "ExportToS3TaskSpecification": { "type": "structure", "members": { "ContainerFormat": { "shape": "ContainerFormat", "documentation": "The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
", "locationName": "containerFormat" }, "DiskImageFormat": { "shape": "DiskImageFormat", "documentation": "The format for the exported image.
", "locationName": "diskImageFormat" }, "S3Bucket": { "shape": "String", "documentation": "The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
", "locationName": "s3Prefix" } }, "documentation": "Describes an export instance task.
" }, "ExportTransitGatewayRoutesRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId", "S3Bucket" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the route table.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
transit-gateway-route-destination-cidr-block - The CIDR range.
type - The type of route (propagated | static).
The name of the S3 bucket.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
", "locationName": "s3Location" } } }, "ExportVmTaskId": { "type": "string" }, "FailedCapacityReservationFleetCancellationResult": { "type": "structure", "members": { "CapacityReservationFleetId": { "shape": "CapacityReservationFleetId", "documentation": "The ID of the Capacity Reservation Fleet that could not be cancelled.
", "locationName": "capacityReservationFleetId" }, "CancelCapacityReservationFleetError": { "shape": "CancelCapacityReservationFleetError", "documentation": "Information about the Capacity Reservation Fleet cancellation error.
", "locationName": "cancelCapacityReservationFleetError" } }, "documentation": "Describes a Capacity Reservation Fleet that could not be cancelled.
" }, "FailedCapacityReservationFleetCancellationResultSet": { "type": "list", "member": { "shape": "FailedCapacityReservationFleetCancellationResult", "locationName": "item" } }, "FailedQueuedPurchaseDeletion": { "type": "structure", "members": { "Error": { "shape": "DeleteQueuedReservedInstancesError", "documentation": "The error.
", "locationName": "error" }, "ReservedInstancesId": { "shape": "String", "documentation": "The ID of the Reserved Instance.
", "locationName": "reservedInstancesId" } }, "documentation": "Describes a Reserved Instance whose queued purchase was not deleted.
" }, "FailedQueuedPurchaseDeletionSet": { "type": "list", "member": { "shape": "FailedQueuedPurchaseDeletion", "locationName": "item" } }, "FastLaunchImageIdList": { "type": "list", "member": { "shape": "ImageId", "locationName": "ImageId" } }, "FastLaunchLaunchTemplateSpecificationRequest": { "type": "structure", "required": [ "Version" ], "members": { "LaunchTemplateId": { "shape": "LaunchTemplateId", "documentation": "Specify the ID of the launch template that the AMI should use for Windows fast launch.
" }, "LaunchTemplateName": { "shape": "String", "documentation": "Specify the name of the launch template that the AMI should use for Windows fast launch.
" }, "Version": { "shape": "String", "documentation": "Specify the version of the launch template that the AMI should use for Windows fast launch.
" } }, "documentation": "Request to create a launch template for a Windows fast launch enabled AMI.
Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
The ID of the launch template that the AMI uses for Windows fast launch.
", "locationName": "launchTemplateId" }, "LaunchTemplateName": { "shape": "String", "documentation": "The name of the launch template that the AMI uses for Windows fast launch.
", "locationName": "launchTemplateName" }, "Version": { "shape": "String", "documentation": "The version of the launch template that the AMI uses for Windows fast launch.
", "locationName": "version" } }, "documentation": "Identifies the launch template that the AMI uses for Windows fast launch.
" }, "FastLaunchResourceType": { "type": "string", "enum": [ "snapshot" ] }, "FastLaunchSnapshotConfigurationRequest": { "type": "structure", "members": { "TargetResourceCount": { "shape": "Integer", "documentation": "The number of pre-provisioned snapshots to keep on hand for a Windows fast launch enabled AMI.
" } }, "documentation": "Configuration settings for creating and managing pre-provisioned snapshots for a Windows fast launch enabled AMI.
" }, "FastLaunchSnapshotConfigurationResponse": { "type": "structure", "members": { "TargetResourceCount": { "shape": "Integer", "documentation": "The number of pre-provisioned snapshots requested to keep on hand for a Windows fast launch enabled AMI.
", "locationName": "targetResourceCount" } }, "documentation": "Configuration settings for creating and managing pre-provisioned snapshots for a Windows fast launch enabled Windows AMI.
" }, "FastLaunchStateCode": { "type": "string", "enum": [ "enabling", "enabling-failed", "enabled", "enabled-failed", "disabling", "disabling-failed" ] }, "FastSnapshotRestoreStateCode": { "type": "string", "enum": [ "enabling", "optimizing", "enabled", "disabling", "disabled" ] }, "FederatedAuthentication": { "type": "structure", "members": { "SamlProviderArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the IAM SAML identity provider.
", "locationName": "samlProviderArn" }, "SelfServiceSamlProviderArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
", "locationName": "selfServiceSamlProviderArn" } }, "documentation": "Describes the IAM SAML identity providers used for federated authentication.
" }, "FederatedAuthenticationRequest": { "type": "structure", "members": { "SAMLProviderArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the IAM SAML identity provider.
" }, "SelfServiceSAMLProviderArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
" } }, "documentation": "The IAM SAML identity provider used for federated authentication.
" }, "Filter": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of the filter. Filter names are case-sensitive.
" }, "Values": { "shape": "ValueStringList", "documentation": "The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
The first port in the range.
", "locationName": "fromPort" }, "ToPort": { "shape": "Port", "documentation": "The last port in the range.
", "locationName": "toPort" } }, "documentation": "Describes a port range.
" }, "FindingsFound": { "type": "string", "enum": [ "true", "false", "unknown" ] }, "FirewallStatefulRule": { "type": "structure", "members": { "RuleGroupArn": { "shape": "ResourceArn", "documentation": "The ARN of the stateful rule group.
", "locationName": "ruleGroupArn" }, "Sources": { "shape": "ValueStringList", "documentation": "The source IP addresses, in CIDR notation.
", "locationName": "sourceSet" }, "Destinations": { "shape": "ValueStringList", "documentation": "The destination IP addresses, in CIDR notation.
", "locationName": "destinationSet" }, "SourcePorts": { "shape": "PortRangeList", "documentation": "The source ports.
", "locationName": "sourcePortSet" }, "DestinationPorts": { "shape": "PortRangeList", "documentation": "The destination ports.
", "locationName": "destinationPortSet" }, "Protocol": { "shape": "String", "documentation": "The protocol.
", "locationName": "protocol" }, "RuleAction": { "shape": "String", "documentation": "The rule action. The possible values are pass, drop, and alert.
The direction. The possible values are FORWARD and ANY.
Describes a stateful rule.
" }, "FirewallStatelessRule": { "type": "structure", "members": { "RuleGroupArn": { "shape": "ResourceArn", "documentation": "The ARN of the stateless rule group.
", "locationName": "ruleGroupArn" }, "Sources": { "shape": "ValueStringList", "documentation": "The source IP addresses, in CIDR notation.
", "locationName": "sourceSet" }, "Destinations": { "shape": "ValueStringList", "documentation": "The destination IP addresses, in CIDR notation.
", "locationName": "destinationSet" }, "SourcePorts": { "shape": "PortRangeList", "documentation": "The source ports.
", "locationName": "sourcePortSet" }, "DestinationPorts": { "shape": "PortRangeList", "documentation": "The destination ports.
", "locationName": "destinationPortSet" }, "Protocols": { "shape": "ProtocolIntList", "documentation": "The protocols.
", "locationName": "protocolSet" }, "RuleAction": { "shape": "String", "documentation": "The rule action. The possible values are pass, drop, and forward_to_site.
The rule priority.
", "locationName": "priority" } }, "documentation": "Describes a stateless rule.
" }, "FleetActivityStatus": { "type": "string", "enum": [ "error", "pending_fulfillment", "pending_termination", "fulfilled" ] }, "FleetCapacityReservation": { "type": "structure", "members": { "CapacityReservationId": { "shape": "CapacityReservationId", "documentation": "The ID of the Capacity Reservation.
", "locationName": "capacityReservationId" }, "AvailabilityZoneId": { "shape": "String", "documentation": "The ID of the Availability Zone in which the Capacity Reservation reserves capacity.
", "locationName": "availabilityZoneId" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type for which the Capacity Reservation reserves capacity.
", "locationName": "instanceType" }, "InstancePlatform": { "shape": "CapacityReservationInstancePlatform", "documentation": "The type of operating system for which the Capacity Reservation reserves capacity.
", "locationName": "instancePlatform" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which the Capacity Reservation reserves capacity.
", "locationName": "availabilityZone" }, "TotalInstanceCount": { "shape": "Integer", "documentation": "The total number of instances for which the Capacity Reservation reserves capacity.
", "locationName": "totalInstanceCount" }, "FulfilledCapacity": { "shape": "Double", "documentation": "The number of capacity units fulfilled by the Capacity Reservation. For more information, see Total target capacity in the Amazon EC2 User Guide.
", "locationName": "fulfilledCapacity" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types.
", "locationName": "ebsOptimized" }, "CreateDate": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the Capacity Reservation was created.
", "locationName": "createDate" }, "Weight": { "shape": "DoubleWithConstraints", "documentation": "The weight of the instance type in the Capacity Reservation Fleet. For more information, see Instance type weight in the Amazon EC2 User Guide.
", "locationName": "weight" }, "Priority": { "shape": "IntegerWithConstraints", "documentation": "The priority of the instance type in the Capacity Reservation Fleet. For more information, see Instance type priority in the Amazon EC2 User Guide.
", "locationName": "priority" } }, "documentation": "Information about a Capacity Reservation in a Capacity Reservation Fleet.
" }, "FleetCapacityReservationSet": { "type": "list", "member": { "shape": "FleetCapacityReservation", "locationName": "item" } }, "FleetCapacityReservationTenancy": { "type": "string", "enum": [ "default" ] }, "FleetCapacityReservationUsageStrategy": { "type": "string", "enum": [ "use-capacity-reservations-first" ] }, "FleetData": { "type": "structure", "members": { "ActivityStatus": { "shape": "FleetActivityStatus", "documentation": "The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.
The creation date and time of the EC2 Fleet.
", "locationName": "createTime" }, "FleetId": { "shape": "FleetId", "documentation": "The ID of the EC2 Fleet.
", "locationName": "fleetId" }, "FleetState": { "shape": "FleetStateCode", "documentation": "The state of the EC2 Fleet.
", "locationName": "fleetState" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraints: Maximum 64 ASCII characters
", "locationName": "clientToken" }, "ExcessCapacityTerminationPolicy": { "shape": "FleetExcessCapacityTerminationPolicy", "documentation": "Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Supported only for fleets of type maintain.
The number of units fulfilled by this request compared to the set target capacity.
", "locationName": "fulfilledCapacity" }, "FulfilledOnDemandCapacity": { "shape": "Double", "documentation": "The number of units fulfilled by this request compared to the set target On-Demand capacity.
", "locationName": "fulfilledOnDemandCapacity" }, "LaunchTemplateConfigs": { "shape": "FleetLaunchTemplateConfigList", "documentation": "The launch template and overrides.
", "locationName": "launchTemplateConfigs" }, "TargetCapacitySpecification": { "shape": "TargetCapacitySpecification", "documentation": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
Indicates whether running instances should be terminated when the EC2 Fleet expires.
", "locationName": "terminateInstancesWithExpiration" }, "Type": { "shape": "FleetType", "documentation": "The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
", "locationName": "validFrom" }, "ValidUntil": { "shape": "DateTime", "documentation": "The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
", "locationName": "validUntil" }, "ReplaceUnhealthyInstances": { "shape": "Boolean", "documentation": "Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.
The configuration of Spot Instances in an EC2 Fleet.
", "locationName": "spotOptions" }, "OnDemandOptions": { "shape": "OnDemandOptions", "documentation": "The allocation strategy of On-Demand Instances in an EC2 Fleet.
", "locationName": "onDemandOptions" }, "Tags": { "shape": "TagList", "documentation": "The tags for an EC2 Fleet resource.
", "locationName": "tagSet" }, "Errors": { "shape": "DescribeFleetsErrorSet", "documentation": "Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.
Information about the instances that were launched by the fleet. Valid only when Type is set to instant.
Reserved.
", "locationName": "context" } }, "documentation": "Describes an EC2 Fleet.
" }, "FleetEventType": { "type": "string", "enum": [ "instance-change", "fleet-change", "service-error" ] }, "FleetExcessCapacityTerminationPolicy": { "type": "string", "enum": [ "no-termination", "termination" ] }, "FleetId": { "type": "string" }, "FleetIdSet": { "type": "list", "member": { "shape": "FleetId" } }, "FleetInstanceMatchCriteria": { "type": "string", "enum": [ "open" ] }, "FleetLaunchTemplateConfig": { "type": "structure", "members": { "LaunchTemplateSpecification": { "shape": "FleetLaunchTemplateSpecification", "documentation": "The launch template.
", "locationName": "launchTemplateSpecification" }, "Overrides": { "shape": "FleetLaunchTemplateOverridesList", "documentation": "Any parameters that you specify override the same parameters in the launch template.
", "locationName": "overrides" } }, "documentation": "Describes a launch template and overrides.
" }, "FleetLaunchTemplateConfigList": { "type": "list", "member": { "shape": "FleetLaunchTemplateConfig", "locationName": "item" } }, "FleetLaunchTemplateConfigListRequest": { "type": "list", "member": { "shape": "FleetLaunchTemplateConfigRequest", "locationName": "item" }, "max": 50, "min": 0 }, "FleetLaunchTemplateConfigRequest": { "type": "structure", "members": { "LaunchTemplateSpecification": { "shape": "FleetLaunchTemplateSpecificationRequest", "documentation": "The launch template to use. You must specify either the launch template ID or launch template name in the request.
" }, "Overrides": { "shape": "FleetLaunchTemplateOverridesListRequest", "documentation": "Any parameters that you specify override the same parameters in the launch template.
For fleets of type request and maintain, a maximum of 300 items is allowed across all launch templates.
Describes a launch template and overrides.
" }, "FleetLaunchTemplateOverrides": { "type": "structure", "members": { "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
mac1.metal is not supported as a launch template override.
If you specify InstanceType, you can't specify InstanceRequirements.
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The ID of the subnet in which to launch the instances.
", "locationName": "subnetId" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which to launch the instances.
", "locationName": "availabilityZone" }, "WeightedCapacity": { "shape": "Double", "documentation": "The number of units provided by the specified instance type.
When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
The location where the instance launched, if applicable.
", "locationName": "placement" }, "InstanceRequirements": { "shape": "InstanceRequirements", "documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can't specify InstanceType.
The ID of the AMI. An AMI is required to launch an instance. This parameter is only available for fleets of type instant. For fleets of type maintain and request, you must specify the AMI ID in the launch template.
Describes overrides for a launch template.
" }, "FleetLaunchTemplateOverridesList": { "type": "list", "member": { "shape": "FleetLaunchTemplateOverrides", "locationName": "item" } }, "FleetLaunchTemplateOverridesListRequest": { "type": "list", "member": { "shape": "FleetLaunchTemplateOverridesRequest", "locationName": "item" } }, "FleetLaunchTemplateOverridesRequest": { "type": "structure", "members": { "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
mac1.metal is not supported as a launch template override.
If you specify InstanceType, you can't specify InstanceRequirements.
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.
The Availability Zone in which to launch the instances.
" }, "WeightedCapacity": { "shape": "Double", "documentation": "The number of units provided by the specified instance type.
When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The location where the instance launched, if applicable.
" }, "InstanceRequirements": { "shape": "InstanceRequirementsRequest", "documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can't specify InstanceType.
The ID of the AMI. An AMI is required to launch an instance. This parameter is only available for fleets of type instant. For fleets of type maintain and request, you must specify the AMI ID in the launch template.
Describes overrides for a launch template.
" }, "FleetLaunchTemplateSpecification": { "type": "structure", "members": { "LaunchTemplateId": { "shape": "String", "documentation": "The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
The Amazon EC2 launch template that can be used by a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.
For information about launch templates, see Launch an instance from a launch template in the Amazon EC2 User Guide.
" }, "FleetLaunchTemplateSpecificationRequest": { "type": "structure", "members": { "LaunchTemplateId": { "shape": "LaunchTemplateId", "documentation": "The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
The Amazon EC2 launch template that can be used by an EC2 Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.
For information about launch templates, see Launch an instance from a launch template in the Amazon EC2 User Guide.
" }, "FleetOnDemandAllocationStrategy": { "type": "string", "enum": [ "lowest-price", "prioritized" ] }, "FleetReplacementStrategy": { "type": "string", "enum": [ "launch", "launch-before-terminate" ] }, "FleetSet": { "type": "list", "member": { "shape": "FleetData", "locationName": "item" } }, "FleetSpotCapacityRebalance": { "type": "structure", "members": { "ReplacementStrategy": { "shape": "FleetReplacementStrategy", "documentation": "The replacement strategy to use. Only available for fleets of type maintain.
launch - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
" }, "FleetSpotCapacityRebalanceRequest": { "type": "structure", "members": { "ReplacementStrategy": { "shape": "FleetReplacementStrategy", "documentation": "The replacement strategy to use. Only available for fleets of type maintain.
launch - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance notification 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.
" }, "FleetSpotMaintenanceStrategies": { "type": "structure", "members": { "CapacityRebalance": { "shape": "FleetSpotCapacityRebalance", "documentation": "The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
", "locationName": "capacityRebalance" } }, "documentation": "The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
" }, "FleetSpotMaintenanceStrategiesRequest": { "type": "structure", "members": { "CapacityRebalance": { "shape": "FleetSpotCapacityRebalanceRequest", "documentation": "The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
" } }, "documentation": "The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
" }, "FleetStateCode": { "type": "string", "enum": [ "submitted", "active", "deleted", "failed", "deleted_running", "deleted_terminating", "modifying" ] }, "FleetType": { "type": "string", "enum": [ "request", "maintain", "instant" ] }, "Float": { "type": "float" }, "FlowLog": { "type": "structure", "members": { "CreationTime": { "shape": "MillisecondDateTime", "documentation": "The date and time the flow log was created.
", "locationName": "creationTime" }, "DeliverLogsErrorMessage": { "shape": "String", "documentation": "Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.
The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
", "locationName": "deliverLogsPermissionArn" }, "DeliverCrossAccountRole": { "shape": "String", "documentation": "The ARN of the IAM role that allows the service to publish flow logs across accounts.
", "locationName": "deliverCrossAccountRole" }, "DeliverLogsStatus": { "shape": "String", "documentation": "The status of the logs delivery (SUCCESS | FAILED).
The ID of the flow log.
", "locationName": "flowLogId" }, "FlowLogStatus": { "shape": "String", "documentation": "The status of the flow log (ACTIVE).
The name of the flow log group.
", "locationName": "logGroupName" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource being monitored.
", "locationName": "resourceId" }, "TrafficType": { "shape": "TrafficType", "documentation": "The type of traffic captured for the flow log.
", "locationName": "trafficType" }, "LogDestinationType": { "shape": "LogDestinationType", "documentation": "The type of destination for the flow log data.
", "locationName": "logDestinationType" }, "LogDestination": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the destination for the flow log data.
", "locationName": "logDestination" }, "LogFormat": { "shape": "String", "documentation": "The format of the flow log record.
", "locationName": "logFormat" }, "Tags": { "shape": "TagList", "documentation": "The tags for the flow log.
", "locationName": "tagSet" }, "MaxAggregationInterval": { "shape": "Integer", "documentation": "The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
Valid Values: 60 | 600
The destination options.
", "locationName": "destinationOptions" } }, "documentation": "Describes a flow log.
" }, "FlowLogIdList": { "type": "list", "member": { "shape": "VpcFlowLogId", "locationName": "item" } }, "FlowLogResourceId": { "type": "string" }, "FlowLogResourceIds": { "type": "list", "member": { "shape": "FlowLogResourceId", "locationName": "item" } }, "FlowLogSet": { "type": "list", "member": { "shape": "FlowLog", "locationName": "item" } }, "FlowLogsResourceType": { "type": "string", "enum": [ "VPC", "Subnet", "NetworkInterface", "TransitGateway", "TransitGatewayAttachment" ] }, "FpgaDeviceCount": { "type": "integer" }, "FpgaDeviceInfo": { "type": "structure", "members": { "Name": { "shape": "FpgaDeviceName", "documentation": "The name of the FPGA accelerator.
", "locationName": "name" }, "Manufacturer": { "shape": "FpgaDeviceManufacturerName", "documentation": "The manufacturer of the FPGA accelerator.
", "locationName": "manufacturer" }, "Count": { "shape": "FpgaDeviceCount", "documentation": "The count of FPGA accelerators for the instance type.
", "locationName": "count" }, "MemoryInfo": { "shape": "FpgaDeviceMemoryInfo", "documentation": "Describes the memory for the FPGA accelerator for the instance type.
", "locationName": "memoryInfo" } }, "documentation": "Describes the FPGA accelerator for the instance type.
" }, "FpgaDeviceInfoList": { "type": "list", "member": { "shape": "FpgaDeviceInfo", "locationName": "item" } }, "FpgaDeviceManufacturerName": { "type": "string" }, "FpgaDeviceMemoryInfo": { "type": "structure", "members": { "SizeInMiB": { "shape": "FpgaDeviceMemorySize", "documentation": "The size of the memory available to the FPGA accelerator, in MiB.
", "locationName": "sizeInMiB" } }, "documentation": "Describes the memory for the FPGA accelerator for the instance type.
" }, "FpgaDeviceMemorySize": { "type": "integer" }, "FpgaDeviceName": { "type": "string" }, "FpgaImage": { "type": "structure", "members": { "FpgaImageId": { "shape": "String", "documentation": "The FPGA image identifier (AFI ID).
", "locationName": "fpgaImageId" }, "FpgaImageGlobalId": { "shape": "String", "documentation": "The global FPGA image identifier (AGFI ID).
", "locationName": "fpgaImageGlobalId" }, "Name": { "shape": "String", "documentation": "The name of the AFI.
", "locationName": "name" }, "Description": { "shape": "String", "documentation": "The description of the AFI.
", "locationName": "description" }, "ShellVersion": { "shape": "String", "documentation": "The version of the Amazon Web Services Shell that was used to create the bitstream.
", "locationName": "shellVersion" }, "PciId": { "shape": "PciId", "documentation": "Information about the PCI bus.
", "locationName": "pciId" }, "State": { "shape": "FpgaImageState", "documentation": "Information about the state of the AFI.
", "locationName": "state" }, "CreateTime": { "shape": "DateTime", "documentation": "The date and time the AFI was created.
", "locationName": "createTime" }, "UpdateTime": { "shape": "DateTime", "documentation": "The time of the most recent update to the AFI.
", "locationName": "updateTime" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the AFI.
", "locationName": "ownerId" }, "OwnerAlias": { "shape": "String", "documentation": "The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.
The product codes for the AFI.
", "locationName": "productCodes" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the AFI.
", "locationName": "tags" }, "Public": { "shape": "Boolean", "documentation": "Indicates whether the AFI is public.
", "locationName": "public" }, "DataRetentionSupport": { "shape": "Boolean", "documentation": "Indicates whether data retention support is enabled for the AFI.
", "locationName": "dataRetentionSupport" }, "InstanceTypes": { "shape": "InstanceTypesList", "documentation": "The instance types supported by the AFI.
", "locationName": "instanceTypes" } }, "documentation": "Describes an Amazon FPGA image (AFI).
" }, "FpgaImageAttribute": { "type": "structure", "members": { "FpgaImageId": { "shape": "String", "documentation": "The ID of the AFI.
", "locationName": "fpgaImageId" }, "Name": { "shape": "String", "documentation": "The name of the AFI.
", "locationName": "name" }, "Description": { "shape": "String", "documentation": "The description of the AFI.
", "locationName": "description" }, "LoadPermissions": { "shape": "LoadPermissionList", "documentation": "The load permissions.
", "locationName": "loadPermissions" }, "ProductCodes": { "shape": "ProductCodeList", "documentation": "The product codes.
", "locationName": "productCodes" } }, "documentation": "Describes an Amazon FPGA image (AFI) attribute.
" }, "FpgaImageAttributeName": { "type": "string", "enum": [ "description", "name", "loadPermission", "productCodes" ] }, "FpgaImageId": { "type": "string" }, "FpgaImageIdList": { "type": "list", "member": { "shape": "FpgaImageId", "locationName": "item" } }, "FpgaImageList": { "type": "list", "member": { "shape": "FpgaImage", "locationName": "item" } }, "FpgaImageState": { "type": "structure", "members": { "Code": { "shape": "FpgaImageStateCode", "documentation": "The state. The following are the possible values:
pending - AFI bitstream generation is in progress.
available - The AFI is available for use.
failed - AFI bitstream generation failed.
unavailable - The AFI is no longer available for use.
If the state is failed, this is the error message.
Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).
" }, "FpgaImageStateCode": { "type": "string", "enum": [ "pending", "failed", "available", "unavailable" ] }, "FpgaInfo": { "type": "structure", "members": { "Fpgas": { "shape": "FpgaDeviceInfoList", "documentation": "Describes the FPGAs for the instance type.
", "locationName": "fpgas" }, "TotalFpgaMemoryInMiB": { "shape": "totalFpgaMemory", "documentation": "The total memory of all FPGA accelerators for the instance type.
", "locationName": "totalFpgaMemoryInMiB" } }, "documentation": "Describes the FPGAs for the instance type.
" }, "FreeTierEligibleFlag": { "type": "boolean" }, "GVCDMaxResults": { "type": "integer", "max": 1000, "min": 200 }, "GatewayAssociationState": { "type": "string", "enum": [ "associated", "not-associated", "associating", "disassociating" ] }, "GatewayType": { "type": "string", "enum": [ "ipsec.1" ] }, "GetAssociatedEnclaveCertificateIamRolesRequest": { "type": "structure", "required": [ "CertificateArn" ], "members": { "CertificateArn": { "shape": "CertificateId", "documentation": "The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the associated IAM roles.
", "locationName": "associatedRoleSet" } } }, "GetAssociatedIpv6PoolCidrsRequest": { "type": "structure", "required": [ "PoolId" ], "members": { "PoolId": { "shape": "Ipv6PoolEc2Id", "documentation": "The ID of the IPv6 address pool.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "MaxResults": { "shape": "Ipv6PoolMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
Information about the IPv6 CIDR block associations.
", "locationName": "ipv6CidrAssociationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A list of network performance data queries.
", "locationName": "DataQuery" }, "StartTime": { "shape": "MillisecondDateTime", "documentation": "The starting time for the performance data request. The starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.
The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The list of data responses.
", "locationName": "dataResponseSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Capacity Reservation.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" }, "MaxResults": { "shape": "GetCapacityReservationUsageRequestMaxResults", "documentation": "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.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Capacity Reservation.
", "locationName": "capacityReservationId" }, "InstanceType": { "shape": "String", "documentation": "The type of instance for which the Capacity Reservation reserves capacity.
", "locationName": "instanceType" }, "TotalInstanceCount": { "shape": "Integer", "documentation": "The number of instances for which the Capacity Reservation reserves capacity.
", "locationName": "totalInstanceCount" }, "AvailableInstanceCount": { "shape": "Integer", "documentation": "The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
", "locationName": "availableInstanceCount" }, "State": { "shape": "CapacityReservationState", "documentation": "The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
Information about the Capacity Reservation usage.
", "locationName": "instanceUsageSet" } } }, "GetCoipPoolUsageRequest": { "type": "structure", "required": [ "PoolId" ], "members": { "PoolId": { "shape": "Ipv4PoolCoipId", "documentation": "The ID of the address pool.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
coip-address-usage.allocation-id - The allocation ID of the address.
coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
coip-address-usage.co-ip - The customer-owned IP address.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the customer-owned address pool.
", "locationName": "coipPoolId" }, "CoipAddressUsages": { "shape": "CoipAddressUsageSet", "documentation": "Information about the address usage.
", "locationName": "coipAddressUsageSet" }, "LocalGatewayRouteTableId": { "shape": "String", "documentation": "The ID of the local gateway route table.
", "locationName": "localGatewayRouteTableId" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the instance.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
The ID of the instance.
", "locationName": "instanceId" }, "Output": { "shape": "String", "documentation": "The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.
", "locationName": "output" }, "Timestamp": { "shape": "DateTime", "documentation": "The time at which the output was last updated.
", "locationName": "timestamp" } } }, "GetConsoleScreenshotRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance.
" }, "WakeUp": { "shape": "Boolean", "documentation": "When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.
The data that comprises the image.
", "locationName": "imageData" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" } } }, "GetDefaultCreditSpecificationRequest": { "type": "structure", "required": [ "InstanceFamily" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The instance family.
" } } }, "GetDefaultCreditSpecificationResult": { "type": "structure", "members": { "InstanceFamilyCreditSpecification": { "shape": "InstanceFamilyCreditSpecification", "documentation": "The default credit option for CPU usage of the instance family.
", "locationName": "instanceFamilyCreditSpecification" } } }, "GetEbsDefaultKmsKeyIdRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
", "locationName": "kmsKeyId" } } }, "GetEbsEncryptionByDefaultRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether encryption by default is enabled.
", "locationName": "ebsEncryptionByDefault" }, "SseType": { "shape": "SSEType", "documentation": "Reserved for future use.
", "locationName": "sseType" } } }, "GetFlowLogsIntegrationTemplateRequest": { "type": "structure", "required": [ "FlowLogId", "ConfigDeliveryS3DestinationArn", "IntegrateServices" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the flow log.
" }, "ConfigDeliveryS3DestinationArn": { "shape": "String", "documentation": "To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.
" }, "IntegrateServices": { "shape": "IntegrateServices", "documentation": "Information about the service integration.
", "locationName": "IntegrateService" } } }, "GetFlowLogsIntegrationTemplateResult": { "type": "structure", "members": { "Result": { "shape": "String", "documentation": "The generated CloudFormation template.
", "locationName": "result" } } }, "GetGroupsForCapacityReservationRequest": { "type": "structure", "required": [ "CapacityReservationId" ], "members": { "CapacityReservationId": { "shape": "CapacityReservationId", "documentation": "The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own.
" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results.
" }, "MaxResults": { "shape": "GetGroupsForCapacityReservationRequestMaxResults", "documentation": "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.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the resource groups to which the Capacity Reservation has been added.
", "locationName": "capacityReservationGroupSet" } } }, "GetHostReservationPurchasePreviewRequest": { "type": "structure", "required": [ "HostIdSet", "OfferingId" ], "members": { "HostIdSet": { "shape": "RequestHostIdSet", "documentation": "The IDs of the Dedicated Hosts with which the reservation is associated.
" }, "OfferingId": { "shape": "OfferingId", "documentation": "The offering ID of the reservation.
" } } }, "GetHostReservationPurchasePreviewResult": { "type": "structure", "members": { "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
", "locationName": "purchase" }, "TotalHourlyPrice": { "shape": "String", "documentation": "The potential total hourly price of the reservation per hour.
", "locationName": "totalHourlyPrice" }, "TotalUpfrontPrice": { "shape": "String", "documentation": "The potential total upfront price. This is billed immediately.
", "locationName": "totalUpfrontPrice" } } }, "GetImageBlockPublicAccessStateRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The current state of block public access for AMIs at the account level in the specified Amazon Web Services Region.
Possible values:
block-new-sharing - Any attempt to publicly share your AMIs in the specified Region is blocked.
unblocked - Your AMIs in the specified Region can be publicly shared.
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.
The account-level default IMDS settings.
", "locationName": "accountLevel" } } }, "GetInstanceTypesFromInstanceRequirementsRequest": { "type": "structure", "required": [ "ArchitectureTypes", "VirtualizationTypes", "InstanceRequirements" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The processor architecture type.
", "locationName": "ArchitectureType" }, "VirtualizationTypes": { "shape": "VirtualizationTypeSet", "documentation": "The virtualization type.
", "locationName": "VirtualizationType" }, "InstanceRequirements": { "shape": "InstanceRequirementsRequest", "documentation": "The attributes required for the instance types.
" }, "MaxResults": { "shape": "Integer", "documentation": "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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "GetInstanceTypesFromInstanceRequirementsResult": { "type": "structure", "members": { "InstanceTypes": { "shape": "InstanceTypeInfoFromInstanceRequirementsSet", "documentation": "The instance types with the specified instance attributes.
", "locationName": "instanceTypeSet" }, "NextToken": { "shape": "String", "documentation": "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.
The ID of the instance from which to retrieve the UEFI data.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance from which to retrieve the UEFI data.
", "locationName": "instanceId" }, "UefiData": { "shape": "String", "documentation": "Base64 representation of the non-volatile UEFI variable store.
", "locationName": "uefiData" } } }, "GetIpamAddressHistoryRequest": { "type": "structure", "required": [ "Cidr", "IpamScopeId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.
" }, "IpamScopeId": { "shape": "IpamScopeId", "documentation": "The ID of the IPAM scope that the CIDR is in.
" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC you want your history records filtered by.
" }, "StartTime": { "shape": "MillisecondDateTime", "documentation": "The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.
" }, "EndTime": { "shape": "MillisecondDateTime", "documentation": "The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.
" }, "MaxResults": { "shape": "IpamAddressHistoryMaxResults", "documentation": "The maximum number of historical results you would like returned per page. Defaults to 100.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" } } }, "GetIpamAddressHistoryResult": { "type": "structure", "members": { "HistoryRecords": { "shape": "IpamAddressHistoryRecordSet", "documentation": "A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.
", "locationName": "historyRecordSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A check for 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.
A resource discovery ID.
" }, "DiscoveryRegion": { "shape": "String", "documentation": "The Amazon Web Services Region that the account information is returned from.
" }, "Filters": { "shape": "FilterList", "documentation": "Discovered account filters.
", "locationName": "Filter" }, "NextToken": { "shape": "NextToken", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of discovered accounts to return in one page of results.
" } } }, "GetIpamDiscoveredAccountsResult": { "type": "structure", "members": { "IpamDiscoveredAccounts": { "shape": "IpamDiscoveredAccountSet", "documentation": "Discovered accounts.
", "locationName": "ipamDiscoveredAccountSet" }, "NextToken": { "shape": "NextToken", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", "locationName": "nextToken" } } }, "GetIpamDiscoveredPublicAddressesRequest": { "type": "structure", "required": [ "IpamResourceDiscoveryId", "AddressRegion" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
An IPAM resource discovery ID.
" }, "AddressRegion": { "shape": "String", "documentation": "The Amazon Web Services Region for the IP address.
" }, "Filters": { "shape": "FilterList", "documentation": "Filters.
", "locationName": "Filter" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of IPAM discovered public addresses to return in one page of results.
" } } }, "GetIpamDiscoveredPublicAddressesResult": { "type": "structure", "members": { "IpamDiscoveredPublicAddresses": { "shape": "IpamDiscoveredPublicAddressSet", "documentation": "IPAM discovered public addresses.
", "locationName": "ipamDiscoveredPublicAddressSet" }, "OldestSampleTime": { "shape": "MillisecondDateTime", "documentation": "The oldest successful resource discovery time.
", "locationName": "oldestSampleTime" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A check for 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.
A resource discovery ID.
" }, "ResourceRegion": { "shape": "String", "documentation": "A resource Region.
" }, "Filters": { "shape": "FilterList", "documentation": "Filters.
", "locationName": "Filter" }, "NextToken": { "shape": "NextToken", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of discovered resource CIDRs to return in one page of results.
" } } }, "GetIpamDiscoveredResourceCidrsResult": { "type": "structure", "members": { "IpamDiscoveredResourceCidrs": { "shape": "IpamDiscoveredResourceCidrSet", "documentation": "Discovered resource CIDRs.
", "locationName": "ipamDiscoveredResourceCidrSet" }, "NextToken": { "shape": "NextToken", "documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", "locationName": "nextToken" } } }, "GetIpamPoolAllocationsMaxResults": { "type": "integer", "max": 100000, "min": 1000 }, "GetIpamPoolAllocationsRequest": { "type": "structure", "required": [ "IpamPoolId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the IPAM pool you want to see the allocations for.
" }, "IpamPoolAllocationId": { "shape": "IpamPoolAllocationId", "documentation": "The ID of the allocation.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "locationName": "Filter" }, "MaxResults": { "shape": "GetIpamPoolAllocationsMaxResults", "documentation": "The maximum number of results you would like returned per page.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" } } }, "GetIpamPoolAllocationsResult": { "type": "structure", "members": { "IpamPoolAllocations": { "shape": "IpamPoolAllocationSet", "documentation": "The IPAM pool allocations you want information on.
", "locationName": "ipamPoolAllocationSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A check for 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.
The ID of the IPAM pool you want the CIDR for.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "locationName": "Filter" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of results to return in the request.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" } } }, "GetIpamPoolCidrsResult": { "type": "structure", "members": { "IpamPoolCidrs": { "shape": "IpamPoolCidrSet", "documentation": "Information about the CIDRs provisioned to an IPAM pool.
", "locationName": "ipamPoolCidrSet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A check for 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.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "locationName": "Filter" }, "MaxResults": { "shape": "IpamMaxResults", "documentation": "The maximum number of results to return in the request.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token for the next page of results.
" }, "IpamScopeId": { "shape": "IpamScopeId", "documentation": "The ID of the scope that the resource is in.
" }, "IpamPoolId": { "shape": "IpamPoolId", "documentation": "The ID of the IPAM pool that the resource is in.
" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
" }, "ResourceType": { "shape": "IpamResourceType", "documentation": "The resource type.
" }, "ResourceTag": { "shape": "RequestIpamResourceTag", "documentation": "The resource tag.
" }, "ResourceOwner": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the resource.
" } } }, "GetIpamResourceCidrsResult": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The resource CIDRs.
", "locationName": "ipamResourceCidrSet" } } }, "GetLaunchTemplateDataRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance.
" } } }, "GetLaunchTemplateDataResult": { "type": "structure", "members": { "LaunchTemplateData": { "shape": "ResponseLaunchTemplateData", "documentation": "The instance data.
", "locationName": "launchTemplateData" } } }, "GetManagedPrefixListAssociationsMaxResults": { "type": "integer", "max": 255, "min": 5 }, "GetManagedPrefixListAssociationsRequest": { "type": "structure", "required": [ "PrefixListId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the prefix list.
" }, "MaxResults": { "shape": "GetManagedPrefixListAssociationsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" } } }, "GetManagedPrefixListAssociationsResult": { "type": "structure", "members": { "PrefixListAssociations": { "shape": "PrefixListAssociationSet", "documentation": "Information about the associations.
", "locationName": "prefixListAssociationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
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.
The ID of the prefix list.
" }, "TargetVersion": { "shape": "Long", "documentation": "The version of the prefix list for which to return the entries. The default is the current version.
" }, "MaxResults": { "shape": "PrefixListMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" } } }, "GetManagedPrefixListEntriesResult": { "type": "structure", "members": { "Entries": { "shape": "PrefixListEntrySet", "documentation": "Information about the prefix list entries.
", "locationName": "entrySet" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Network Access Scope analysis.
" }, "MaxResults": { "shape": "GetNetworkInsightsAccessScopeAnalysisFindingsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Network Access Scope analysis.
", "locationName": "networkInsightsAccessScopeAnalysisId" }, "AnalysisStatus": { "shape": "AnalysisStatus", "documentation": "The status of Network Access Scope Analysis.
", "locationName": "analysisStatus" }, "AnalysisFindings": { "shape": "AccessScopeAnalysisFindingList", "documentation": "The findings associated with Network Access Scope Analysis.
", "locationName": "analysisFindingSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Network Access Scope.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The Network Access Scope content.
", "locationName": "networkInsightsAccessScopeContent" } } }, "GetPasswordDataRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the Windows instance.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Windows instance.
", "locationName": "instanceId" }, "PasswordData": { "shape": "PasswordData", "documentation": "The password of the instance. Returns an empty string if the password is not available.
", "locationName": "passwordData" }, "Timestamp": { "shape": "DateTime", "documentation": "The time the data was last updated.
", "locationName": "timestamp" } } }, "GetReservedInstancesExchangeQuoteRequest": { "type": "structure", "required": [ "ReservedInstanceIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the Convertible Reserved Instances to exchange.
", "locationName": "ReservedInstanceId" }, "TargetConfigurations": { "shape": "TargetConfigurationRequestSet", "documentation": "The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
", "locationName": "TargetConfiguration" } }, "documentation": "Contains the parameters for GetReservedInstanceExchangeQuote.
" }, "GetReservedInstancesExchangeQuoteResult": { "type": "structure", "members": { "CurrencyCode": { "shape": "String", "documentation": "The currency of the transaction.
", "locationName": "currencyCode" }, "IsValidExchange": { "shape": "Boolean", "documentation": "If true, the exchange is valid. If false, the exchange cannot be completed.
The new end date of the reservation term.
", "locationName": "outputReservedInstancesWillExpireAt" }, "PaymentDue": { "shape": "String", "documentation": "The total true upfront charge for the exchange.
", "locationName": "paymentDue" }, "ReservedInstanceValueRollup": { "shape": "ReservationValue", "documentation": "The cost associated with the Reserved Instance.
", "locationName": "reservedInstanceValueRollup" }, "ReservedInstanceValueSet": { "shape": "ReservedInstanceReservationValueSet", "documentation": "The configuration of your Convertible Reserved Instances.
", "locationName": "reservedInstanceValueSet" }, "TargetConfigurationValueRollup": { "shape": "ReservationValue", "documentation": "The cost associated with the Reserved Instance.
", "locationName": "targetConfigurationValueRollup" }, "TargetConfigurationValueSet": { "shape": "TargetReservationValueSet", "documentation": "The values of the target Convertible Reserved Instances.
", "locationName": "targetConfigurationValueSet" }, "ValidationFailureReason": { "shape": "String", "documentation": "Describes the reason why the exchange cannot be completed.
", "locationName": "validationFailureReason" } }, "documentation": "Contains the output of GetReservedInstancesExchangeQuote.
" }, "GetSecurityGroupsForVpcRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "VpcId": { "shape": "VpcId", "documentation": "The VPC ID where the security group can be used.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "GetSecurityGroupsForVpcRequestMaxResults", "documentation": "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.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters. If using multiple filters, the results include security groups which match all filters.
group-id: The security group ID.
description: The security group's description.
group-name: The security group name.
owner-id: The security group owner ID.
primary-vpc-id: The VPC ID in which the security group was created.
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.
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.
The security group that can be used by interfaces in the VPC.
", "locationName": "securityGroupForVpcSet" } } }, "GetSerialConsoleAccessStatusRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.
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.
The current state of block public access for snapshots. Possible values include:
block-all-sharing - All public sharing of snapshots is blocked. Users in the account can't request new public sharing. Additionally, snapshots that were already publicly shared are treated as private and are not publicly available.
block-new-sharing - Only new public sharing of snapshots is blocked. Users in the account can't request new public sharing. However, snapshots that were already publicly shared, remain publicly available.
unblocked - Public sharing is not blocked. Users can publicly share snapshots.
The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an m3.xlarge with and without instance storage), the returned placement score will always be low.
If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
The target capacity.
" }, "TargetCapacityUnitType": { "shape": "TargetCapacityUnitType", "documentation": "The unit for the target capacity.
" }, "SingleAvailabilityZone": { "shape": "Boolean", "documentation": "Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.
" }, "RegionNames": { "shape": "RegionNames", "documentation": "The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.
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.
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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "GetSpotPlacementScoresResult": { "type": "structure", "members": { "SpotPlacementScores": { "shape": "SpotPlacementScores", "documentation": "The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score
reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity
at the time of the Spot placement score request. A score of 10 means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone.
If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the capacity-optimized allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the capacity-optimized allocation strategy.
Different Regions or Availability Zones might return the same score.
The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled.
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.
One or more filters.
reservationType - The type of reservation (prefix | explicit).
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The ID of the subnet.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The token for the next page of results.
" }, "MaxResults": { "shape": "GetSubnetCidrReservationsMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Information about the IPv4 subnet CIDR reservations.
", "locationName": "subnetIpv4CidrReservationSet" }, "SubnetIpv6CidrReservations": { "shape": "SubnetCidrReservationList", "documentation": "Information about the IPv6 subnet CIDR reservations.
", "locationName": "subnetIpv6CidrReservationSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the attachment.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
transit-gateway-route-table-id - The ID of the transit gateway route table.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the propagation route tables.
", "locationName": "transitGatewayAttachmentPropagations" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway multicast domain.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The type of resource. The valid value is: vpc.
state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the multicast domain associations.
", "locationName": "multicastDomainAssociations" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway policy table.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters associated with the transit gateway policy table.
", "locationName": "Filter" }, "MaxResults": { "shape": "TransitGatewayMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns details about the transit gateway policy table association.
", "locationName": "associations" }, "NextToken": { "shape": "String", "documentation": "The token for the next page of results.
", "locationName": "nextToken" } } }, "GetTransitGatewayPolicyTableEntriesRequest": { "type": "structure", "required": [ "TransitGatewayPolicyTableId" ], "members": { "TransitGatewayPolicyTableId": { "shape": "TransitGatewayPolicyTableId", "documentation": "The ID of the transit gateway policy table.
" }, "Filters": { "shape": "FilterList", "documentation": "The filters associated with the transit gateway policy table.
", "locationName": "Filter" }, "MaxResults": { "shape": "TransitGatewayMaxResults", "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The entries for the transit gateway policy table.
", "locationName": "transitGatewayPolicyTableEntries" } } }, "GetTransitGatewayPrefixListReferencesRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
attachment.resource-id - The ID of the resource for the attachment.
attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
attachment.transit-gateway-attachment-id - The ID of the attachment.
is-blackhole - Whether traffic matching the route is blocked (true | false).
prefix-list-id - The ID of the prefix list.
prefix-list-owner-id - The ID of the owner of the prefix list.
state - The state of the prefix list reference (pending | available | modifying | deleting).
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the prefix list references.
", "locationName": "transitGatewayPrefixListReferenceSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway route table.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the associations.
", "locationName": "associations" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway route table.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the route table propagations.
", "locationName": "transitGatewayRouteTablePropagations" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Verified Access endpoint.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The status of the Verified Access policy.
", "locationName": "policyEnabled" }, "PolicyDocument": { "shape": "String", "documentation": "The Verified Access policy document.
", "locationName": "policyDocument" } } }, "GetVerifiedAccessGroupPolicyRequest": { "type": "structure", "required": [ "VerifiedAccessGroupId" ], "members": { "VerifiedAccessGroupId": { "shape": "VerifiedAccessGroupId", "documentation": "The ID of the Verified Access group.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The status of the Verified Access policy.
", "locationName": "policyEnabled" }, "PolicyDocument": { "shape": "String", "documentation": "The Verified Access policy document.
", "locationName": "policyDocument" } } }, "GetVpnConnectionDeviceSampleConfigurationRequest": { "type": "structure", "required": [ "VpnConnectionId", "VpnConnectionDeviceTypeId" ], "members": { "VpnConnectionId": { "shape": "VpnConnectionId", "documentation": "The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.
Device identifier provided by the GetVpnConnectionDeviceTypes API.
The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.
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.
Sample configuration file for the specified customer gateway device.
", "locationName": "vpnConnectionDeviceSampleConfiguration" } } }, "GetVpnConnectionDeviceTypesRequest": { "type": "structure", "members": { "MaxResults": { "shape": "GVCDMaxResults", "documentation": "The maximum number of results returned by GetVpnConnectionDeviceTypes in paginated output. When this parameter is used, GetVpnConnectionDeviceTypes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another GetVpnConnectionDeviceTypes request with the returned NextToken value. This value can be between 200 and 1000. If this parameter is not used, then GetVpnConnectionDeviceTypes returns all results.
The NextToken value returned from a previous paginated GetVpnConnectionDeviceTypes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
List of customer gateway devices that have a sample configuration file available for use.
", "locationName": "vpnConnectionDeviceTypeSet" }, "NextToken": { "shape": "NextToken", "documentation": "The NextToken value to include in a future GetVpnConnectionDeviceTypes request. When the results of a GetVpnConnectionDeviceTypes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Site-to-Site VPN connection.
" }, "VpnTunnelOutsideIpAddress": { "shape": "String", "documentation": "The external IP address of the VPN tunnel.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Site-to-Site VPN connection.
", "locationName": "vpnConnectionId" }, "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway associated with the VPN connection.
", "locationName": "transitGatewayId" }, "CustomerGatewayId": { "shape": "CustomerGatewayId", "documentation": "The ID of the customer gateway.
", "locationName": "customerGatewayId" }, "VpnGatewayId": { "shape": "VpnGatewayId", "documentation": "The ID of the virtual private gateway.
", "locationName": "vpnGatewayId" }, "VpnTunnelOutsideIpAddress": { "shape": "String", "documentation": "The external IP address of the VPN tunnel.
", "locationName": "vpnTunnelOutsideIpAddress" }, "MaintenanceDetails": { "shape": "MaintenanceDetails", "documentation": "Get details of pending tunnel endpoint maintenance.
", "locationName": "maintenanceDetails" } } }, "GpuDeviceCount": { "type": "integer" }, "GpuDeviceInfo": { "type": "structure", "members": { "Name": { "shape": "GpuDeviceName", "documentation": "The name of the GPU accelerator.
", "locationName": "name" }, "Manufacturer": { "shape": "GpuDeviceManufacturerName", "documentation": "The manufacturer of the GPU accelerator.
", "locationName": "manufacturer" }, "Count": { "shape": "GpuDeviceCount", "documentation": "The number of GPUs for the instance type.
", "locationName": "count" }, "MemoryInfo": { "shape": "GpuDeviceMemoryInfo", "documentation": "Describes the memory available to the GPU accelerator.
", "locationName": "memoryInfo" } }, "documentation": "Describes the GPU accelerators for the instance type.
" }, "GpuDeviceInfoList": { "type": "list", "member": { "shape": "GpuDeviceInfo", "locationName": "item" } }, "GpuDeviceManufacturerName": { "type": "string" }, "GpuDeviceMemoryInfo": { "type": "structure", "members": { "SizeInMiB": { "shape": "GpuDeviceMemorySize", "documentation": "The size of the memory available to the GPU accelerator, in MiB.
", "locationName": "sizeInMiB" } }, "documentation": "Describes the memory available to the GPU accelerator.
" }, "GpuDeviceMemorySize": { "type": "integer" }, "GpuDeviceName": { "type": "string" }, "GpuInfo": { "type": "structure", "members": { "Gpus": { "shape": "GpuDeviceInfoList", "documentation": "Describes the GPU accelerators for the instance type.
", "locationName": "gpus" }, "TotalGpuMemoryInMiB": { "shape": "totalGpuMemory", "documentation": "The total size of the memory for the GPU accelerators for the instance type, in MiB.
", "locationName": "totalGpuMemoryInMiB" } }, "documentation": "Describes the GPU accelerators for the instance type.
" }, "GroupIdStringList": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "groupId" } }, "GroupIdentifier": { "type": "structure", "members": { "GroupName": { "shape": "String", "documentation": "The name of the security group.
", "locationName": "groupName" }, "GroupId": { "shape": "String", "documentation": "The ID of the security group.
", "locationName": "groupId" } }, "documentation": "Describes a security group.
" }, "GroupIdentifierList": { "type": "list", "member": { "shape": "GroupIdentifier", "locationName": "item" } }, "GroupIdentifierSet": { "type": "list", "member": { "shape": "SecurityGroupIdentifier", "locationName": "item" } }, "GroupIds": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "item" } }, "GroupNameStringList": { "type": "list", "member": { "shape": "SecurityGroupName", "locationName": "GroupName" } }, "HibernationFlag": { "type": "boolean" }, "HibernationOptions": { "type": "structure", "members": { "Configured": { "shape": "Boolean", "documentation": "If true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
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.
" }, "HibernationOptionsRequest": { "type": "structure", "members": { "Configured": { "shape": "Boolean", "documentation": "Set to true to enable your instance for hibernation.
For Spot Instances, if you set Configured to true, either omit the InstanceInterruptionBehavior parameter (for SpotMarketOptions ), or set it to hibernate. When Configured is true:
If you omit InstanceInterruptionBehavior, it defaults to hibernate.
If you set InstanceInterruptionBehavior to a value other than hibernate, you'll get an error.
Default: false
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.
" }, "HistoryRecord": { "type": "structure", "members": { "EventInformation": { "shape": "EventInformation", "documentation": "Information about the event.
", "locationName": "eventInformation" }, "EventType": { "shape": "EventType", "documentation": "The event type.
error - An error with the Spot Fleet request.
fleetRequestChange - A change in the status or configuration of the Spot Fleet request.
instanceChange - An instance was launched or terminated.
Information - An informational event.
The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "timestamp" } }, "documentation": "Describes an event in the history of the Spot Fleet request.
" }, "HistoryRecordEntry": { "type": "structure", "members": { "EventInformation": { "shape": "EventInformation", "documentation": "Information about the event.
", "locationName": "eventInformation" }, "EventType": { "shape": "FleetEventType", "documentation": "The event type.
", "locationName": "eventType" }, "Timestamp": { "shape": "DateTime", "documentation": "The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "timestamp" } }, "documentation": "Describes an event in the history of an EC2 Fleet.
" }, "HistoryRecordSet": { "type": "list", "member": { "shape": "HistoryRecordEntry", "locationName": "item" } }, "HistoryRecords": { "type": "list", "member": { "shape": "HistoryRecord", "locationName": "item" } }, "Host": { "type": "structure", "members": { "AutoPlacement": { "shape": "AutoPlacement", "documentation": "Whether auto-placement is on or off.
", "locationName": "autoPlacement" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone of the Dedicated Host.
", "locationName": "availabilityZone" }, "AvailableCapacity": { "shape": "AvailableCapacity", "documentation": "Information about the instances running on the Dedicated Host.
", "locationName": "availableCapacity" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "locationName": "clientToken" }, "HostId": { "shape": "String", "documentation": "The ID of the Dedicated Host.
", "locationName": "hostId" }, "HostProperties": { "shape": "HostProperties", "documentation": "The hardware specifications of the Dedicated Host.
", "locationName": "hostProperties" }, "HostReservationId": { "shape": "String", "documentation": "The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.
The IDs and instance type that are currently running on the Dedicated Host.
", "locationName": "instances" }, "State": { "shape": "AllocationState", "documentation": "The Dedicated Host's state.
", "locationName": "state" }, "AllocationTime": { "shape": "DateTime", "documentation": "The time that the Dedicated Host was allocated.
", "locationName": "allocationTime" }, "ReleaseTime": { "shape": "DateTime", "documentation": "The time that the Dedicated Host was released.
", "locationName": "releaseTime" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the Dedicated Host.
", "locationName": "tagSet" }, "HostRecovery": { "shape": "HostRecovery", "documentation": "Indicates whether host recovery is enabled or disabled for the Dedicated Host.
", "locationName": "hostRecovery" }, "AllowsMultipleInstanceTypes": { "shape": "AllowsMultipleInstanceTypes", "documentation": "Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.
The ID of the Amazon Web Services account that owns the Dedicated Host.
", "locationName": "ownerId" }, "AvailabilityZoneId": { "shape": "String", "documentation": "The ID of the Availability Zone in which the Dedicated Host is allocated.
", "locationName": "availabilityZoneId" }, "MemberOfServiceLinkedResourceGroup": { "shape": "Boolean", "documentation": "Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.
The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.
", "locationName": "outpostArn" }, "HostMaintenance": { "shape": "HostMaintenance", "documentation": "Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
", "locationName": "hostMaintenance" }, "AssetId": { "shape": "AssetId", "documentation": "The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
", "locationName": "assetId" } }, "documentation": "Describes the properties of the Dedicated Host.
" }, "HostInstance": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The ID of instance that is running on the Dedicated Host.
", "locationName": "instanceId" }, "InstanceType": { "shape": "String", "documentation": "The instance type (for example, m3.medium) of the running instance.
The ID of the Amazon Web Services account that owns the instance.
", "locationName": "ownerId" } }, "documentation": "Describes an instance running on a Dedicated Host.
" }, "HostInstanceList": { "type": "list", "member": { "shape": "HostInstance", "locationName": "item" } }, "HostList": { "type": "list", "member": { "shape": "Host", "locationName": "item" } }, "HostMaintenance": { "type": "string", "enum": [ "on", "off" ] }, "HostOffering": { "type": "structure", "members": { "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency of the offering.
", "locationName": "currencyCode" }, "Duration": { "shape": "Integer", "documentation": "The duration of the offering (in seconds).
", "locationName": "duration" }, "HourlyPrice": { "shape": "String", "documentation": "The hourly price of the offering.
", "locationName": "hourlyPrice" }, "InstanceFamily": { "shape": "String", "documentation": "The instance family of the offering.
", "locationName": "instanceFamily" }, "OfferingId": { "shape": "OfferingId", "documentation": "The ID of the offering.
", "locationName": "offeringId" }, "PaymentOption": { "shape": "PaymentOption", "documentation": "The available payment option.
", "locationName": "paymentOption" }, "UpfrontPrice": { "shape": "String", "documentation": "The upfront price of the offering. Does not apply to No Upfront offerings.
", "locationName": "upfrontPrice" } }, "documentation": "Details about the Dedicated Host Reservation offering.
" }, "HostOfferingSet": { "type": "list", "member": { "shape": "HostOffering", "locationName": "item" } }, "HostProperties": { "type": "structure", "members": { "Cores": { "shape": "Integer", "documentation": "The number of cores on the Dedicated Host.
", "locationName": "cores" }, "InstanceType": { "shape": "String", "documentation": "The instance type supported by the Dedicated Host. For example, m5.large. If the host supports multiple instance types, no instanceType is returned.
The instance family supported by the Dedicated Host. For example, m5.
The number of sockets on the Dedicated Host.
", "locationName": "sockets" }, "TotalVCpus": { "shape": "Integer", "documentation": "The total number of vCPUs on the Dedicated Host.
", "locationName": "totalVCpus" } }, "documentation": "Describes the properties of a Dedicated Host.
" }, "HostRecovery": { "type": "string", "enum": [ "on", "off" ] }, "HostReservation": { "type": "structure", "members": { "Count": { "shape": "Integer", "documentation": "The number of Dedicated Hosts the reservation is associated with.
", "locationName": "count" }, "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.
The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).
The date and time that the reservation ends.
", "locationName": "end" }, "HostIdSet": { "shape": "ResponseHostIdSet", "documentation": "The IDs of the Dedicated Hosts associated with the reservation.
", "locationName": "hostIdSet" }, "HostReservationId": { "shape": "HostReservationId", "documentation": "The ID of the reservation that specifies the associated Dedicated Hosts.
", "locationName": "hostReservationId" }, "HourlyPrice": { "shape": "String", "documentation": "The hourly price of the reservation.
", "locationName": "hourlyPrice" }, "InstanceFamily": { "shape": "String", "documentation": "The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
", "locationName": "instanceFamily" }, "OfferingId": { "shape": "OfferingId", "documentation": "The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
", "locationName": "offeringId" }, "PaymentOption": { "shape": "PaymentOption", "documentation": "The payment option selected for this reservation.
", "locationName": "paymentOption" }, "Start": { "shape": "DateTime", "documentation": "The date and time that the reservation started.
", "locationName": "start" }, "State": { "shape": "ReservationState", "documentation": "The state of the reservation.
", "locationName": "state" }, "UpfrontPrice": { "shape": "String", "documentation": "The upfront price of the reservation.
", "locationName": "upfrontPrice" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the Dedicated Host Reservation.
", "locationName": "tagSet" } }, "documentation": "Details about the Dedicated Host Reservation and associated Dedicated Hosts.
" }, "HostReservationId": { "type": "string" }, "HostReservationIdSet": { "type": "list", "member": { "shape": "HostReservationId", "locationName": "item" } }, "HostReservationSet": { "type": "list", "member": { "shape": "HostReservation", "locationName": "item" } }, "HostTenancy": { "type": "string", "enum": [ "dedicated", "host" ] }, "HostnameType": { "type": "string", "enum": [ "ip-name", "resource-name" ] }, "Hour": { "type": "integer", "max": 23, "min": 0 }, "HttpTokensState": { "type": "string", "enum": [ "optional", "required" ] }, "HypervisorType": { "type": "string", "enum": [ "ovm", "xen" ] }, "IKEVersionsList": { "type": "list", "member": { "shape": "IKEVersionsListValue", "locationName": "item" } }, "IKEVersionsListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The IKE version.
", "locationName": "value" } }, "documentation": "The internet key exchange (IKE) version permitted for the VPN tunnel.
" }, "IKEVersionsRequestList": { "type": "list", "member": { "shape": "IKEVersionsRequestListValue", "locationName": "item" } }, "IKEVersionsRequestListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The IKE version.
" } }, "documentation": "The IKE version that is permitted for the VPN tunnel.
" }, "IamInstanceProfile": { "type": "structure", "members": { "Arn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the instance profile.
", "locationName": "arn" }, "Id": { "shape": "String", "documentation": "The ID of the instance profile.
", "locationName": "id" } }, "documentation": "Describes an IAM instance profile.
" }, "IamInstanceProfileAssociation": { "type": "structure", "members": { "AssociationId": { "shape": "String", "documentation": "The ID of the association.
", "locationName": "associationId" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "IamInstanceProfile": { "shape": "IamInstanceProfile", "documentation": "The IAM instance profile.
", "locationName": "iamInstanceProfile" }, "State": { "shape": "IamInstanceProfileAssociationState", "documentation": "The state of the association.
", "locationName": "state" }, "Timestamp": { "shape": "DateTime", "documentation": "The time the IAM instance profile was associated with the instance.
", "locationName": "timestamp" } }, "documentation": "Describes an association between an IAM instance profile and an instance.
" }, "IamInstanceProfileAssociationId": { "type": "string" }, "IamInstanceProfileAssociationSet": { "type": "list", "member": { "shape": "IamInstanceProfileAssociation", "locationName": "item" } }, "IamInstanceProfileAssociationState": { "type": "string", "enum": [ "associating", "associated", "disassociating", "disassociated" ] }, "IamInstanceProfileSpecification": { "type": "structure", "members": { "Arn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the instance profile.
", "locationName": "arn" }, "Name": { "shape": "String", "documentation": "The name of the instance profile.
", "locationName": "name" } }, "documentation": "Describes an IAM instance profile.
" }, "IcmpTypeCode": { "type": "structure", "members": { "Code": { "shape": "Integer", "documentation": "The ICMP code. A value of -1 means all codes for the specified ICMP type.
", "locationName": "code" }, "Type": { "shape": "Integer", "documentation": "The ICMP type. A value of -1 means all types.
", "locationName": "type" } }, "documentation": "Describes the ICMP type and code.
" }, "IdFormat": { "type": "structure", "members": { "Deadline": { "shape": "DateTime", "documentation": "The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
", "locationName": "deadline" }, "Resource": { "shape": "String", "documentation": "The type of resource.
", "locationName": "resource" }, "UseLongIds": { "shape": "Boolean", "documentation": "Indicates whether longer IDs (17-character IDs) are enabled for the resource.
", "locationName": "useLongIds" } }, "documentation": "Describes the ID format for a resource.
" }, "IdFormatList": { "type": "list", "member": { "shape": "IdFormat", "locationName": "item" } }, "Igmpv2SupportValue": { "type": "string", "enum": [ "enable", "disable" ] }, "Image": { "type": "structure", "members": { "Architecture": { "shape": "ArchitectureValues", "documentation": "The architecture of the image.
", "locationName": "architecture" }, "CreationDate": { "shape": "String", "documentation": "The date and time the image was created.
", "locationName": "creationDate" }, "ImageId": { "shape": "String", "documentation": "The ID of the AMI.
", "locationName": "imageId" }, "ImageLocation": { "shape": "String", "documentation": "The location of the AMI.
", "locationName": "imageLocation" }, "ImageType": { "shape": "ImageTypeValues", "documentation": "The type of image.
", "locationName": "imageType" }, "Public": { "shape": "Boolean", "documentation": "Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
The kernel associated with the image, if any. Only applicable for machine images.
", "locationName": "kernelId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the image.
", "locationName": "imageOwnerId" }, "Platform": { "shape": "PlatformValues", "documentation": "This value is set to windows for Windows AMIs; otherwise, it is blank.
The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
", "locationName": "platformDetails" }, "UsageOperation": { "shape": "String", "documentation": "The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.
Any product codes associated with the AMI.
", "locationName": "productCodes" }, "RamdiskId": { "shape": "String", "documentation": "The RAM disk associated with the image, if any. Only applicable for machine images.
", "locationName": "ramdiskId" }, "State": { "shape": "ImageState", "documentation": "The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
Any block device mapping entries.
", "locationName": "blockDeviceMapping" }, "Description": { "shape": "String", "documentation": "The description of the AMI that was provided during image creation.
", "locationName": "description" }, "EnaSupport": { "shape": "Boolean", "documentation": "Specifies whether enhanced networking with ENA is enabled.
", "locationName": "enaSupport" }, "Hypervisor": { "shape": "HypervisorType", "documentation": "The hypervisor type of the image. Only xen is supported. ovm is not supported.
The owner alias (amazon | aws-marketplace).
The name of the AMI that was provided during image creation.
", "locationName": "name" }, "RootDeviceName": { "shape": "String", "documentation": "The device name of the root device volume (for example, /dev/sda1).
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
", "locationName": "rootDeviceType" }, "SriovNetSupport": { "shape": "String", "documentation": "Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
", "locationName": "sriovNetSupport" }, "StateReason": { "shape": "StateReason", "documentation": "The reason for the state change.
", "locationName": "stateReason" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the image.
", "locationName": "tagSet" }, "VirtualizationType": { "shape": "VirtualizationType", "documentation": "The type of virtualization of the AMI.
", "locationName": "virtualizationType" }, "BootMode": { "shape": "BootModeValues", "documentation": "The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
", "locationName": "bootMode" }, "TpmSupport": { "shape": "TpmSupportValues", "documentation": "If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
", "locationName": "deprecationTime" }, "ImdsSupport": { "shape": "ImdsSupportValues", "documentation": "If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.
", "locationName": "sourceInstanceId" }, "DeregistrationProtection": { "shape": "String", "documentation": "Indicates whether deregistration protection is enabled for the AMI.
", "locationName": "deregistrationProtection" }, "LastLaunchedTime": { "shape": "String", "documentation": "The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
Describes an image.
" }, "ImageAttribute": { "type": "structure", "members": { "BlockDeviceMappings": { "shape": "BlockDeviceMappingList", "documentation": "The block device mapping entries.
", "locationName": "blockDeviceMapping" }, "ImageId": { "shape": "String", "documentation": "The ID of the AMI.
", "locationName": "imageId" }, "LaunchPermissions": { "shape": "LaunchPermissionList", "documentation": "The launch permissions.
", "locationName": "launchPermission" }, "ProductCodes": { "shape": "ProductCodeList", "documentation": "The product codes.
", "locationName": "productCodes" }, "Description": { "shape": "AttributeValue", "documentation": "A description for the AMI.
", "locationName": "description" }, "KernelId": { "shape": "AttributeValue", "documentation": "The kernel ID.
", "locationName": "kernel" }, "RamdiskId": { "shape": "AttributeValue", "documentation": "The RAM disk ID.
", "locationName": "ramdisk" }, "SriovNetSupport": { "shape": "AttributeValue", "documentation": "Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
", "locationName": "sriovNetSupport" }, "BootMode": { "shape": "AttributeValue", "documentation": "The boot mode.
", "locationName": "bootMode" }, "TpmSupport": { "shape": "AttributeValue", "documentation": "If the image is configured for NitroTPM support, the value is v2.0.
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
", "locationName": "uefiData" }, "LastLaunchedTime": { "shape": "AttributeValue", "documentation": "The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Indicates whether deregistration protection is enabled for the AMI.
", "locationName": "deregistrationProtection" } }, "documentation": "Describes an image attribute.
" }, "ImageAttributeName": { "type": "string", "enum": [ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping", "sriovNetSupport", "bootMode", "tpmSupport", "uefiData", "lastLaunchedTime", "imdsSupport", "deregistrationProtection" ] }, "ImageBlockPublicAccessDisabledState": { "type": "string", "enum": [ "unblocked" ] }, "ImageBlockPublicAccessEnabledState": { "type": "string", "enum": [ "block-new-sharing" ] }, "ImageDiskContainer": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "The description of the disk image.
" }, "DeviceName": { "shape": "String", "documentation": "The block device mapping for the disk.
" }, "Format": { "shape": "String", "documentation": "The format of the disk image being imported.
Valid values: OVA | VHD | VHDX | VMDK | RAW
The ID of the EBS snapshot to be used for importing the snapshot.
" }, "Url": { "shape": "SensitiveUrl", "documentation": "The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)
" }, "UserBucket": { "shape": "UserBucket", "documentation": "The S3 bucket for the disk image.
" } }, "documentation": "Describes the disk container object for an import image task.
" }, "ImageDiskContainerList": { "type": "list", "member": { "shape": "ImageDiskContainer", "locationName": "item" } }, "ImageId": { "type": "string" }, "ImageIdList": { "type": "list", "member": { "shape": "ImageId", "locationName": "item" } }, "ImageIdStringList": { "type": "list", "member": { "shape": "ImageId", "locationName": "ImageId" } }, "ImageList": { "type": "list", "member": { "shape": "Image", "locationName": "item" } }, "ImageRecycleBinInfo": { "type": "structure", "members": { "ImageId": { "shape": "String", "documentation": "The ID of the AMI.
", "locationName": "imageId" }, "Name": { "shape": "String", "documentation": "The name of the AMI.
", "locationName": "name" }, "Description": { "shape": "String", "documentation": "The description of the AMI.
", "locationName": "description" }, "RecycleBinEnterTime": { "shape": "MillisecondDateTime", "documentation": "The date and time when the AMI entered the Recycle Bin.
", "locationName": "recycleBinEnterTime" }, "RecycleBinExitTime": { "shape": "MillisecondDateTime", "documentation": "The date and time when the AMI is to be permanently deleted from the Recycle Bin.
", "locationName": "recycleBinExitTime" } }, "documentation": "Information about an AMI that is currently in the Recycle Bin.
" }, "ImageRecycleBinInfoList": { "type": "list", "member": { "shape": "ImageRecycleBinInfo", "locationName": "item" } }, "ImageState": { "type": "string", "enum": [ "pending", "available", "invalid", "deregistered", "transient", "failed", "error", "disabled" ] }, "ImageTypeValues": { "type": "string", "enum": [ "machine", "kernel", "ramdisk" ] }, "ImdsSupportValues": { "type": "string", "enum": [ "v2.0" ] }, "ImportClientVpnClientCertificateRevocationListRequest": { "type": "structure", "required": [ "ClientVpnEndpointId", "CertificateRevocationList" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint to which the client certificate revocation list applies.
" }, "CertificateRevocationList": { "shape": "String", "documentation": "The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the Client VPN Administrator Guide.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
The ARN of a license configuration.
" } }, "documentation": "The request information of license configurations.
" }, "ImportImageLicenseConfigurationResponse": { "type": "structure", "members": { "LicenseConfigurationArn": { "shape": "String", "documentation": "The ARN of a license configuration.
", "locationName": "licenseConfigurationArn" } }, "documentation": "The response information for license configurations.
" }, "ImportImageLicenseSpecificationListRequest": { "type": "list", "member": { "shape": "ImportImageLicenseConfigurationRequest", "locationName": "item" } }, "ImportImageLicenseSpecificationListResponse": { "type": "list", "member": { "shape": "ImportImageLicenseConfigurationResponse", "locationName": "item" } }, "ImportImageRequest": { "type": "structure", "members": { "Architecture": { "shape": "String", "documentation": "The architecture of the virtual machine.
Valid values: i386 | x86_64
The client-specific data.
" }, "ClientToken": { "shape": "String", "documentation": "The token to enable idempotency for VM import requests.
" }, "Description": { "shape": "String", "documentation": "A description string for the import image task.
" }, "DiskContainers": { "shape": "ImageDiskContainerList", "documentation": "Information about the disk containers.
", "locationName": "DiskContainer" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
The target hypervisor platform.
Valid values: xen
An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric KMS keys.
" }, "LicenseType": { "shape": "String", "documentation": "The license type to be used for the Amazon Machine Image (AMI) after importing.
Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.
The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.
Valid values: Windows | Linux
The name of the role to use when not using the default role, 'vmimport'.
" }, "LicenseSpecifications": { "shape": "ImportImageLicenseSpecificationListRequest", "documentation": "The ARNs of the license configurations.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the import image task during creation.
", "locationName": "TagSpecification" }, "UsageOperation": { "shape": "String", "documentation": "The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
" }, "BootMode": { "shape": "BootModeValues", "documentation": "The boot mode of the virtual machine.
The uefi-preferred boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.
The architecture of the virtual machine.
", "locationName": "architecture" }, "Description": { "shape": "String", "documentation": "A description of the import task.
", "locationName": "description" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the AMI is encrypted.
", "locationName": "encrypted" }, "Hypervisor": { "shape": "String", "documentation": "The target hypervisor of the import task.
", "locationName": "hypervisor" }, "ImageId": { "shape": "String", "documentation": "The ID of the Amazon Machine Image (AMI) created by the import task.
", "locationName": "imageId" }, "ImportTaskId": { "shape": "ImportImageTaskId", "documentation": "The task ID of the import image task.
", "locationName": "importTaskId" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifier for the symmetric KMS key that was used to create the encrypted AMI.
", "locationName": "kmsKeyId" }, "LicenseType": { "shape": "String", "documentation": "The license type of the virtual machine.
", "locationName": "licenseType" }, "Platform": { "shape": "String", "documentation": "The operating system of the virtual machine.
", "locationName": "platform" }, "Progress": { "shape": "String", "documentation": "The progress of the task.
", "locationName": "progress" }, "SnapshotDetails": { "shape": "SnapshotDetailList", "documentation": "Information about the snapshots.
", "locationName": "snapshotDetailSet" }, "Status": { "shape": "String", "documentation": "A brief status of the task.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "A detailed status message of the import task.
", "locationName": "statusMessage" }, "LicenseSpecifications": { "shape": "ImportImageLicenseSpecificationListResponse", "documentation": "The ARNs of the license configurations.
", "locationName": "licenseSpecifications" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the import image task.
", "locationName": "tagSet" }, "UsageOperation": { "shape": "String", "documentation": "The usage operation value.
", "locationName": "usageOperation" } } }, "ImportImageTask": { "type": "structure", "members": { "Architecture": { "shape": "String", "documentation": "The architecture of the virtual machine.
Valid values: i386 | x86_64 | arm64
A description of the import task.
", "locationName": "description" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the image is encrypted.
", "locationName": "encrypted" }, "Hypervisor": { "shape": "String", "documentation": "The target hypervisor for the import task.
Valid values: xen
The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
", "locationName": "imageId" }, "ImportTaskId": { "shape": "String", "documentation": "The ID of the import image task.
", "locationName": "importTaskId" }, "KmsKeyId": { "shape": "String", "documentation": "The identifier for the KMS key that was used to create the encrypted image.
", "locationName": "kmsKeyId" }, "LicenseType": { "shape": "String", "documentation": "The license type of the virtual machine.
", "locationName": "licenseType" }, "Platform": { "shape": "String", "documentation": "The description string for the import image task.
", "locationName": "platform" }, "Progress": { "shape": "String", "documentation": "The percentage of progress of the import image task.
", "locationName": "progress" }, "SnapshotDetails": { "shape": "SnapshotDetailList", "documentation": "Information about the snapshots.
", "locationName": "snapshotDetailSet" }, "Status": { "shape": "String", "documentation": "A brief status for the import image task.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "A descriptive status message for the import image task.
", "locationName": "statusMessage" }, "Tags": { "shape": "TagList", "documentation": "The tags for the import image task.
", "locationName": "tagSet" }, "LicenseSpecifications": { "shape": "ImportImageLicenseSpecificationListResponse", "documentation": "The ARNs of the license configurations that are associated with the import image task.
", "locationName": "licenseSpecifications" }, "UsageOperation": { "shape": "String", "documentation": "The usage operation value.
", "locationName": "usageOperation" }, "BootMode": { "shape": "BootModeValues", "documentation": "The boot mode of the virtual machine.
", "locationName": "bootMode" } }, "documentation": "Describes an import image task.
" }, "ImportImageTaskId": { "type": "string" }, "ImportImageTaskList": { "type": "list", "member": { "shape": "ImportImageTask", "locationName": "item" } }, "ImportInstanceLaunchSpecification": { "type": "structure", "members": { "AdditionalInfo": { "shape": "String", "documentation": "Reserved.
", "locationName": "additionalInfo" }, "Architecture": { "shape": "ArchitectureValues", "documentation": "The architecture of the instance.
", "locationName": "architecture" }, "GroupIds": { "shape": "SecurityGroupIdStringList", "documentation": "The security group IDs.
", "locationName": "GroupId" }, "GroupNames": { "shape": "SecurityGroupStringList", "documentation": "The security group names.
", "locationName": "GroupName" }, "InstanceInitiatedShutdownBehavior": { "shape": "ShutdownBehavior", "documentation": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", "locationName": "instanceInitiatedShutdownBehavior" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.
", "locationName": "instanceType" }, "Monitoring": { "shape": "Boolean", "documentation": "Indicates whether monitoring is enabled.
", "locationName": "monitoring" }, "Placement": { "shape": "Placement", "documentation": "The placement information for the instance.
", "locationName": "placement" }, "PrivateIpAddress": { "shape": "String", "documentation": "[EC2-VPC] An available IP address from the IP address range of the subnet.
", "locationName": "privateIpAddress" }, "SubnetId": { "shape": "SubnetId", "documentation": "[EC2-VPC] The ID of the subnet in which to launch the instance.
", "locationName": "subnetId" }, "UserData": { "shape": "UserData", "documentation": "The Base64-encoded user data to make available to the instance.
", "locationName": "userData" } }, "documentation": "Describes the launch specification for VM import.
" }, "ImportInstanceRequest": { "type": "structure", "required": [ "Platform" ], "members": { "Description": { "shape": "String", "documentation": "A description for the instance being imported.
", "locationName": "description" }, "DiskImages": { "shape": "DiskImageList", "documentation": "The disk image.
", "locationName": "diskImage" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The launch specification.
", "locationName": "launchSpecification" }, "Platform": { "shape": "PlatformValues", "documentation": "The instance operating system.
", "locationName": "platform" } } }, "ImportInstanceResult": { "type": "structure", "members": { "ConversionTask": { "shape": "ConversionTask", "documentation": "Information about the conversion task.
", "locationName": "conversionTask" } } }, "ImportInstanceTaskDetails": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the task.
", "locationName": "description" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "Platform": { "shape": "PlatformValues", "documentation": "The instance operating system.
", "locationName": "platform" }, "Volumes": { "shape": "ImportInstanceVolumeDetailSet", "documentation": "The volumes.
", "locationName": "volumes" } }, "documentation": "Describes an import instance task.
" }, "ImportInstanceVolumeDetailItem": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone where the resulting instance will reside.
", "locationName": "availabilityZone" }, "BytesConverted": { "shape": "Long", "documentation": "The number of bytes converted so far.
", "locationName": "bytesConverted" }, "Description": { "shape": "String", "documentation": "A description of the task.
", "locationName": "description" }, "Image": { "shape": "DiskImageDescription", "documentation": "The image.
", "locationName": "image" }, "Status": { "shape": "String", "documentation": "The status of the import of this particular disk image.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "The status information or errors related to the disk image.
", "locationName": "statusMessage" }, "Volume": { "shape": "DiskImageVolumeDescription", "documentation": "The volume.
", "locationName": "volume" } }, "documentation": "Describes an import volume task.
" }, "ImportInstanceVolumeDetailSet": { "type": "list", "member": { "shape": "ImportInstanceVolumeDetailItem", "locationName": "item" } }, "ImportKeyPairRequest": { "type": "structure", "required": [ "KeyName", "PublicKeyMaterial" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
A unique name for the key pair.
", "locationName": "keyName" }, "PublicKeyMaterial": { "shape": "Blob", "documentation": "The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
", "locationName": "publicKeyMaterial" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the imported key pair.
", "locationName": "TagSpecification" } } }, "ImportKeyPairResult": { "type": "structure", "members": { "KeyFingerprint": { "shape": "String", "documentation": "For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
The key pair name that you provided.
", "locationName": "keyName" }, "KeyPairId": { "shape": "String", "documentation": "The ID of the resulting key pair.
", "locationName": "keyPairId" }, "Tags": { "shape": "TagList", "documentation": "The tags applied to the imported key pair.
", "locationName": "tagSet" } } }, "ImportManifestUrl": { "type": "string", "sensitive": true }, "ImportSnapshotRequest": { "type": "structure", "members": { "ClientData": { "shape": "ClientData", "documentation": "The client-specific data.
" }, "ClientToken": { "shape": "String", "documentation": "Token to enable idempotency for VM import requests.
" }, "Description": { "shape": "String", "documentation": "The description string for the import snapshot task.
" }, "DiskContainer": { "shape": "SnapshotDiskContainer", "documentation": "Information about the disk container.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
" }, "RoleName": { "shape": "String", "documentation": "The name of the role to use when not using the default role, 'vmimport'.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the import snapshot task during creation.
", "locationName": "TagSpecification" } } }, "ImportSnapshotResult": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the import snapshot task.
", "locationName": "description" }, "ImportTaskId": { "shape": "String", "documentation": "The ID of the import snapshot task.
", "locationName": "importTaskId" }, "SnapshotTaskDetail": { "shape": "SnapshotTaskDetail", "documentation": "Information about the import snapshot task.
", "locationName": "snapshotTaskDetail" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the import snapshot task.
", "locationName": "tagSet" } } }, "ImportSnapshotTask": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the import snapshot task.
", "locationName": "description" }, "ImportTaskId": { "shape": "String", "documentation": "The ID of the import snapshot task.
", "locationName": "importTaskId" }, "SnapshotTaskDetail": { "shape": "SnapshotTaskDetail", "documentation": "Describes an import snapshot task.
", "locationName": "snapshotTaskDetail" }, "Tags": { "shape": "TagList", "documentation": "The tags for the import snapshot task.
", "locationName": "tagSet" } }, "documentation": "Describes an import snapshot task.
" }, "ImportSnapshotTaskId": { "type": "string" }, "ImportSnapshotTaskIdList": { "type": "list", "member": { "shape": "ImportSnapshotTaskId", "locationName": "ImportTaskId" } }, "ImportSnapshotTaskList": { "type": "list", "member": { "shape": "ImportSnapshotTask", "locationName": "item" } }, "ImportTaskId": { "type": "string" }, "ImportTaskIdList": { "type": "list", "member": { "shape": "ImportImageTaskId", "locationName": "ImportTaskId" } }, "ImportVolumeRequest": { "type": "structure", "required": [ "AvailabilityZone", "Image", "Volume" ], "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone for the resulting EBS volume.
", "locationName": "availabilityZone" }, "Description": { "shape": "String", "documentation": "A description of the volume.
", "locationName": "description" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The disk image.
", "locationName": "image" }, "Volume": { "shape": "VolumeDetail", "documentation": "The volume size.
", "locationName": "volume" } } }, "ImportVolumeResult": { "type": "structure", "members": { "ConversionTask": { "shape": "ConversionTask", "documentation": "Information about the conversion task.
", "locationName": "conversionTask" } } }, "ImportVolumeTaskDetails": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone where the resulting volume will reside.
", "locationName": "availabilityZone" }, "BytesConverted": { "shape": "Long", "documentation": "The number of bytes converted so far.
", "locationName": "bytesConverted" }, "Description": { "shape": "String", "documentation": "The description you provided when starting the import volume task.
", "locationName": "description" }, "Image": { "shape": "DiskImageDescription", "documentation": "The image.
", "locationName": "image" }, "Volume": { "shape": "DiskImageVolumeDescription", "documentation": "The volume.
", "locationName": "volume" } }, "documentation": "Describes an import volume task.
" }, "InferenceAcceleratorInfo": { "type": "structure", "members": { "Accelerators": { "shape": "InferenceDeviceInfoList", "documentation": "Describes the Inference accelerators for the instance type.
", "locationName": "accelerators" }, "TotalInferenceMemoryInMiB": { "shape": "totalInferenceMemory", "documentation": "The total size of the memory for the inference accelerators for the instance type, in MiB.
", "locationName": "totalInferenceMemoryInMiB" } }, "documentation": "Describes the Inference accelerators for the instance type.
" }, "InferenceDeviceCount": { "type": "integer" }, "InferenceDeviceInfo": { "type": "structure", "members": { "Count": { "shape": "InferenceDeviceCount", "documentation": "The number of Inference accelerators for the instance type.
", "locationName": "count" }, "Name": { "shape": "InferenceDeviceName", "documentation": "The name of the Inference accelerator.
", "locationName": "name" }, "Manufacturer": { "shape": "InferenceDeviceManufacturerName", "documentation": "The manufacturer of the Inference accelerator.
", "locationName": "manufacturer" }, "MemoryInfo": { "shape": "InferenceDeviceMemoryInfo", "documentation": "Describes the memory available to the inference accelerator.
", "locationName": "memoryInfo" } }, "documentation": "Describes the Inference accelerators for the instance type.
" }, "InferenceDeviceInfoList": { "type": "list", "member": { "shape": "InferenceDeviceInfo" }, "locationName": "item" }, "InferenceDeviceManufacturerName": { "type": "string" }, "InferenceDeviceMemoryInfo": { "type": "structure", "members": { "SizeInMiB": { "shape": "InferenceDeviceMemorySize", "documentation": "The size of the memory available to the inference accelerator, in MiB.
", "locationName": "sizeInMiB" } }, "documentation": "Describes the memory available to the inference accelerator.
" }, "InferenceDeviceMemorySize": { "type": "integer" }, "InferenceDeviceName": { "type": "string" }, "InsideCidrBlocksStringList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "Instance": { "type": "structure", "members": { "AmiLaunchIndex": { "shape": "Integer", "documentation": "The AMI launch index, which can be used to find this instance in the launch group.
", "locationName": "amiLaunchIndex" }, "ImageId": { "shape": "String", "documentation": "The ID of the AMI used to launch the instance.
", "locationName": "imageId" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
", "locationName": "instanceType" }, "KernelId": { "shape": "String", "documentation": "The kernel associated with this instance, if applicable.
", "locationName": "kernelId" }, "KeyName": { "shape": "String", "documentation": "The name of the key pair, if this instance was launched with an associated key pair.
", "locationName": "keyName" }, "LaunchTime": { "shape": "DateTime", "documentation": "The time the instance was launched.
", "locationName": "launchTime" }, "Monitoring": { "shape": "Monitoring", "documentation": "The monitoring for the instance.
", "locationName": "monitoring" }, "Placement": { "shape": "Placement", "documentation": "The location where the instance launched, if applicable.
", "locationName": "placement" }, "Platform": { "shape": "PlatformValues", "documentation": "The platform. This value is windows for Windows instances; otherwise, it is empty.
[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
", "locationName": "privateDnsName" }, "PrivateIpAddress": { "shape": "String", "documentation": "The private IPv4 address assigned to the instance.
", "locationName": "privateIpAddress" }, "ProductCodes": { "shape": "ProductCodeList", "documentation": "The product codes attached to this instance, if applicable.
", "locationName": "productCodes" }, "PublicDnsName": { "shape": "String", "documentation": "[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the running state. This name is only available if you've enabled DNS hostnames for your VPC.
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
", "locationName": "ipAddress" }, "RamdiskId": { "shape": "String", "documentation": "The RAM disk associated with this instance, if applicable.
", "locationName": "ramdiskId" }, "State": { "shape": "InstanceState", "documentation": "The current state of the instance.
", "locationName": "instanceState" }, "StateTransitionReason": { "shape": "String", "documentation": "The reason for the most recent state transition. This might be an empty string.
", "locationName": "reason" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet in which the instance is running.
", "locationName": "subnetId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC in which the instance is running.
", "locationName": "vpcId" }, "Architecture": { "shape": "ArchitectureValues", "documentation": "The architecture of the image.
", "locationName": "architecture" }, "BlockDeviceMappings": { "shape": "InstanceBlockDeviceMappingList", "documentation": "Any block device mapping entries for the instance.
", "locationName": "blockDeviceMapping" }, "ClientToken": { "shape": "String", "documentation": "The idempotency token you provided when you launched the instance, if applicable.
", "locationName": "clientToken" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
", "locationName": "ebsOptimized" }, "EnaSupport": { "shape": "Boolean", "documentation": "Specifies whether enhanced networking with ENA is enabled.
", "locationName": "enaSupport" }, "Hypervisor": { "shape": "HypervisorType", "documentation": "The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.
The IAM instance profile associated with the instance, if applicable.
", "locationName": "iamInstanceProfile" }, "InstanceLifecycle": { "shape": "InstanceLifecycleType", "documentation": "Indicates whether this is a Spot Instance or a Scheduled Instance.
", "locationName": "instanceLifecycle" }, "ElasticGpuAssociations": { "shape": "ElasticGpuAssociationList", "documentation": "Deprecated.
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.
The elastic inference accelerator associated with the instance.
", "locationName": "elasticInferenceAcceleratorAssociationSet" }, "NetworkInterfaces": { "shape": "InstanceNetworkInterfaceList", "documentation": "The network interfaces for the instance.
", "locationName": "networkInterfaceSet" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", "locationName": "outpostArn" }, "RootDeviceName": { "shape": "String", "documentation": "The device name of the root device volume (for example, /dev/sda1).
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
", "locationName": "rootDeviceType" }, "SecurityGroups": { "shape": "GroupIdentifierList", "documentation": "The security groups for the instance.
", "locationName": "groupSet" }, "SourceDestCheck": { "shape": "Boolean", "documentation": "Indicates whether source/destination checking is enabled.
", "locationName": "sourceDestCheck" }, "SpotInstanceRequestId": { "shape": "String", "documentation": "If the request is a Spot Instance request, the ID of the request.
", "locationName": "spotInstanceRequestId" }, "SriovNetSupport": { "shape": "String", "documentation": "Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
", "locationName": "sriovNetSupport" }, "StateReason": { "shape": "StateReason", "documentation": "The reason for the most recent state transition.
", "locationName": "stateReason" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the instance.
", "locationName": "tagSet" }, "VirtualizationType": { "shape": "VirtualizationType", "documentation": "The virtualization type of the instance.
", "locationName": "virtualizationType" }, "CpuOptions": { "shape": "CpuOptions", "documentation": "The CPU options for the instance.
", "locationName": "cpuOptions" }, "CapacityReservationId": { "shape": "String", "documentation": "The ID of the Capacity Reservation.
", "locationName": "capacityReservationId" }, "CapacityReservationSpecification": { "shape": "CapacityReservationSpecificationResponse", "documentation": "Information about the Capacity Reservation targeting option.
", "locationName": "capacityReservationSpecification" }, "HibernationOptions": { "shape": "HibernationOptions", "documentation": "Indicates whether the instance is enabled for hibernation.
", "locationName": "hibernationOptions" }, "Licenses": { "shape": "LicenseList", "documentation": "The license configurations for the instance.
", "locationName": "licenseSet" }, "MetadataOptions": { "shape": "InstanceMetadataOptionsResponse", "documentation": "The metadata options for the instance.
", "locationName": "metadataOptions" }, "EnclaveOptions": { "shape": "EnclaveOptions", "documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
", "locationName": "enclaveOptions" }, "BootMode": { "shape": "BootModeValues", "documentation": "The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Boot modes in the Amazon EC2 User Guide.
", "locationName": "bootMode" }, "PlatformDetails": { "shape": "String", "documentation": "The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
", "locationName": "platformDetails" }, "UsageOperation": { "shape": "String", "documentation": "The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
", "locationName": "usageOperation" }, "UsageOperationUpdateTime": { "shape": "MillisecondDateTime", "documentation": "The time that the usage operation was last updated.
", "locationName": "usageOperationUpdateTime" }, "PrivateDnsNameOptions": { "shape": "PrivateDnsNameOptionsResponse", "documentation": "The options for the instance hostname.
", "locationName": "privateDnsNameOptions" }, "Ipv6Address": { "shape": "String", "documentation": "The IPv6 address assigned to the instance.
", "locationName": "ipv6Address" }, "TpmSupport": { "shape": "String", "documentation": "If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.
Provides information on the recovery and maintenance options of your instance.
", "locationName": "maintenanceOptions" }, "CurrentInstanceBootMode": { "shape": "InstanceBootModeValues", "documentation": "The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.
", "locationName": "currentInstanceBootMode" } }, "documentation": "Describes an instance.
" }, "InstanceAttachmentEnaSrdSpecification": { "type": "structure", "members": { "EnaSrdEnabled": { "shape": "Boolean", "documentation": "Indicates whether ENA Express is enabled for the network interface.
", "locationName": "enaSrdEnabled" }, "EnaSrdUdpSpecification": { "shape": "InstanceAttachmentEnaSrdUdpSpecification", "documentation": "Configures ENA Express for UDP network traffic.
", "locationName": "enaSrdUdpSpecification" } }, "documentation": "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. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.
To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.
" }, "InstanceAttachmentEnaSrdUdpSpecification": { "type": "structure", "members": { "EnaSrdUdpEnabled": { "shape": "Boolean", "documentation": "Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
", "locationName": "enaSrdUdpEnabled" } }, "documentation": "ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.
" }, "InstanceAttribute": { "type": "structure", "members": { "Groups": { "shape": "GroupIdentifierList", "documentation": "The security groups associated with the instance.
", "locationName": "groupSet" }, "BlockDeviceMappings": { "shape": "InstanceBlockDeviceMappingList", "documentation": "The block device mapping of the instance.
", "locationName": "blockDeviceMapping" }, "DisableApiTermination": { "shape": "AttributeBooleanValue", "documentation": "If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.
Indicates whether enhanced networking with ENA is enabled.
", "locationName": "enaSupport" }, "EnclaveOptions": { "shape": "EnclaveOptions", "documentation": "To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.
Indicates whether the instance is optimized for Amazon EBS I/O.
", "locationName": "ebsOptimized" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "InstanceInitiatedShutdownBehavior": { "shape": "AttributeValue", "documentation": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", "locationName": "instanceInitiatedShutdownBehavior" }, "InstanceType": { "shape": "AttributeValue", "documentation": "The instance type.
", "locationName": "instanceType" }, "KernelId": { "shape": "AttributeValue", "documentation": "The kernel ID.
", "locationName": "kernel" }, "ProductCodes": { "shape": "ProductCodeList", "documentation": "A list of product codes.
", "locationName": "productCodes" }, "RamdiskId": { "shape": "AttributeValue", "documentation": "The RAM disk ID.
", "locationName": "ramdisk" }, "RootDeviceName": { "shape": "AttributeValue", "documentation": "The device name of the root device volume (for example, /dev/sda1).
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
", "locationName": "sriovNetSupport" }, "UserData": { "shape": "AttributeValue", "documentation": "The user data.
", "locationName": "userData" }, "DisableApiStop": { "shape": "AttributeBooleanValue", "documentation": "To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.
Describes an instance attribute.
" }, "InstanceAttributeName": { "type": "string", "enum": [ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport", "enaSupport", "enclaveOptions", "disableApiStop" ] }, "InstanceAutoRecoveryState": { "type": "string", "enum": [ "disabled", "default" ] }, "InstanceBlockDeviceMapping": { "type": "structure", "members": { "DeviceName": { "shape": "String", "documentation": "The device name (for example, /dev/sdh or xvdh).
Parameters used to automatically set up EBS volumes when the instance is launched.
", "locationName": "ebs" } }, "documentation": "Describes a block device mapping.
" }, "InstanceBlockDeviceMappingList": { "type": "list", "member": { "shape": "InstanceBlockDeviceMapping", "locationName": "item" } }, "InstanceBlockDeviceMappingSpecification": { "type": "structure", "members": { "DeviceName": { "shape": "String", "documentation": "The device name (for example, /dev/sdh or xvdh).
Parameters used to automatically set up EBS volumes when the instance is launched.
", "locationName": "ebs" }, "NoDevice": { "shape": "String", "documentation": "suppress the specified device included in the block device mapping.
", "locationName": "noDevice" }, "VirtualName": { "shape": "String", "documentation": "The virtual device name.
", "locationName": "virtualName" } }, "documentation": "Describes a block device mapping entry.
" }, "InstanceBlockDeviceMappingSpecificationList": { "type": "list", "member": { "shape": "InstanceBlockDeviceMappingSpecification", "locationName": "item" } }, "InstanceBootModeValues": { "type": "string", "enum": [ "legacy-bios", "uefi" ] }, "InstanceCapacity": { "type": "structure", "members": { "AvailableCapacity": { "shape": "Integer", "documentation": "The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.
", "locationName": "availableCapacity" }, "InstanceType": { "shape": "String", "documentation": "The instance type supported by the Dedicated Host.
", "locationName": "instanceType" }, "TotalCapacity": { "shape": "Integer", "documentation": "The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.
", "locationName": "totalCapacity" } }, "documentation": "Information about the number of instances that can be launched onto the Dedicated Host.
" }, "InstanceConnectEndpointId": { "type": "string" }, "InstanceConnectEndpointMaxResults": { "type": "integer", "max": 50, "min": 1 }, "InstanceConnectEndpointSet": { "type": "list", "member": { "shape": "Ec2InstanceConnectEndpoint", "locationName": "item" } }, "InstanceCount": { "type": "structure", "members": { "InstanceCount": { "shape": "Integer", "documentation": "The number of listed Reserved Instances in the state specified by the state.
The states of the listed Reserved Instances.
", "locationName": "state" } }, "documentation": "Describes a Reserved Instance listing state.
" }, "InstanceCountList": { "type": "list", "member": { "shape": "InstanceCount", "locationName": "item" } }, "InstanceCreditSpecification": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "CpuCredits": { "shape": "String", "documentation": "The credit option for CPU usage of the instance.
Valid values: standard | unlimited
Describes the credit option for CPU usage of a burstable performance instance.
" }, "InstanceCreditSpecificationList": { "type": "list", "member": { "shape": "InstanceCreditSpecification", "locationName": "item" } }, "InstanceCreditSpecificationListRequest": { "type": "list", "member": { "shape": "InstanceCreditSpecificationRequest", "locationName": "item" } }, "InstanceCreditSpecificationRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance.
" }, "CpuCredits": { "shape": "String", "documentation": "The credit option for CPU usage of the instance.
Valid values: standard | unlimited
T3 instances with host tenancy do not support the unlimited CPU credit option.
Describes the credit option for CPU usage of a burstable performance instance.
" }, "InstanceEventId": { "type": "string" }, "InstanceEventWindow": { "type": "structure", "members": { "InstanceEventWindowId": { "shape": "InstanceEventWindowId", "documentation": "The ID of the event window.
", "locationName": "instanceEventWindowId" }, "TimeRanges": { "shape": "InstanceEventWindowTimeRangeList", "documentation": "One or more time ranges defined for the event window.
", "locationName": "timeRangeSet" }, "Name": { "shape": "String", "documentation": "The name of the event window.
", "locationName": "name" }, "CronExpression": { "shape": "InstanceEventWindowCronExpression", "documentation": "The cron expression defined for the event window.
", "locationName": "cronExpression" }, "AssociationTarget": { "shape": "InstanceEventWindowAssociationTarget", "documentation": "One or more targets associated with the event window.
", "locationName": "associationTarget" }, "State": { "shape": "InstanceEventWindowState", "documentation": "The current state of the event window.
", "locationName": "state" }, "Tags": { "shape": "TagList", "documentation": "The instance tags associated with the event window.
", "locationName": "tagSet" } }, "documentation": "The event window.
" }, "InstanceEventWindowAssociationRequest": { "type": "structure", "members": { "InstanceIds": { "shape": "InstanceIdList", "documentation": "The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can't specify the Instance ID parameter; you must use the Dedicated Host ID parameter.
", "locationName": "InstanceId" }, "InstanceTags": { "shape": "TagList", "documentation": "The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.
", "locationName": "InstanceTag" }, "DedicatedHostIds": { "shape": "DedicatedHostIdList", "documentation": "The IDs of the Dedicated Hosts to associate with the event window.
", "locationName": "DedicatedHostId" } }, "documentation": "One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.
" }, "InstanceEventWindowAssociationTarget": { "type": "structure", "members": { "InstanceIds": { "shape": "InstanceIdList", "documentation": "The IDs of the instances associated with the event window.
", "locationName": "instanceIdSet" }, "Tags": { "shape": "TagList", "documentation": "The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.
", "locationName": "tagSet" }, "DedicatedHostIds": { "shape": "DedicatedHostIdList", "documentation": "The IDs of the Dedicated Hosts associated with the event window.
", "locationName": "dedicatedHostIdSet" } }, "documentation": "One or more targets associated with the event window.
" }, "InstanceEventWindowCronExpression": { "type": "string" }, "InstanceEventWindowDisassociationRequest": { "type": "structure", "members": { "InstanceIds": { "shape": "InstanceIdList", "documentation": "The IDs of the instances to disassociate from the event window.
", "locationName": "InstanceId" }, "InstanceTags": { "shape": "TagList", "documentation": "The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
", "locationName": "InstanceTag" }, "DedicatedHostIds": { "shape": "DedicatedHostIdList", "documentation": "The IDs of the Dedicated Hosts to disassociate from the event window.
", "locationName": "DedicatedHostId" } }, "documentation": "The targets to disassociate from the specified event window.
" }, "InstanceEventWindowId": { "type": "string" }, "InstanceEventWindowIdSet": { "type": "list", "member": { "shape": "InstanceEventWindowId", "locationName": "InstanceEventWindowId" } }, "InstanceEventWindowSet": { "type": "list", "member": { "shape": "InstanceEventWindow", "locationName": "item" } }, "InstanceEventWindowState": { "type": "string", "enum": [ "creating", "deleting", "active", "deleted" ] }, "InstanceEventWindowStateChange": { "type": "structure", "members": { "InstanceEventWindowId": { "shape": "InstanceEventWindowId", "documentation": "The ID of the event window.
", "locationName": "instanceEventWindowId" }, "State": { "shape": "InstanceEventWindowState", "documentation": "The current state of the event window.
", "locationName": "state" } }, "documentation": "The state of the event window.
" }, "InstanceEventWindowTimeRange": { "type": "structure", "members": { "StartWeekDay": { "shape": "WeekDay", "documentation": "The day on which the time range begins.
", "locationName": "startWeekDay" }, "StartHour": { "shape": "Hour", "documentation": "The hour when the time range begins.
", "locationName": "startHour" }, "EndWeekDay": { "shape": "WeekDay", "documentation": "The day on which the time range ends.
", "locationName": "endWeekDay" }, "EndHour": { "shape": "Hour", "documentation": "The hour when the time range ends.
", "locationName": "endHour" } }, "documentation": "The start day and time and the end day and time of the time range, in UTC.
" }, "InstanceEventWindowTimeRangeList": { "type": "list", "member": { "shape": "InstanceEventWindowTimeRange", "locationName": "item" } }, "InstanceEventWindowTimeRangeRequest": { "type": "structure", "members": { "StartWeekDay": { "shape": "WeekDay", "documentation": "The day on which the time range begins.
" }, "StartHour": { "shape": "Hour", "documentation": "The hour when the time range begins.
" }, "EndWeekDay": { "shape": "WeekDay", "documentation": "The day on which the time range ends.
" }, "EndHour": { "shape": "Hour", "documentation": "The hour when the time range ends.
" } }, "documentation": "The start day and time and the end day and time of the time range, in UTC.
" }, "InstanceEventWindowTimeRangeRequestSet": { "type": "list", "member": { "shape": "InstanceEventWindowTimeRangeRequest" } }, "InstanceExportDetails": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The ID of the resource being exported.
", "locationName": "instanceId" }, "TargetEnvironment": { "shape": "ExportEnvironment", "documentation": "The target virtualization environment.
", "locationName": "targetEnvironment" } }, "documentation": "Describes an instance to export.
" }, "InstanceFamilyCreditSpecification": { "type": "structure", "members": { "InstanceFamily": { "shape": "UnlimitedSupportedInstanceFamily", "documentation": "The instance family.
", "locationName": "instanceFamily" }, "CpuCredits": { "shape": "String", "documentation": "The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
Describes the default credit option for CPU usage of a burstable performance instance family.
" }, "InstanceGeneration": { "type": "string", "enum": [ "current", "previous" ] }, "InstanceGenerationSet": { "type": "list", "member": { "shape": "InstanceGeneration", "locationName": "item" } }, "InstanceHealthStatus": { "type": "string", "enum": [ "healthy", "unhealthy" ] }, "InstanceId": { "type": "string" }, "InstanceIdForResolver": { "type": "string" }, "InstanceIdList": { "type": "list", "member": { "shape": "InstanceId", "locationName": "item" } }, "InstanceIdSet": { "type": "list", "member": { "shape": "InstanceId", "locationName": "item" } }, "InstanceIdStringList": { "type": "list", "member": { "shape": "InstanceId", "locationName": "InstanceId" } }, "InstanceIdWithVolumeResolver": { "type": "string" }, "InstanceIdsSet": { "type": "list", "member": { "shape": "InstanceId", "locationName": "item" } }, "InstanceInterruptionBehavior": { "type": "string", "enum": [ "hibernate", "stop", "terminate" ] }, "InstanceIpv4Prefix": { "type": "structure", "members": { "Ipv4Prefix": { "shape": "String", "documentation": "One or more IPv4 prefixes assigned to the network interface.
", "locationName": "ipv4Prefix" } }, "documentation": "Information about an IPv4 prefix.
" }, "InstanceIpv4PrefixList": { "type": "list", "member": { "shape": "InstanceIpv4Prefix", "locationName": "item" } }, "InstanceIpv6Address": { "type": "structure", "members": { "Ipv6Address": { "shape": "String", "documentation": "The IPv6 address.
", "locationName": "ipv6Address" }, "IsPrimaryIpv6": { "shape": "Boolean", "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 RunInstances.
", "locationName": "isPrimaryIpv6" } }, "documentation": "Describes an IPv6 address.
" }, "InstanceIpv6AddressList": { "type": "list", "member": { "shape": "InstanceIpv6Address", "locationName": "item" } }, "InstanceIpv6AddressListRequest": { "type": "list", "member": { "shape": "InstanceIpv6AddressRequest", "locationName": "InstanceIpv6Address" } }, "InstanceIpv6AddressRequest": { "type": "structure", "members": { "Ipv6Address": { "shape": "String", "documentation": "The IPv6 address.
" } }, "documentation": "Describes an IPv6 address.
" }, "InstanceIpv6Prefix": { "type": "structure", "members": { "Ipv6Prefix": { "shape": "String", "documentation": "One or more IPv6 prefixes assigned to the network interface.
", "locationName": "ipv6Prefix" } }, "documentation": "Information about an IPv6 prefix.
" }, "InstanceIpv6PrefixList": { "type": "list", "member": { "shape": "InstanceIpv6Prefix", "locationName": "item" } }, "InstanceLifecycle": { "type": "string", "enum": [ "spot", "on-demand" ] }, "InstanceLifecycleType": { "type": "string", "enum": [ "spot", "scheduled", "capacity-block" ] }, "InstanceList": { "type": "list", "member": { "shape": "Instance", "locationName": "item" } }, "InstanceMaintenanceOptions": { "type": "structure", "members": { "AutoRecovery": { "shape": "InstanceAutoRecoveryState", "documentation": "Provides information on the current automatic recovery behavior of your instance.
", "locationName": "autoRecovery" } }, "documentation": "The maintenance options for the instance.
" }, "InstanceMaintenanceOptionsRequest": { "type": "structure", "members": { "AutoRecovery": { "shape": "InstanceAutoRecoveryState", "documentation": "Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.
" } }, "documentation": "The maintenance options for the instance.
" }, "InstanceMarketOptionsRequest": { "type": "structure", "members": { "MarketType": { "shape": "MarketType", "documentation": "The market type.
" }, "SpotOptions": { "shape": "SpotMarketOptions", "documentation": "The options for Spot Instances.
" } }, "documentation": "Describes the market (purchasing) option for the instances.
" }, "InstanceMatchCriteria": { "type": "string", "enum": [ "open", "targeted" ] }, "InstanceMetadataDefaultsResponse": { "type": "structure", "members": { "HttpTokens": { "shape": "HttpTokensState", "documentation": "Indicates whether IMDSv2 is required.
optional – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.
required – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
The maximum number of hops that the metadata token can travel.
", "locationName": "httpPutResponseHopLimit" }, "HttpEndpoint": { "shape": "InstanceMetadataEndpointState", "documentation": "Indicates whether the IMDS endpoint for an instance is enabled or disabled. When disabled, the instance metadata can't be accessed.
", "locationName": "httpEndpoint" }, "InstanceMetadataTags": { "shape": "InstanceMetadataTagsState", "documentation": "Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.
", "locationName": "instanceMetadataTags" } }, "documentation": "The default instance metadata service (IMDS) settings that were set at the account level in the specified Amazon Web Services Region.
" }, "InstanceMetadataEndpointState": { "type": "string", "enum": [ "disabled", "enabled" ] }, "InstanceMetadataOptionsRequest": { "type": "structure", "members": { "HttpTokens": { "shape": "HttpTokensState", "documentation": "Indicates whether IMDSv2 is required.
optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.
required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
Default:
If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.
If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.
The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
" }, "HttpPutResponseHopLimit": { "shape": "Integer", "documentation": "The maximum number of hops that the metadata token can travel.
Possible values: Integers from 1 to 64
" }, "HttpEndpoint": { "shape": "InstanceMetadataEndpointState", "documentation": "Enables or disables the HTTP metadata endpoint on your instances.
If you specify a value of disabled, you cannot access your instance metadata.
Default: enabled
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The metadata options for the instance.
" }, "InstanceMetadataOptionsResponse": { "type": "structure", "members": { "State": { "shape": "InstanceMetadataOptionsState", "documentation": "The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
Indicates whether IMDSv2 is required.
optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.
required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
The maximum number of hops that the metadata token can travel.
Possible values: Integers from 1 to 64
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
If the value is disabled, you cannot access your instance metadata.
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
Default: disabled
Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.
", "locationName": "instanceMetadataTags" } }, "documentation": "The metadata options for the instance.
" }, "InstanceMetadataOptionsState": { "type": "string", "enum": [ "pending", "applied" ] }, "InstanceMetadataProtocolState": { "type": "string", "enum": [ "disabled", "enabled" ] }, "InstanceMetadataTagsState": { "type": "string", "enum": [ "disabled", "enabled" ] }, "InstanceMonitoring": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "Monitoring": { "shape": "Monitoring", "documentation": "The monitoring for the instance.
", "locationName": "monitoring" } }, "documentation": "Describes the monitoring of an instance.
" }, "InstanceMonitoringList": { "type": "list", "member": { "shape": "InstanceMonitoring", "locationName": "item" } }, "InstanceNetworkInterface": { "type": "structure", "members": { "Association": { "shape": "InstanceNetworkInterfaceAssociation", "documentation": "The association information for an Elastic IPv4 associated with the network interface.
", "locationName": "association" }, "Attachment": { "shape": "InstanceNetworkInterfaceAttachment", "documentation": "The network interface attachment.
", "locationName": "attachment" }, "Description": { "shape": "String", "documentation": "The description.
", "locationName": "description" }, "Groups": { "shape": "GroupIdentifierList", "documentation": "The security groups.
", "locationName": "groupSet" }, "Ipv6Addresses": { "shape": "InstanceIpv6AddressList", "documentation": "The IPv6 addresses associated with the network interface.
", "locationName": "ipv6AddressesSet" }, "MacAddress": { "shape": "String", "documentation": "The MAC address.
", "locationName": "macAddress" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that created the network interface.
", "locationName": "ownerId" }, "PrivateDnsName": { "shape": "String", "documentation": "The private DNS name.
", "locationName": "privateDnsName" }, "PrivateIpAddress": { "shape": "String", "documentation": "The IPv4 address of the network interface within the subnet.
", "locationName": "privateIpAddress" }, "PrivateIpAddresses": { "shape": "InstancePrivateIpAddressList", "documentation": "The private IPv4 addresses associated with the network interface.
", "locationName": "privateIpAddressesSet" }, "SourceDestCheck": { "shape": "Boolean", "documentation": "Indicates whether source/destination checking is enabled.
", "locationName": "sourceDestCheck" }, "Status": { "shape": "NetworkInterfaceStatus", "documentation": "The status of the network interface.
", "locationName": "status" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "InterfaceType": { "shape": "String", "documentation": "The type of network interface.
Valid values: interface | efa | trunk
The IPv4 delegated prefixes that are assigned to the network interface.
", "locationName": "ipv4PrefixSet" }, "Ipv6Prefixes": { "shape": "InstanceIpv6PrefixList", "documentation": "The IPv6 delegated prefixes that are assigned to the network interface.
", "locationName": "ipv6PrefixSet" }, "ConnectionTrackingConfiguration": { "shape": "ConnectionTrackingSpecificationResponse", "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.
", "locationName": "connectionTrackingConfiguration" } }, "documentation": "Describes a network interface.
" }, "InstanceNetworkInterfaceAssociation": { "type": "structure", "members": { "CarrierIp": { "shape": "String", "documentation": "The carrier IP address associated with the network interface.
", "locationName": "carrierIp" }, "CustomerOwnedIp": { "shape": "String", "documentation": "The customer-owned IP address associated with the network interface.
", "locationName": "customerOwnedIp" }, "IpOwnerId": { "shape": "String", "documentation": "The ID of the owner of the Elastic IP address.
", "locationName": "ipOwnerId" }, "PublicDnsName": { "shape": "String", "documentation": "The public DNS name.
", "locationName": "publicDnsName" }, "PublicIp": { "shape": "String", "documentation": "The public IP address or Elastic IP address bound to the network interface.
", "locationName": "publicIp" } }, "documentation": "Describes association information for an Elastic IP address (IPv4).
" }, "InstanceNetworkInterfaceAttachment": { "type": "structure", "members": { "AttachTime": { "shape": "DateTime", "documentation": "The time stamp when the attachment initiated.
", "locationName": "attachTime" }, "AttachmentId": { "shape": "String", "documentation": "The ID of the network interface attachment.
", "locationName": "attachmentId" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the network interface is deleted when the instance is terminated.
", "locationName": "deleteOnTermination" }, "DeviceIndex": { "shape": "Integer", "documentation": "The index of the device on the instance for the network interface attachment.
", "locationName": "deviceIndex" }, "Status": { "shape": "AttachmentStatus", "documentation": "The attachment state.
", "locationName": "status" }, "NetworkCardIndex": { "shape": "Integer", "documentation": "The index of the network card.
", "locationName": "networkCardIndex" }, "EnaSrdSpecification": { "shape": "InstanceAttachmentEnaSrdSpecification", "documentation": "Contains the ENA Express settings for the network interface that's attached to the instance.
", "locationName": "enaSrdSpecification" } }, "documentation": "Describes a network interface attachment.
" }, "InstanceNetworkInterfaceList": { "type": "list", "member": { "shape": "InstanceNetworkInterface", "locationName": "item" } }, "InstanceNetworkInterfaceSpecification": { "type": "structure", "members": { "AssociatePublicIpAddress": { "shape": "Boolean", "documentation": "Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
", "locationName": "associatePublicIpAddress" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
The description of the network interface. Applies only if creating a network interface when launching an instance.
", "locationName": "description" }, "DeviceIndex": { "shape": "Integer", "documentation": "The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
", "locationName": "deviceIndex" }, "Groups": { "shape": "SecurityGroupIdStringList", "documentation": "The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
", "locationName": "SecurityGroupId" }, "Ipv6AddressCount": { "shape": "Integer", "documentation": "A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
", "locationName": "ipv6AddressCount" }, "Ipv6Addresses": { "shape": "InstanceIpv6AddressList", "documentation": "The IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
", "locationName": "ipv6AddressesSet", "queryName": "Ipv6Addresses" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
", "locationName": "networkInterfaceId" }, "PrivateIpAddress": { "shape": "String", "documentation": "The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", "locationName": "privateIpAddress" }, "PrivateIpAddresses": { "shape": "PrivateIpAddressSpecificationList", "documentation": "The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", "locationName": "privateIpAddressesSet", "queryName": "PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount": { "shape": "Integer", "documentation": "The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", "locationName": "secondaryPrivateIpAddressCount" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
", "locationName": "subnetId" }, "AssociateCarrierIpAddress": { "shape": "Boolean", "documentation": "Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer Guide.
" }, "InterfaceType": { "shape": "String", "documentation": "The type of network interface.
Valid values: interface | efa
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
" }, "Ipv4Prefixes": { "shape": "Ipv4PrefixList", "documentation": "The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
The primary IPv6 address of the network interface. 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 about primary IPv6 addresses, see RunInstances.
" }, "EnaSrdSpecification": { "shape": "EnaSrdSpecificationRequest", "documentation": "Specifies the ENA Express settings for the network interface that's attached to the instance.
" }, "ConnectionTrackingSpecification": { "shape": "ConnectionTrackingSpecificationRequest", "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.
" } }, "documentation": "Describes a network interface.
" }, "InstanceNetworkInterfaceSpecificationList": { "type": "list", "member": { "shape": "InstanceNetworkInterfaceSpecification", "locationName": "item" } }, "InstancePrivateIpAddress": { "type": "structure", "members": { "Association": { "shape": "InstanceNetworkInterfaceAssociation", "documentation": "The association information for an Elastic IP address for the network interface.
", "locationName": "association" }, "Primary": { "shape": "Boolean", "documentation": "Indicates whether this IPv4 address is the primary private IP address of the network interface.
", "locationName": "primary" }, "PrivateDnsName": { "shape": "String", "documentation": "The private IPv4 DNS name.
", "locationName": "privateDnsName" }, "PrivateIpAddress": { "shape": "String", "documentation": "The private IPv4 address of the network interface.
", "locationName": "privateIpAddress" } }, "documentation": "Describes a private IPv4 address.
" }, "InstancePrivateIpAddressList": { "type": "list", "member": { "shape": "InstancePrivateIpAddress", "locationName": "item" } }, "InstanceRequirements": { "type": "structure", "members": { "VCpuCount": { "shape": "VCpuCountRange", "documentation": "The minimum and maximum number of vCPUs.
", "locationName": "vCpuCount" }, "MemoryMiB": { "shape": "MemoryMiB", "documentation": "The minimum and maximum amount of memory, in MiB.
", "locationName": "memoryMiB" }, "CpuManufacturers": { "shape": "CpuManufacturerSet", "documentation": "The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
", "locationName": "cpuManufacturerSet" }, "MemoryGiBPerVCpu": { "shape": "MemoryGiBPerVCpu", "documentation": "The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
", "locationName": "memoryGiBPerVCpu" }, "ExcludedInstanceTypes": { "shape": "ExcludedInstanceTypeSet", "documentation": "The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.
Default: No excluded instance types
", "locationName": "excludedInstanceTypeSet" }, "InstanceGenerations": { "shape": "InstanceGenerationSet", "documentation": "Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
", "locationName": "instanceGenerationSet" }, "SpotMaxPricePercentageOverLowestPrice": { "shape": "Integer", "documentation": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
Default: 100
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
", "locationName": "networkInterfaceCount" }, "LocalStorage": { "shape": "LocalStorage", "documentation": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: hdd and ssd
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
", "locationName": "totalLocalStorageGB" }, "BaselineEbsBandwidthMbps": { "shape": "BaselineEbsBandwidthMbps", "documentation": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
", "locationName": "baselineEbsBandwidthMbps" }, "AcceleratorTypes": { "shape": "AcceleratorTypeSet", "documentation": "The accelerator types that must be on the instance type.
For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
", "locationName": "acceleratorTypeSet" }, "AcceleratorCount": { "shape": "AcceleratorCount", "documentation": "The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
", "locationName": "acceleratorCount" }, "AcceleratorManufacturers": { "shape": "AcceleratorManufacturerSet", "documentation": "Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with AMD devices, specify amd.
For instance types with Habana devices, specify habana.
For instance types with NVIDIA devices, specify nvidia.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
", "locationName": "acceleratorManufacturerSet" }, "AcceleratorNames": { "shape": "AcceleratorNameSet", "documentation": "The accelerators that must be on the instance type.
For instance types with NVIDIA A10G GPUs, specify a10g.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA H100 GPUs, specify h100.
For instance types with Amazon Web Services Inferentia chips, specify inferentia.
For instance types with NVIDIA GRID K520 GPUs, specify k520.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA T4G GPUs, specify t4g.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
For instance types with NVIDIA V100 GPUs, specify v100.
Default: Any accelerator
", "locationName": "acceleratorNameSet" }, "AcceleratorTotalMemoryMiB": { "shape": "AcceleratorTotalMemoryMiB", "documentation": "The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
", "locationName": "acceleratorTotalMemoryMiB" }, "NetworkBandwidthGbps": { "shape": "NetworkBandwidthGbps", "documentation": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
", "locationName": "networkBandwidthGbps" }, "AllowedInstanceTypes": { "shape": "AllowedInstanceTypeSet", "documentation": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.
Default: All instance types
", "locationName": "allowedInstanceTypeSet" }, "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "shape": "Integer", "documentation": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can't specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard or with the RunInstances API, you can't specify InstanceRequirements.
For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide, and also Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
" }, "InstanceRequirementsRequest": { "type": "structure", "required": [ "VCpuCount", "MemoryMiB" ], "members": { "VCpuCount": { "shape": "VCpuCountRangeRequest", "documentation": "The minimum and maximum number of vCPUs.
" }, "MemoryMiB": { "shape": "MemoryMiBRequest", "documentation": "The minimum and maximum amount of memory, in MiB.
" }, "CpuManufacturers": { "shape": "CpuManufacturerSet", "documentation": "The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
", "locationName": "CpuManufacturer" }, "MemoryGiBPerVCpu": { "shape": "MemoryGiBPerVCpuRequest", "documentation": "The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
" }, "ExcludedInstanceTypes": { "shape": "ExcludedInstanceTypeSet", "documentation": "The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.
Default: No excluded instance types
", "locationName": "ExcludedInstanceType" }, "InstanceGenerations": { "shape": "InstanceGenerationSet", "documentation": "Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
", "locationName": "InstanceGeneration" }, "SpotMaxPricePercentageOverLowestPrice": { "shape": "Integer", "documentation": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
Default: 100
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To indicate no price protection threshold, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
" }, "LocalStorage": { "shape": "LocalStorage", "documentation": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: hdd and ssd
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
" }, "BaselineEbsBandwidthMbps": { "shape": "BaselineEbsBandwidthMbpsRequest", "documentation": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
" }, "AcceleratorTypes": { "shape": "AcceleratorTypeSet", "documentation": "The accelerator types that must be on the instance type.
To include instance types with GPU hardware, specify gpu.
To include instance types with FPGA hardware, specify fpga.
To include instance types with inference hardware, specify inference.
Default: Any accelerator type
", "locationName": "AcceleratorType" }, "AcceleratorCount": { "shape": "AcceleratorCountRequest", "documentation": "The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
" }, "AcceleratorManufacturers": { "shape": "AcceleratorManufacturerSet", "documentation": "Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with AMD devices, specify amd.
For instance types with Habana devices, specify habana.
For instance types with NVIDIA devices, specify nvidia.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
", "locationName": "AcceleratorManufacturer" }, "AcceleratorNames": { "shape": "AcceleratorNameSet", "documentation": "The accelerators that must be on the instance type.
For instance types with NVIDIA A10G GPUs, specify a10g.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA H100 GPUs, specify h100.
For instance types with Amazon Web Services Inferentia chips, specify inferentia.
For instance types with NVIDIA GRID K520 GPUs, specify k520.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA T4G GPUs, specify t4g.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
For instance types with NVIDIA V100 GPUs, specify v100.
Default: Any accelerator
", "locationName": "AcceleratorName" }, "AcceleratorTotalMemoryMiB": { "shape": "AcceleratorTotalMemoryMiBRequest", "documentation": "The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
" }, "NetworkBandwidthGbps": { "shape": "NetworkBandwidthGbpsRequest", "documentation": "The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
" }, "AllowedInstanceTypes": { "shape": "AllowedInstanceTypeSet", "documentation": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.
Default: All instance types
", "locationName": "AllowedInstanceType" }, "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "shape": "Integer", "documentation": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can't specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
" }, "InstanceRequirementsWithMetadataRequest": { "type": "structure", "members": { "ArchitectureTypes": { "shape": "ArchitectureTypeSet", "documentation": "The architecture type.
", "locationName": "ArchitectureType" }, "VirtualizationTypes": { "shape": "VirtualizationTypeSet", "documentation": "The virtualization type.
", "locationName": "VirtualizationType" }, "InstanceRequirements": { "shape": "InstanceRequirementsRequest", "documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
" } }, "documentation": "The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadataRequest, you can't specify InstanceTypes.
The instance to specify which volumes should be snapshotted.
" }, "ExcludeBootVolume": { "shape": "Boolean", "documentation": "Excludes the root volume from being snapshotted.
" }, "ExcludeDataVolumeIds": { "shape": "VolumeIdStringList", "documentation": "The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. If you specify the ID of the root volume, the request fails. To exclude the root volume, use ExcludeBootVolume.
You can specify up to 40 volume IDs per request.
", "locationName": "ExcludeDataVolumeId" } }, "documentation": "The instance details to specify which volumes should be snapshotted.
" }, "InstanceState": { "type": "structure", "members": { "Code": { "shape": "Integer", "documentation": "The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
", "locationName": "code" }, "Name": { "shape": "InstanceStateName", "documentation": "The current state of the instance.
", "locationName": "name" } }, "documentation": "Describes the current state of an instance.
" }, "InstanceStateChange": { "type": "structure", "members": { "CurrentState": { "shape": "InstanceState", "documentation": "The current state of the instance.
", "locationName": "currentState" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "PreviousState": { "shape": "InstanceState", "documentation": "The previous state of the instance.
", "locationName": "previousState" } }, "documentation": "Describes an instance state change.
" }, "InstanceStateChangeList": { "type": "list", "member": { "shape": "InstanceStateChange", "locationName": "item" } }, "InstanceStateName": { "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone of the instance.
", "locationName": "availabilityZone" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", "locationName": "outpostArn" }, "Events": { "shape": "InstanceStatusEventList", "documentation": "Any scheduled events associated with the instance.
", "locationName": "eventsSet" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "InstanceState": { "shape": "InstanceState", "documentation": "The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
", "locationName": "instanceStatus" }, "SystemStatus": { "shape": "InstanceStatusSummary", "documentation": "Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
", "locationName": "systemStatus" } }, "documentation": "Describes the status of an instance.
" }, "InstanceStatusDetails": { "type": "structure", "members": { "ImpairedSince": { "shape": "DateTime", "documentation": "The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
", "locationName": "impairedSince" }, "Name": { "shape": "StatusName", "documentation": "The type of instance status.
", "locationName": "name" }, "Status": { "shape": "StatusType", "documentation": "The status.
", "locationName": "status" } }, "documentation": "Describes the instance status.
" }, "InstanceStatusDetailsList": { "type": "list", "member": { "shape": "InstanceStatusDetails", "locationName": "item" } }, "InstanceStatusEvent": { "type": "structure", "members": { "InstanceEventId": { "shape": "InstanceEventId", "documentation": "The ID of the event.
", "locationName": "instanceEventId" }, "Code": { "shape": "EventCode", "documentation": "The event code.
", "locationName": "code" }, "Description": { "shape": "String", "documentation": "A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
", "locationName": "description" }, "NotAfter": { "shape": "DateTime", "documentation": "The latest scheduled end time for the event.
", "locationName": "notAfter" }, "NotBefore": { "shape": "DateTime", "documentation": "The earliest scheduled start time for the event.
", "locationName": "notBefore" }, "NotBeforeDeadline": { "shape": "DateTime", "documentation": "The deadline for starting the event.
", "locationName": "notBeforeDeadline" } }, "documentation": "Describes a scheduled event for an instance.
" }, "InstanceStatusEventList": { "type": "list", "member": { "shape": "InstanceStatusEvent", "locationName": "item" } }, "InstanceStatusList": { "type": "list", "member": { "shape": "InstanceStatus", "locationName": "item" } }, "InstanceStatusSummary": { "type": "structure", "members": { "Details": { "shape": "InstanceStatusDetailsList", "documentation": "The system instance health or application instance health.
", "locationName": "details" }, "Status": { "shape": "SummaryStatus", "documentation": "The status.
", "locationName": "status" } }, "documentation": "Describes the status of an instance.
" }, "InstanceStorageEncryptionSupport": { "type": "string", "enum": [ "unsupported", "required" ] }, "InstanceStorageFlag": { "type": "boolean" }, "InstanceStorageInfo": { "type": "structure", "members": { "TotalSizeInGB": { "shape": "DiskSize", "documentation": "The total size of the disks, in GB.
", "locationName": "totalSizeInGB" }, "Disks": { "shape": "DiskInfoList", "documentation": "Describes the disks that are available for the instance type.
", "locationName": "disks" }, "NvmeSupport": { "shape": "EphemeralNvmeSupport", "documentation": "Indicates whether non-volatile memory express (NVMe) is supported.
", "locationName": "nvmeSupport" }, "EncryptionSupport": { "shape": "InstanceStorageEncryptionSupport", "documentation": "Indicates whether data is encrypted at rest.
", "locationName": "encryptionSupport" } }, "documentation": "Describes the instance store features that are supported by the instance type.
" }, "InstanceTagKeySet": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "InstanceTagNotificationAttribute": { "type": "structure", "members": { "InstanceTagKeys": { "shape": "InstanceTagKeySet", "documentation": "The registered tag keys.
", "locationName": "instanceTagKeySet" }, "IncludeAllTagsOfInstance": { "shape": "Boolean", "documentation": "Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.
Describes the registered tag keys for the current Region.
" }, "InstanceTopology": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The instance ID.
", "locationName": "instanceId" }, "InstanceType": { "shape": "String", "documentation": "The instance type.
", "locationName": "instanceType" }, "GroupName": { "shape": "String", "documentation": "The name of the placement group that the instance is in.
", "locationName": "groupName" }, "NetworkNodes": { "shape": "NetworkNodesList", "documentation": "The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings.
", "locationName": "networkNodeSet" }, "AvailabilityZone": { "shape": "String", "documentation": "The name of the Availability Zone or Local Zone that the instance is in.
", "locationName": "availabilityZone" }, "ZoneId": { "shape": "String", "documentation": "The ID of the Availability Zone or Local Zone that the instance is in.
", "locationName": "zoneId" } }, "documentation": "Information about the instance topology.
" }, "InstanceType": { "type": "string", "enum": [ "a1.medium", "a1.large", "a1.xlarge", "a1.2xlarge", "a1.4xlarge", "a1.metal", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5.metal", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "c5ad.large", "c5ad.xlarge", "c5ad.2xlarge", "c5ad.4xlarge", "c5ad.8xlarge", "c5ad.12xlarge", "c5ad.16xlarge", "c5ad.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c5d.metal", "c5n.large", "c5n.xlarge", "c5n.2xlarge", "c5n.4xlarge", "c5n.9xlarge", "c5n.18xlarge", "c5n.metal", "c6g.medium", "c6g.large", "c6g.xlarge", "c6g.2xlarge", "c6g.4xlarge", "c6g.8xlarge", "c6g.12xlarge", "c6g.16xlarge", "c6g.metal", "c6gd.medium", "c6gd.large", "c6gd.xlarge", "c6gd.2xlarge", "c6gd.4xlarge", "c6gd.8xlarge", "c6gd.12xlarge", "c6gd.16xlarge", "c6gd.metal", "c6gn.medium", "c6gn.large", "c6gn.xlarge", "c6gn.2xlarge", "c6gn.4xlarge", "c6gn.8xlarge", "c6gn.12xlarge", "c6gn.16xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "c6i.32xlarge", "c6i.metal", "cc1.4xlarge", "cc2.8xlarge", "cg1.4xlarge", "cr1.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "d3.xlarge", "d3.2xlarge", "d3.4xlarge", "d3.8xlarge", "d3en.xlarge", "d3en.2xlarge", "d3en.4xlarge", "d3en.6xlarge", "d3en.8xlarge", "d3en.12xlarge", "dl1.24xlarge", "f1.2xlarge", "f1.4xlarge", "f1.16xlarge", "g2.2xlarge", "g2.8xlarge", "g3.4xlarge", "g3.8xlarge", "g3.16xlarge", "g3s.xlarge", "g4ad.xlarge", "g4ad.2xlarge", "g4ad.4xlarge", "g4ad.8xlarge", "g4ad.16xlarge", "g4dn.xlarge", "g4dn.2xlarge", "g4dn.4xlarge", "g4dn.8xlarge", "g4dn.12xlarge", "g4dn.16xlarge", "g4dn.metal", "g5.xlarge", "g5.2xlarge", "g5.4xlarge", "g5.8xlarge", "g5.12xlarge", "g5.16xlarge", "g5.24xlarge", "g5.48xlarge", "g5g.xlarge", "g5g.2xlarge", "g5g.4xlarge", "g5g.8xlarge", "g5g.16xlarge", "g5g.metal", "hi1.4xlarge", "hpc6a.48xlarge", "hs1.8xlarge", "h1.2xlarge", "h1.4xlarge", "h1.8xlarge", "h1.16xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "i3.large", "i3.xlarge", "i3.2xlarge", "i3.4xlarge", "i3.8xlarge", "i3.16xlarge", "i3.metal", "i3en.large", "i3en.xlarge", "i3en.2xlarge", "i3en.3xlarge", "i3en.6xlarge", "i3en.12xlarge", "i3en.24xlarge", "i3en.metal", "im4gn.large", "im4gn.xlarge", "im4gn.2xlarge", "im4gn.4xlarge", "im4gn.8xlarge", "im4gn.16xlarge", "inf1.xlarge", "inf1.2xlarge", "inf1.6xlarge", "inf1.24xlarge", "is4gen.medium", "is4gen.large", "is4gen.xlarge", "is4gen.2xlarge", "is4gen.4xlarge", "is4gen.8xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5.metal", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "m5ad.large", "m5ad.xlarge", "m5ad.2xlarge", "m5ad.4xlarge", "m5ad.8xlarge", "m5ad.12xlarge", "m5ad.16xlarge", "m5ad.24xlarge", "m5d.large", "m5d.xlarge", "m5d.2xlarge", "m5d.4xlarge", "m5d.8xlarge", "m5d.12xlarge", "m5d.16xlarge", "m5d.24xlarge", "m5d.metal", "m5dn.large", "m5dn.xlarge", "m5dn.2xlarge", "m5dn.4xlarge", "m5dn.8xlarge", "m5dn.12xlarge", "m5dn.16xlarge", "m5dn.24xlarge", "m5dn.metal", "m5n.large", "m5n.xlarge", "m5n.2xlarge", "m5n.4xlarge", "m5n.8xlarge", "m5n.12xlarge", "m5n.16xlarge", "m5n.24xlarge", "m5n.metal", "m5zn.large", "m5zn.xlarge", "m5zn.2xlarge", "m5zn.3xlarge", "m5zn.6xlarge", "m5zn.12xlarge", "m5zn.metal", "m6a.large", "m6a.xlarge", "m6a.2xlarge", "m6a.4xlarge", "m6a.8xlarge", "m6a.12xlarge", "m6a.16xlarge", "m6a.24xlarge", "m6a.32xlarge", "m6a.48xlarge", "m6g.metal", "m6g.medium", "m6g.large", "m6g.xlarge", "m6g.2xlarge", "m6g.4xlarge", "m6g.8xlarge", "m6g.12xlarge", "m6g.16xlarge", "m6gd.metal", "m6gd.medium", "m6gd.large", "m6gd.xlarge", "m6gd.2xlarge", "m6gd.4xlarge", "m6gd.8xlarge", "m6gd.12xlarge", "m6gd.16xlarge", "m6i.large", "m6i.xlarge", "m6i.2xlarge", "m6i.4xlarge", "m6i.8xlarge", "m6i.12xlarge", "m6i.16xlarge", "m6i.24xlarge", "m6i.32xlarge", "m6i.metal", "mac1.metal", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "p3.2xlarge", "p3.8xlarge", "p3.16xlarge", "p3dn.24xlarge", "p4d.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5.metal", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "r5ad.large", "r5ad.xlarge", "r5ad.2xlarge", "r5ad.4xlarge", "r5ad.8xlarge", "r5ad.12xlarge", "r5ad.16xlarge", "r5ad.24xlarge", "r5b.large", "r5b.xlarge", "r5b.2xlarge", "r5b.4xlarge", "r5b.8xlarge", "r5b.12xlarge", "r5b.16xlarge", "r5b.24xlarge", "r5b.metal", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge", "r5d.metal", "r5dn.large", "r5dn.xlarge", "r5dn.2xlarge", "r5dn.4xlarge", "r5dn.8xlarge", "r5dn.12xlarge", "r5dn.16xlarge", "r5dn.24xlarge", "r5dn.metal", "r5n.large", "r5n.xlarge", "r5n.2xlarge", "r5n.4xlarge", "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", "r5n.24xlarge", "r5n.metal", "r6g.medium", "r6g.large", "r6g.xlarge", "r6g.2xlarge", "r6g.4xlarge", "r6g.8xlarge", "r6g.12xlarge", "r6g.16xlarge", "r6g.metal", "r6gd.medium", "r6gd.large", "r6gd.xlarge", "r6gd.2xlarge", "r6gd.4xlarge", "r6gd.8xlarge", "r6gd.12xlarge", "r6gd.16xlarge", "r6gd.metal", "r6i.large", "r6i.xlarge", "r6i.2xlarge", "r6i.4xlarge", "r6i.8xlarge", "r6i.12xlarge", "r6i.16xlarge", "r6i.24xlarge", "r6i.32xlarge", "r6i.metal", "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "t3.nano", "t3.micro", "t3.small", "t3.medium", "t3.large", "t3.xlarge", "t3.2xlarge", "t3a.nano", "t3a.micro", "t3a.small", "t3a.medium", "t3a.large", "t3a.xlarge", "t3a.2xlarge", "t4g.nano", "t4g.micro", "t4g.small", "t4g.medium", "t4g.large", "t4g.xlarge", "t4g.2xlarge", "u-6tb1.56xlarge", "u-6tb1.112xlarge", "u-9tb1.112xlarge", "u-12tb1.112xlarge", "u-6tb1.metal", "u-9tb1.metal", "u-12tb1.metal", "u-18tb1.metal", "u-24tb1.metal", "vt1.3xlarge", "vt1.6xlarge", "vt1.24xlarge", "x1.16xlarge", "x1.32xlarge", "x1e.xlarge", "x1e.2xlarge", "x1e.4xlarge", "x1e.8xlarge", "x1e.16xlarge", "x1e.32xlarge", "x2iezn.2xlarge", "x2iezn.4xlarge", "x2iezn.6xlarge", "x2iezn.8xlarge", "x2iezn.12xlarge", "x2iezn.metal", "x2gd.medium", "x2gd.large", "x2gd.xlarge", "x2gd.2xlarge", "x2gd.4xlarge", "x2gd.8xlarge", "x2gd.12xlarge", "x2gd.16xlarge", "x2gd.metal", "z1d.large", "z1d.xlarge", "z1d.2xlarge", "z1d.3xlarge", "z1d.6xlarge", "z1d.12xlarge", "z1d.metal", "x2idn.16xlarge", "x2idn.24xlarge", "x2idn.32xlarge", "x2iedn.xlarge", "x2iedn.2xlarge", "x2iedn.4xlarge", "x2iedn.8xlarge", "x2iedn.16xlarge", "x2iedn.24xlarge", "x2iedn.32xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6a.32xlarge", "c6a.48xlarge", "c6a.metal", "m6a.metal", "i4i.large", "i4i.xlarge", "i4i.2xlarge", "i4i.4xlarge", "i4i.8xlarge", "i4i.16xlarge", "i4i.32xlarge", "i4i.metal", "x2idn.metal", "x2iedn.metal", "c7g.medium", "c7g.large", "c7g.xlarge", "c7g.2xlarge", "c7g.4xlarge", "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", "mac2.metal", "c6id.large", "c6id.xlarge", "c6id.2xlarge", "c6id.4xlarge", "c6id.8xlarge", "c6id.12xlarge", "c6id.16xlarge", "c6id.24xlarge", "c6id.32xlarge", "c6id.metal", "m6id.large", "m6id.xlarge", "m6id.2xlarge", "m6id.4xlarge", "m6id.8xlarge", "m6id.12xlarge", "m6id.16xlarge", "m6id.24xlarge", "m6id.32xlarge", "m6id.metal", "r6id.large", "r6id.xlarge", "r6id.2xlarge", "r6id.4xlarge", "r6id.8xlarge", "r6id.12xlarge", "r6id.16xlarge", "r6id.24xlarge", "r6id.32xlarge", "r6id.metal", "r6a.large", "r6a.xlarge", "r6a.2xlarge", "r6a.4xlarge", "r6a.8xlarge", "r6a.12xlarge", "r6a.16xlarge", "r6a.24xlarge", "r6a.32xlarge", "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", "u-3tb1.56xlarge", "u-18tb1.112xlarge", "u-24tb1.112xlarge", "trn1.2xlarge", "trn1.32xlarge", "hpc6id.32xlarge", "c6in.large", "c6in.xlarge", "c6in.2xlarge", "c6in.4xlarge", "c6in.8xlarge", "c6in.12xlarge", "c6in.16xlarge", "c6in.24xlarge", "c6in.32xlarge", "m6in.large", "m6in.xlarge", "m6in.2xlarge", "m6in.4xlarge", "m6in.8xlarge", "m6in.12xlarge", "m6in.16xlarge", "m6in.24xlarge", "m6in.32xlarge", "m6idn.large", "m6idn.xlarge", "m6idn.2xlarge", "m6idn.4xlarge", "m6idn.8xlarge", "m6idn.12xlarge", "m6idn.16xlarge", "m6idn.24xlarge", "m6idn.32xlarge", "r6in.large", "r6in.xlarge", "r6in.2xlarge", "r6in.4xlarge", "r6in.8xlarge", "r6in.12xlarge", "r6in.16xlarge", "r6in.24xlarge", "r6in.32xlarge", "r6idn.large", "r6idn.xlarge", "r6idn.2xlarge", "r6idn.4xlarge", "r6idn.8xlarge", "r6idn.12xlarge", "r6idn.16xlarge", "r6idn.24xlarge", "r6idn.32xlarge", "c7g.metal", "m7g.medium", "m7g.large", "m7g.xlarge", "m7g.2xlarge", "m7g.4xlarge", "m7g.8xlarge", "m7g.12xlarge", "m7g.16xlarge", "m7g.metal", "r7g.medium", "r7g.large", "r7g.xlarge", "r7g.2xlarge", "r7g.4xlarge", "r7g.8xlarge", "r7g.12xlarge", "r7g.16xlarge", "r7g.metal", "c6in.metal", "m6in.metal", "m6idn.metal", "r6in.metal", "r6idn.metal", "inf2.xlarge", "inf2.8xlarge", "inf2.24xlarge", "inf2.48xlarge", "trn1n.32xlarge", "i4g.large", "i4g.xlarge", "i4g.2xlarge", "i4g.4xlarge", "i4g.8xlarge", "i4g.16xlarge", "hpc7g.4xlarge", "hpc7g.8xlarge", "hpc7g.16xlarge", "c7gn.medium", "c7gn.large", "c7gn.xlarge", "c7gn.2xlarge", "c7gn.4xlarge", "c7gn.8xlarge", "c7gn.12xlarge", "c7gn.16xlarge", "p5.48xlarge", "m7i.large", "m7i.xlarge", "m7i.2xlarge", "m7i.4xlarge", "m7i.8xlarge", "m7i.12xlarge", "m7i.16xlarge", "m7i.24xlarge", "m7i.48xlarge", "m7i-flex.large", "m7i-flex.xlarge", "m7i-flex.2xlarge", "m7i-flex.4xlarge", "m7i-flex.8xlarge", "m7a.medium", "m7a.large", "m7a.xlarge", "m7a.2xlarge", "m7a.4xlarge", "m7a.8xlarge", "m7a.12xlarge", "m7a.16xlarge", "m7a.24xlarge", "m7a.32xlarge", "m7a.48xlarge", "m7a.metal-48xl", "hpc7a.12xlarge", "hpc7a.24xlarge", "hpc7a.48xlarge", "hpc7a.96xlarge", "c7gd.medium", "c7gd.large", "c7gd.xlarge", "c7gd.2xlarge", "c7gd.4xlarge", "c7gd.8xlarge", "c7gd.12xlarge", "c7gd.16xlarge", "m7gd.medium", "m7gd.large", "m7gd.xlarge", "m7gd.2xlarge", "m7gd.4xlarge", "m7gd.8xlarge", "m7gd.12xlarge", "m7gd.16xlarge", "r7gd.medium", "r7gd.large", "r7gd.xlarge", "r7gd.2xlarge", "r7gd.4xlarge", "r7gd.8xlarge", "r7gd.12xlarge", "r7gd.16xlarge", "r7a.medium", "r7a.large", "r7a.xlarge", "r7a.2xlarge", "r7a.4xlarge", "r7a.8xlarge", "r7a.12xlarge", "r7a.16xlarge", "r7a.24xlarge", "r7a.32xlarge", "r7a.48xlarge", "c7i.large", "c7i.xlarge", "c7i.2xlarge", "c7i.4xlarge", "c7i.8xlarge", "c7i.12xlarge", "c7i.16xlarge", "c7i.24xlarge", "c7i.48xlarge", "mac2-m2pro.metal", "r7iz.large", "r7iz.xlarge", "r7iz.2xlarge", "r7iz.4xlarge", "r7iz.8xlarge", "r7iz.12xlarge", "r7iz.16xlarge", "r7iz.32xlarge", "c7a.medium", "c7a.large", "c7a.xlarge", "c7a.2xlarge", "c7a.4xlarge", "c7a.8xlarge", "c7a.12xlarge", "c7a.16xlarge", "c7a.24xlarge", "c7a.32xlarge", "c7a.48xlarge", "c7a.metal-48xl", "r7a.metal-48xl", "r7i.large", "r7i.xlarge", "r7i.2xlarge", "r7i.4xlarge", "r7i.8xlarge", "r7i.12xlarge", "r7i.16xlarge", "r7i.24xlarge", "r7i.48xlarge", "dl2q.24xlarge", "mac2-m2.metal", "i4i.12xlarge", "i4i.24xlarge", "c7i.metal-24xl", "c7i.metal-48xl", "m7i.metal-24xl", "m7i.metal-48xl", "r7i.metal-24xl", "r7i.metal-48xl", "r7iz.metal-16xl", "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", "r7gd.metal", "g6.xlarge", "g6.2xlarge", "g6.4xlarge", "g6.8xlarge", "g6.12xlarge", "g6.16xlarge", "g6.24xlarge", "g6.48xlarge", "gr6.4xlarge", "gr6.8xlarge" ] }, "InstanceTypeHypervisor": { "type": "string", "enum": [ "nitro", "xen" ] }, "InstanceTypeInfo": { "type": "structure", "members": { "InstanceType": { "shape": "InstanceType", "documentation": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", "locationName": "instanceType" }, "CurrentGeneration": { "shape": "CurrentGenerationFlag", "documentation": "Indicates whether the instance type is current generation.
", "locationName": "currentGeneration" }, "FreeTierEligible": { "shape": "FreeTierEligibleFlag", "documentation": "Indicates whether the instance type is eligible for the free tier.
", "locationName": "freeTierEligible" }, "SupportedUsageClasses": { "shape": "UsageClassTypeList", "documentation": "Indicates whether the instance type is offered for spot or On-Demand.
", "locationName": "supportedUsageClasses" }, "SupportedRootDeviceTypes": { "shape": "RootDeviceTypeList", "documentation": "The supported root device types.
", "locationName": "supportedRootDeviceTypes" }, "SupportedVirtualizationTypes": { "shape": "VirtualizationTypeList", "documentation": "The supported virtualization types.
", "locationName": "supportedVirtualizationTypes" }, "BareMetal": { "shape": "BareMetalFlag", "documentation": "Indicates whether the instance is a bare metal instance type.
", "locationName": "bareMetal" }, "Hypervisor": { "shape": "InstanceTypeHypervisor", "documentation": "The hypervisor for the instance type.
", "locationName": "hypervisor" }, "ProcessorInfo": { "shape": "ProcessorInfo", "documentation": "Describes the processor.
", "locationName": "processorInfo" }, "VCpuInfo": { "shape": "VCpuInfo", "documentation": "Describes the vCPU configurations for the instance type.
", "locationName": "vCpuInfo" }, "MemoryInfo": { "shape": "MemoryInfo", "documentation": "Describes the memory for the instance type.
", "locationName": "memoryInfo" }, "InstanceStorageSupported": { "shape": "InstanceStorageFlag", "documentation": "Indicates whether instance storage is supported.
", "locationName": "instanceStorageSupported" }, "InstanceStorageInfo": { "shape": "InstanceStorageInfo", "documentation": "Describes the instance storage for the instance type.
", "locationName": "instanceStorageInfo" }, "EbsInfo": { "shape": "EbsInfo", "documentation": "Describes the Amazon EBS settings for the instance type.
", "locationName": "ebsInfo" }, "NetworkInfo": { "shape": "NetworkInfo", "documentation": "Describes the network settings for the instance type.
", "locationName": "networkInfo" }, "GpuInfo": { "shape": "GpuInfo", "documentation": "Describes the GPU accelerator settings for the instance type.
", "locationName": "gpuInfo" }, "FpgaInfo": { "shape": "FpgaInfo", "documentation": "Describes the FPGA accelerator settings for the instance type.
", "locationName": "fpgaInfo" }, "PlacementGroupInfo": { "shape": "PlacementGroupInfo", "documentation": "Describes the placement group settings for the instance type.
", "locationName": "placementGroupInfo" }, "InferenceAcceleratorInfo": { "shape": "InferenceAcceleratorInfo", "documentation": "Describes the Inference accelerator settings for the instance type.
", "locationName": "inferenceAcceleratorInfo" }, "HibernationSupported": { "shape": "HibernationFlag", "documentation": "Indicates whether On-Demand hibernation is supported.
", "locationName": "hibernationSupported" }, "BurstablePerformanceSupported": { "shape": "BurstablePerformanceFlag", "documentation": "Indicates whether the instance type is a burstable performance T instance type. For more information, see Burstable performance instances.
", "locationName": "burstablePerformanceSupported" }, "DedicatedHostsSupported": { "shape": "DedicatedHostFlag", "documentation": "Indicates whether Dedicated Hosts are supported on the instance type.
", "locationName": "dedicatedHostsSupported" }, "AutoRecoverySupported": { "shape": "AutoRecoveryFlag", "documentation": "Indicates whether Amazon CloudWatch action based recovery is supported.
", "locationName": "autoRecoverySupported" }, "SupportedBootModes": { "shape": "BootModeTypeList", "documentation": "The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.
", "locationName": "supportedBootModes" }, "NitroEnclavesSupport": { "shape": "NitroEnclavesSupport", "documentation": "Indicates whether Nitro Enclaves is supported.
", "locationName": "nitroEnclavesSupport" }, "NitroTpmSupport": { "shape": "NitroTpmSupport", "documentation": "Indicates whether NitroTPM is supported.
", "locationName": "nitroTpmSupport" }, "NitroTpmInfo": { "shape": "NitroTpmInfo", "documentation": "Describes the supported NitroTPM versions for the instance type.
", "locationName": "nitroTpmInfo" }, "MediaAcceleratorInfo": { "shape": "MediaAcceleratorInfo", "documentation": "Describes the media accelerator settings for the instance type.
", "locationName": "mediaAcceleratorInfo" }, "NeuronInfo": { "shape": "NeuronInfo", "documentation": "Describes the Neuron accelerator settings for the instance type.
", "locationName": "neuronInfo" } }, "documentation": "Describes the instance type.
" }, "InstanceTypeInfoFromInstanceRequirements": { "type": "structure", "members": { "InstanceType": { "shape": "String", "documentation": "The matching instance type.
", "locationName": "instanceType" } }, "documentation": "The list of instance types with the specified instance attributes.
" }, "InstanceTypeInfoFromInstanceRequirementsSet": { "type": "list", "member": { "shape": "InstanceTypeInfoFromInstanceRequirements", "locationName": "item" } }, "InstanceTypeInfoList": { "type": "list", "member": { "shape": "InstanceTypeInfo", "locationName": "item" } }, "InstanceTypeList": { "type": "list", "member": { "shape": "InstanceType" } }, "InstanceTypeOffering": { "type": "structure", "members": { "InstanceType": { "shape": "InstanceType", "documentation": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", "locationName": "instanceType" }, "LocationType": { "shape": "LocationType", "documentation": "The location type.
", "locationName": "locationType" }, "Location": { "shape": "Location", "documentation": "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 instance types offered.
" }, "InstanceTypeOfferingsList": { "type": "list", "member": { "shape": "InstanceTypeOffering", "locationName": "item" } }, "InstanceTypes": { "type": "list", "member": { "shape": "String" }, "max": 1000, "min": 0 }, "InstanceTypesList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "InstanceUsage": { "type": "structure", "members": { "AccountId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
", "locationName": "accountId" }, "UsedInstanceCount": { "shape": "Integer", "documentation": "The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
", "locationName": "usedInstanceCount" } }, "documentation": "Information about the Capacity Reservation usage.
" }, "InstanceUsageSet": { "type": "list", "member": { "shape": "InstanceUsage", "locationName": "item" } }, "Integer": { "type": "integer" }, "IntegerWithConstraints": { "type": "integer", "min": 0 }, "IntegrateServices": { "type": "structure", "members": { "AthenaIntegrations": { "shape": "AthenaIntegrationsSet", "documentation": "Information about the integration with Amazon Athena.
", "locationName": "AthenaIntegration" } }, "documentation": "Describes service integrations with VPC Flow logs.
" }, "InterfacePermissionType": { "type": "string", "enum": [ "INSTANCE-ATTACH", "EIP-ASSOCIATE" ] }, "InterfaceProtocolType": { "type": "string", "enum": [ "VLAN", "GRE" ] }, "InternetGateway": { "type": "structure", "members": { "Attachments": { "shape": "InternetGatewayAttachmentList", "documentation": "Any VPCs attached to the internet gateway.
", "locationName": "attachmentSet" }, "InternetGatewayId": { "shape": "String", "documentation": "The ID of the internet gateway.
", "locationName": "internetGatewayId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the internet gateway.
", "locationName": "ownerId" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the internet gateway.
", "locationName": "tagSet" } }, "documentation": "Describes an internet gateway.
" }, "InternetGatewayAttachment": { "type": "structure", "members": { "State": { "shape": "AttachmentStatus", "documentation": "The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
The ID of the VPC.
", "locationName": "vpcId" } }, "documentation": "Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
" }, "InternetGatewayAttachmentList": { "type": "list", "member": { "shape": "InternetGatewayAttachment", "locationName": "item" } }, "InternetGatewayId": { "type": "string" }, "InternetGatewayIdList": { "type": "list", "member": { "shape": "InternetGatewayId", "locationName": "item" } }, "InternetGatewayList": { "type": "list", "member": { "shape": "InternetGateway", "locationName": "item" } }, "IpAddress": { "type": "string", "max": 15, "min": 0, "pattern": "^([0-9]{1,3}.){3}[0-9]{1,3}$" }, "IpAddressList": { "type": "list", "member": { "shape": "IpAddress", "locationName": "item" } }, "IpAddressType": { "type": "string", "enum": [ "ipv4", "dualstack", "ipv6" ] }, "IpList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "IpPermission": { "type": "structure", "members": { "FromPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
", "locationName": "fromPort" }, "IpProtocol": { "shape": "String", "documentation": "The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
The IPv4 address ranges.
", "locationName": "ipRanges" }, "Ipv6Ranges": { "shape": "Ipv6RangeList", "documentation": "The IPv6 address ranges.
", "locationName": "ipv6Ranges" }, "PrefixListIds": { "shape": "PrefixListIdList", "documentation": "The prefix list IDs.
", "locationName": "prefixListIds" }, "ToPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
", "locationName": "toPort" }, "UserIdGroupPairs": { "shape": "UserIdGroupPairList", "documentation": "The security group and Amazon Web Services account ID pairs.
", "locationName": "groups" } }, "documentation": "Describes the permissions for a security group rule.
" }, "IpPermissionList": { "type": "list", "member": { "shape": "IpPermission", "locationName": "item" } }, "IpPrefixList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "IpRange": { "type": "structure", "members": { "CidrIp": { "shape": "String", "documentation": "The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
", "locationName": "cidrIp" }, "Description": { "shape": "String", "documentation": "A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", "locationName": "description" } }, "documentation": "Describes an IPv4 address range.
" }, "IpRangeList": { "type": "list", "member": { "shape": "IpRange", "locationName": "item" } }, "IpRanges": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "Ipam": { "type": "structure", "members": { "OwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID of the owner of the IPAM.
", "locationName": "ownerId" }, "IpamId": { "shape": "IpamId", "documentation": "The ID of the IPAM.
", "locationName": "ipamId" }, "IpamArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the IPAM.
", "locationName": "ipamArn" }, "IpamRegion": { "shape": "String", "documentation": "The Amazon Web Services Region of the IPAM.
", "locationName": "ipamRegion" }, "PublicDefaultScopeId": { "shape": "IpamScopeId", "documentation": "The ID of the IPAM's default public scope.
", "locationName": "publicDefaultScopeId" }, "PrivateDefaultScopeId": { "shape": "IpamScopeId", "documentation": "The ID of the IPAM's default private scope.
", "locationName": "privateDefaultScopeId" }, "ScopeCount": { "shape": "Integer", "documentation": "The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
", "locationName": "scopeCount" }, "Description": { "shape": "String", "documentation": "The description for the IPAM.
", "locationName": "description" }, "OperatingRegions": { "shape": "IpamOperatingRegionSet", "documentation": "The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
", "locationName": "operatingRegionSet" }, "State": { "shape": "IpamState", "documentation": "The state of the IPAM.
", "locationName": "state" }, "Tags": { "shape": "TagList", "documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The IPAM's default resource discovery ID.
", "locationName": "defaultResourceDiscoveryId" }, "DefaultResourceDiscoveryAssociationId": { "shape": "IpamResourceDiscoveryAssociationId", "documentation": "The IPAM's default resource discovery association ID.
", "locationName": "defaultResourceDiscoveryAssociationId" }, "ResourceDiscoveryAssociationCount": { "shape": "Integer", "documentation": "The IPAM's resource discovery association count.
", "locationName": "resourceDiscoveryAssociationCount" }, "StateMessage": { "shape": "String", "documentation": "The state message.
", "locationName": "stateMessage" }, "Tier": { "shape": "IpamTier", "documentation": "IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
", "locationName": "tier" } }, "documentation": "IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, "IpamAddressHistoryMaxResults": { "type": "integer", "max": 1000, "min": 1 }, "IpamAddressHistoryRecord": { "type": "structure", "members": { "ResourceOwnerId": { "shape": "String", "documentation": "The ID of the resource owner.
", "locationName": "resourceOwnerId" }, "ResourceRegion": { "shape": "String", "documentation": "The Amazon Web Services Region of the resource.
", "locationName": "resourceRegion" }, "ResourceType": { "shape": "IpamAddressHistoryResourceType", "documentation": "The type of the resource.
", "locationName": "resourceType" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceCidr": { "shape": "String", "documentation": "The CIDR of the resource.
", "locationName": "resourceCidr" }, "ResourceName": { "shape": "String", "documentation": "The name of the resource.
", "locationName": "resourceName" }, "ResourceComplianceStatus": { "shape": "IpamComplianceStatus", "documentation": "The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", "locationName": "resourceComplianceStatus" }, "ResourceOverlapStatus": { "shape": "IpamOverlapStatus", "documentation": "The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", "locationName": "resourceOverlapStatus" }, "VpcId": { "shape": "String", "documentation": "The VPC ID of the resource.
", "locationName": "vpcId" }, "SampledStartTime": { "shape": "MillisecondDateTime", "documentation": "Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.
", "locationName": "sampledStartTime" }, "SampledEndTime": { "shape": "MillisecondDateTime", "documentation": "Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.
", "locationName": "sampledEndTime" } }, "documentation": "The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.
" }, "IpamAddressHistoryRecordSet": { "type": "list", "member": { "shape": "IpamAddressHistoryRecord", "locationName": "item" } }, "IpamAddressHistoryResourceType": { "type": "string", "enum": [ "eip", "vpc", "subnet", "network-interface", "instance" ] }, "IpamAssociatedResourceDiscoveryStatus": { "type": "string", "enum": [ "active", "not-found" ] }, "IpamCidrAuthorizationContext": { "type": "structure", "members": { "Message": { "shape": "String", "documentation": "The plain-text authorization message for the prefix and account.
" }, "Signature": { "shape": "String", "documentation": "The signed authorization message for the prefix and account.
" } }, "documentation": "A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
" }, "IpamComplianceStatus": { "type": "string", "enum": [ "compliant", "noncompliant", "unmanaged", "ignored" ] }, "IpamDiscoveredAccount": { "type": "structure", "members": { "AccountId": { "shape": "String", "documentation": "The account ID.
", "locationName": "accountId" }, "DiscoveryRegion": { "shape": "String", "documentation": "The Amazon Web Services Region that the account information is returned from. An account can be discovered in multiple regions and will have a separate discovered account for each Region.
", "locationName": "discoveryRegion" }, "FailureReason": { "shape": "IpamDiscoveryFailureReason", "documentation": "The resource discovery failure reason.
", "locationName": "failureReason" }, "LastAttemptedDiscoveryTime": { "shape": "MillisecondDateTime", "documentation": "The last attempted resource discovery time.
", "locationName": "lastAttemptedDiscoveryTime" }, "LastSuccessfulDiscoveryTime": { "shape": "MillisecondDateTime", "documentation": "The last successful resource discovery time.
", "locationName": "lastSuccessfulDiscoveryTime" } }, "documentation": "An IPAM discovered account. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts.
" }, "IpamDiscoveredAccountSet": { "type": "list", "member": { "shape": "IpamDiscoveredAccount", "locationName": "item" } }, "IpamDiscoveredPublicAddress": { "type": "structure", "members": { "IpamResourceDiscoveryId": { "shape": "IpamResourceDiscoveryId", "documentation": "The resource discovery ID.
", "locationName": "ipamResourceDiscoveryId" }, "AddressRegion": { "shape": "String", "documentation": "The Region of the resource the IP address is assigned to.
", "locationName": "addressRegion" }, "Address": { "shape": "String", "documentation": "The IP address.
", "locationName": "address" }, "AddressOwnerId": { "shape": "String", "documentation": "The ID of the owner of the resource the IP address is assigned to.
", "locationName": "addressOwnerId" }, "AddressAllocationId": { "shape": "String", "documentation": "The allocation ID of the resource the IP address is assigned to.
", "locationName": "addressAllocationId" }, "AssociationStatus": { "shape": "IpamPublicAddressAssociationStatus", "documentation": "The association status.
", "locationName": "associationStatus" }, "AddressType": { "shape": "IpamPublicAddressType", "documentation": "The IP address type.
", "locationName": "addressType" }, "Service": { "shape": "IpamPublicAddressAwsService", "documentation": "The Amazon Web Services service associated with the IP address.
", "locationName": "service" }, "ServiceResource": { "shape": "String", "documentation": "The resource ARN or ID.
", "locationName": "serviceResource" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC that the resource with the assigned IP address is in.
", "locationName": "vpcId" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet that the resource with the assigned IP address is in.
", "locationName": "subnetId" }, "PublicIpv4PoolId": { "shape": "String", "documentation": "The ID of the public IPv4 pool that the resource with the assigned IP address is from.
", "locationName": "publicIpv4PoolId" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The network interface ID of the resource with the assigned IP address.
", "locationName": "networkInterfaceId" }, "NetworkInterfaceDescription": { "shape": "String", "documentation": "The description of the network interface that IP address is assigned to.
", "locationName": "networkInterfaceDescription" }, "InstanceId": { "shape": "String", "documentation": "The instance ID of the instance the assigned IP address is assigned to.
", "locationName": "instanceId" }, "Tags": { "shape": "IpamPublicAddressTags", "documentation": "Tags associated with the IP address.
", "locationName": "tags" }, "NetworkBorderGroup": { "shape": "String", "documentation": "The network border group that the resource that the IP address is assigned to is in.
", "locationName": "networkBorderGroup" }, "SecurityGroups": { "shape": "IpamPublicAddressSecurityGroupList", "documentation": "Security groups associated with the resource that the IP address is assigned to.
", "locationName": "securityGroupSet" }, "SampleTime": { "shape": "MillisecondDateTime", "documentation": "The last successful resource discovery time.
", "locationName": "sampleTime" } }, "documentation": "A public IP Address discovered by IPAM.
" }, "IpamDiscoveredPublicAddressSet": { "type": "list", "member": { "shape": "IpamDiscoveredPublicAddress", "locationName": "item" } }, "IpamDiscoveredResourceCidr": { "type": "structure", "members": { "IpamResourceDiscoveryId": { "shape": "IpamResourceDiscoveryId", "documentation": "The resource discovery ID.
", "locationName": "ipamResourceDiscoveryId" }, "ResourceRegion": { "shape": "String", "documentation": "The resource Region.
", "locationName": "resourceRegion" }, "ResourceId": { "shape": "String", "documentation": "The resource ID.
", "locationName": "resourceId" }, "ResourceOwnerId": { "shape": "String", "documentation": "The resource owner ID.
", "locationName": "resourceOwnerId" }, "ResourceCidr": { "shape": "String", "documentation": "The resource CIDR.
", "locationName": "resourceCidr" }, "ResourceType": { "shape": "IpamResourceType", "documentation": "The resource type.
", "locationName": "resourceType" }, "ResourceTags": { "shape": "IpamResourceTagList", "documentation": "The resource tags.
", "locationName": "resourceTagSet" }, "IpUsage": { "shape": "BoxedDouble", "documentation": "The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:
For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.
For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).
The VPC ID.
", "locationName": "vpcId" }, "SampleTime": { "shape": "MillisecondDateTime", "documentation": "The last successful resource discovery time.
", "locationName": "sampleTime" } }, "documentation": "An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.
" }, "IpamDiscoveredResourceCidrSet": { "type": "list", "member": { "shape": "IpamDiscoveredResourceCidr", "locationName": "item" } }, "IpamDiscoveryFailureCode": { "type": "string", "enum": [ "assume-role-failure", "throttling-failure", "unauthorized-failure" ] }, "IpamDiscoveryFailureReason": { "type": "structure", "members": { "Code": { "shape": "IpamDiscoveryFailureCode", "documentation": "The discovery failure code.
assume-role-failure - IPAM could not assume the Amazon Web Services IAM service-linked role. This could be because of any of the following:
SLR has not been created yet and IPAM is still creating it.
You have opted-out of the IPAM home Region.
Account you are using as your IPAM account has been suspended.
throttling-failure - IPAM account is already using the allotted transactions per second and IPAM is receiving a throttling error when assuming the Amazon Web Services IAM SLR.
unauthorized-failure - Amazon Web Services account making the request is not authorized. For more information, see AuthFailure in the Amazon Elastic Compute Cloud API Reference.
The discovery failure message.
", "locationName": "message" } }, "documentation": "The discovery failure reason.
" }, "IpamId": { "type": "string" }, "IpamManagementState": { "type": "string", "enum": [ "managed", "unmanaged", "ignored" ] }, "IpamMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "IpamNetmaskLength": { "type": "integer", "max": 128, "min": 0 }, "IpamOperatingRegion": { "type": "structure", "members": { "RegionName": { "shape": "String", "documentation": "The name of the operating Region.
", "locationName": "regionName" } }, "documentation": "The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
" }, "IpamOperatingRegionSet": { "type": "list", "member": { "shape": "IpamOperatingRegion", "locationName": "item" } }, "IpamOverlapStatus": { "type": "string", "enum": [ "overlapping", "nonoverlapping", "ignored" ] }, "IpamPool": { "type": "structure", "members": { "OwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID of the owner of the IPAM pool.
", "locationName": "ownerId" }, "IpamPoolId": { "shape": "IpamPoolId", "documentation": "The ID of the IPAM pool.
", "locationName": "ipamPoolId" }, "SourceIpamPoolId": { "shape": "IpamPoolId", "documentation": "The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
", "locationName": "sourceIpamPoolId" }, "IpamPoolArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the IPAM pool.
", "locationName": "ipamPoolArn" }, "IpamScopeArn": { "shape": "ResourceArn", "documentation": "The ARN of the scope of the IPAM pool.
", "locationName": "ipamScopeArn" }, "IpamScopeType": { "shape": "IpamScopeType", "documentation": "In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
", "locationName": "ipamScopeType" }, "IpamArn": { "shape": "ResourceArn", "documentation": "The ARN of the IPAM.
", "locationName": "ipamArn" }, "IpamRegion": { "shape": "String", "documentation": "The Amazon Web Services Region of the IPAM pool.
", "locationName": "ipamRegion" }, "Locale": { "shape": "String", "documentation": "The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
", "locationName": "locale" }, "PoolDepth": { "shape": "Integer", "documentation": "The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
", "locationName": "poolDepth" }, "State": { "shape": "IpamPoolState", "documentation": "The state of the IPAM pool.
", "locationName": "state" }, "StateMessage": { "shape": "String", "documentation": "The state message.
", "locationName": "stateMessage" }, "Description": { "shape": "String", "documentation": "The description of the IPAM pool.
", "locationName": "description" }, "AutoImport": { "shape": "Boolean", "documentation": "If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
", "locationName": "autoImport" }, "PubliclyAdvertisable": { "shape": "Boolean", "documentation": "Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
The address family of the pool.
", "locationName": "addressFamily" }, "AllocationMinNetmaskLength": { "shape": "IpamNetmaskLength", "documentation": "The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
", "locationName": "allocationMinNetmaskLength" }, "AllocationMaxNetmaskLength": { "shape": "IpamNetmaskLength", "documentation": "The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
", "locationName": "allocationMaxNetmaskLength" }, "AllocationDefaultNetmaskLength": { "shape": "IpamNetmaskLength", "documentation": "The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
", "locationName": "allocationDefaultNetmaskLength" }, "AllocationResourceTags": { "shape": "IpamResourceTagList", "documentation": "Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
", "locationName": "allocationResourceTagSet" }, "Tags": { "shape": "TagList", "documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
Limits which service in Amazon Web Services that the pool can be used in. \"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.
", "locationName": "awsService" }, "PublicIpSource": { "shape": "IpamPoolPublicIpSource", "documentation": "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.
The resource used to provision CIDRs to a resource planning pool.
", "locationName": "sourceResource" } }, "documentation": "In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
" }, "IpamPoolAllocation": { "type": "structure", "members": { "Cidr": { "shape": "String", "documentation": "The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.
The ID of an allocation.
", "locationName": "ipamPoolAllocationId" }, "Description": { "shape": "String", "documentation": "A description of the pool allocation.
", "locationName": "description" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "IpamPoolAllocationResourceType", "documentation": "The type of the resource.
", "locationName": "resourceType" }, "ResourceRegion": { "shape": "String", "documentation": "The Amazon Web Services Region of the resource.
", "locationName": "resourceRegion" }, "ResourceOwner": { "shape": "String", "documentation": "The owner of the resource.
", "locationName": "resourceOwner" } }, "documentation": "In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.
" }, "IpamPoolAllocationAllowedCidrs": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "IpamPoolAllocationDisallowedCidrs": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "IpamPoolAllocationId": { "type": "string" }, "IpamPoolAllocationResourceType": { "type": "string", "enum": [ "ipam-pool", "vpc", "ec2-public-ipv4-pool", "custom", "subnet" ] }, "IpamPoolAllocationSet": { "type": "list", "member": { "shape": "IpamPoolAllocation", "locationName": "item" } }, "IpamPoolAwsService": { "type": "string", "enum": [ "ec2" ] }, "IpamPoolCidr": { "type": "structure", "members": { "Cidr": { "shape": "String", "documentation": "The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.
The state of the CIDR.
", "locationName": "state" }, "FailureReason": { "shape": "IpamPoolCidrFailureReason", "documentation": "Details related to why an IPAM pool CIDR failed to be provisioned.
", "locationName": "failureReason" }, "IpamPoolCidrId": { "shape": "IpamPoolCidrId", "documentation": "The IPAM pool CIDR ID.
", "locationName": "ipamPoolCidrId" }, "NetmaskLength": { "shape": "Integer", "documentation": "The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. \"NetmaskLength\" or \"Cidr\" is required.
", "locationName": "netmaskLength" } }, "documentation": "A CIDR provisioned to an IPAM pool.
" }, "IpamPoolCidrFailureCode": { "type": "string", "enum": [ "cidr-not-available", "limit-exceeded" ] }, "IpamPoolCidrFailureReason": { "type": "structure", "members": { "Code": { "shape": "IpamPoolCidrFailureCode", "documentation": "An error code related to why an IPAM pool CIDR failed to be provisioned.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "A message related to why an IPAM pool CIDR failed to be provisioned.
", "locationName": "message" } }, "documentation": "Details related to why an IPAM pool CIDR failed to be provisioned.
" }, "IpamPoolCidrId": { "type": "string" }, "IpamPoolCidrSet": { "type": "list", "member": { "shape": "IpamPoolCidr", "locationName": "item" } }, "IpamPoolCidrState": { "type": "string", "enum": [ "pending-provision", "provisioned", "failed-provision", "pending-deprovision", "deprovisioned", "failed-deprovision", "pending-import", "failed-import" ] }, "IpamPoolId": { "type": "string" }, "IpamPoolPublicIpSource": { "type": "string", "enum": [ "amazon", "byoip" ] }, "IpamPoolSet": { "type": "list", "member": { "shape": "IpamPool", "locationName": "item" } }, "IpamPoolSourceResource": { "type": "structure", "members": { "ResourceId": { "shape": "String", "documentation": "The source resource ID.
", "locationName": "resourceId" }, "ResourceType": { "shape": "IpamPoolSourceResourceType", "documentation": "The source resource type.
", "locationName": "resourceType" }, "ResourceRegion": { "shape": "String", "documentation": "The source resource Region.
", "locationName": "resourceRegion" }, "ResourceOwner": { "shape": "String", "documentation": "The source resource owner.
", "locationName": "resourceOwner" } }, "documentation": "The resource used to provision CIDRs to a resource planning pool.
" }, "IpamPoolSourceResourceRequest": { "type": "structure", "members": { "ResourceId": { "shape": "String", "documentation": "The source resource ID.
" }, "ResourceType": { "shape": "IpamPoolSourceResourceType", "documentation": "The source resource type.
" }, "ResourceRegion": { "shape": "String", "documentation": "The source resource Region.
" }, "ResourceOwner": { "shape": "String", "documentation": "The source resource owner.
" } }, "documentation": "The resource used to provision CIDRs to a resource planning pool.
" }, "IpamPoolSourceResourceType": { "type": "string", "enum": [ "vpc" ] }, "IpamPoolState": { "type": "string", "enum": [ "create-in-progress", "create-complete", "create-failed", "modify-in-progress", "modify-complete", "modify-failed", "delete-in-progress", "delete-complete", "delete-failed", "isolate-in-progress", "isolate-complete", "restore-in-progress" ] }, "IpamPublicAddressAssociationStatus": { "type": "string", "enum": [ "associated", "disassociated" ] }, "IpamPublicAddressAwsService": { "type": "string", "enum": [ "nat-gateway", "database-migration-service", "redshift", "elastic-container-service", "relational-database-service", "site-to-site-vpn", "load-balancer", "global-accelerator", "other" ] }, "IpamPublicAddressSecurityGroup": { "type": "structure", "members": { "GroupName": { "shape": "String", "documentation": "The security group's name.
", "locationName": "groupName" }, "GroupId": { "shape": "String", "documentation": "The security group's ID.
", "locationName": "groupId" } }, "documentation": "The security group that the resource with the public IP address is in.
" }, "IpamPublicAddressSecurityGroupList": { "type": "list", "member": { "shape": "IpamPublicAddressSecurityGroup", "locationName": "item" } }, "IpamPublicAddressTag": { "type": "structure", "members": { "Key": { "shape": "String", "documentation": "The tag's key.
", "locationName": "key" }, "Value": { "shape": "String", "documentation": "The tag's value.
", "locationName": "value" } }, "documentation": "A tag for a public IP address discovered by IPAM.
" }, "IpamPublicAddressTagList": { "type": "list", "member": { "shape": "IpamPublicAddressTag", "locationName": "item" } }, "IpamPublicAddressTags": { "type": "structure", "members": { "EipTags": { "shape": "IpamPublicAddressTagList", "documentation": "Tags for an Elastic IP address.
", "locationName": "eipTagSet" } }, "documentation": "Tags for a public IP address discovered by IPAM.
" }, "IpamPublicAddressType": { "type": "string", "enum": [ "service-managed-ip", "service-managed-byoip", "amazon-owned-eip", "byoip", "ec2-public-ip" ] }, "IpamResourceCidr": { "type": "structure", "members": { "IpamId": { "shape": "IpamId", "documentation": "The IPAM ID for an IPAM resource.
", "locationName": "ipamId" }, "IpamScopeId": { "shape": "IpamScopeId", "documentation": "The scope ID for an IPAM resource.
", "locationName": "ipamScopeId" }, "IpamPoolId": { "shape": "IpamPoolId", "documentation": "The pool ID for an IPAM resource.
", "locationName": "ipamPoolId" }, "ResourceRegion": { "shape": "String", "documentation": "The Amazon Web Services Region for an IPAM resource.
", "locationName": "resourceRegion" }, "ResourceOwnerId": { "shape": "String", "documentation": "The Amazon Web Services account number of the owner of an IPAM resource.
", "locationName": "resourceOwnerId" }, "ResourceId": { "shape": "String", "documentation": "The ID of an IPAM resource.
", "locationName": "resourceId" }, "ResourceName": { "shape": "String", "documentation": "The name of an IPAM resource.
", "locationName": "resourceName" }, "ResourceCidr": { "shape": "String", "documentation": "The CIDR for an IPAM resource.
", "locationName": "resourceCidr" }, "ResourceType": { "shape": "IpamResourceType", "documentation": "The type of IPAM resource.
", "locationName": "resourceType" }, "ResourceTags": { "shape": "IpamResourceTagList", "documentation": "The tags for an IPAM resource.
", "locationName": "resourceTagSet" }, "IpUsage": { "shape": "BoxedDouble", "documentation": "The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:
For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.
For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).
The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", "locationName": "complianceStatus" }, "ManagementState": { "shape": "IpamManagementState", "documentation": "The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", "locationName": "managementState" }, "OverlapStatus": { "shape": "IpamOverlapStatus", "documentation": "The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
", "locationName": "overlapStatus" }, "VpcId": { "shape": "String", "documentation": "The ID of a VPC.
", "locationName": "vpcId" } }, "documentation": "The CIDR for an IPAM resource.
" }, "IpamResourceCidrSet": { "type": "list", "member": { "shape": "IpamResourceCidr", "locationName": "item" } }, "IpamResourceDiscovery": { "type": "structure", "members": { "OwnerId": { "shape": "String", "documentation": "The ID of the owner.
", "locationName": "ownerId" }, "IpamResourceDiscoveryId": { "shape": "IpamResourceDiscoveryId", "documentation": "The resource discovery ID.
", "locationName": "ipamResourceDiscoveryId" }, "IpamResourceDiscoveryArn": { "shape": "String", "documentation": "The resource discovery Amazon Resource Name (ARN).
", "locationName": "ipamResourceDiscoveryArn" }, "IpamResourceDiscoveryRegion": { "shape": "String", "documentation": "The resource discovery Region.
", "locationName": "ipamResourceDiscoveryRegion" }, "Description": { "shape": "String", "documentation": "The resource discovery description.
", "locationName": "description" }, "OperatingRegions": { "shape": "IpamOperatingRegionSet", "documentation": "The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
", "locationName": "operatingRegionSet" }, "IsDefault": { "shape": "Boolean", "documentation": "Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
", "locationName": "isDefault" }, "State": { "shape": "IpamResourceDiscoveryState", "documentation": "The lifecycle state of the resource discovery.
create-in-progress - Resource discovery is being created.
create-complete - Resource discovery creation is complete.
create-failed - Resource discovery creation has failed.
modify-in-progress - Resource discovery is being modified.
modify-complete - Resource discovery modification is complete.
modify-failed - Resource discovery modification has failed.
delete-in-progress - Resource discovery is being deleted.
delete-complete - Resource discovery deletion is complete.
delete-failed - Resource discovery deletion has failed.
isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.
isolate-complete - Resource discovery isolation is complete.
restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", "locationName": "tagSet" } }, "documentation": "A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
" }, "IpamResourceDiscoveryAssociation": { "type": "structure", "members": { "OwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID of the resource discovery owner.
", "locationName": "ownerId" }, "IpamResourceDiscoveryAssociationId": { "shape": "IpamResourceDiscoveryAssociationId", "documentation": "The resource discovery association ID.
", "locationName": "ipamResourceDiscoveryAssociationId" }, "IpamResourceDiscoveryAssociationArn": { "shape": "String", "documentation": "The resource discovery association Amazon Resource Name (ARN).
", "locationName": "ipamResourceDiscoveryAssociationArn" }, "IpamResourceDiscoveryId": { "shape": "IpamResourceDiscoveryId", "documentation": "The resource discovery ID.
", "locationName": "ipamResourceDiscoveryId" }, "IpamId": { "shape": "IpamId", "documentation": "The IPAM ID.
", "locationName": "ipamId" }, "IpamArn": { "shape": "ResourceArn", "documentation": "The IPAM ARN.
", "locationName": "ipamArn" }, "IpamRegion": { "shape": "String", "documentation": "The IPAM home Region.
", "locationName": "ipamRegion" }, "IsDefault": { "shape": "Boolean", "documentation": "Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.
", "locationName": "isDefault" }, "ResourceDiscoveryStatus": { "shape": "IpamAssociatedResourceDiscoveryStatus", "documentation": "The resource discovery status.
active - Connection or permissions required to read the results of the resource discovery are intact.
not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.
The lifecycle state of the association when you associate or disassociate a resource discovery.
associate-in-progress - Resource discovery is being associated.
associate-complete - Resource discovery association is complete.
associate-failed - Resource discovery association has failed.
disassociate-in-progress - Resource discovery is being disassociated.
disassociate-complete - Resource discovery disassociation is complete.
disassociate-failed - Resource discovery disassociation has failed.
isolate-in-progress - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.
isolate-complete - Resource discovery isolation is complete..
restore-in-progress - Resource discovery is being restored.
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
", "locationName": "tagSet" } }, "documentation": "An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.
" }, "IpamResourceDiscoveryAssociationId": { "type": "string" }, "IpamResourceDiscoveryAssociationSet": { "type": "list", "member": { "shape": "IpamResourceDiscoveryAssociation", "locationName": "item" } }, "IpamResourceDiscoveryAssociationState": { "type": "string", "enum": [ "associate-in-progress", "associate-complete", "associate-failed", "disassociate-in-progress", "disassociate-complete", "disassociate-failed", "isolate-in-progress", "isolate-complete", "restore-in-progress" ] }, "IpamResourceDiscoveryId": { "type": "string" }, "IpamResourceDiscoverySet": { "type": "list", "member": { "shape": "IpamResourceDiscovery", "locationName": "item" } }, "IpamResourceDiscoveryState": { "type": "string", "enum": [ "create-in-progress", "create-complete", "create-failed", "modify-in-progress", "modify-complete", "modify-failed", "delete-in-progress", "delete-complete", "delete-failed", "isolate-in-progress", "isolate-complete", "restore-in-progress" ] }, "IpamResourceTag": { "type": "structure", "members": { "Key": { "shape": "String", "documentation": "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.
", "locationName": "key" }, "Value": { "shape": "String", "documentation": "The value of the tag.
", "locationName": "value" } }, "documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The Amazon Web Services account ID of the owner of the scope.
", "locationName": "ownerId" }, "IpamScopeId": { "shape": "IpamScopeId", "documentation": "The ID of the scope.
", "locationName": "ipamScopeId" }, "IpamScopeArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the scope.
", "locationName": "ipamScopeArn" }, "IpamArn": { "shape": "ResourceArn", "documentation": "The ARN of the IPAM.
", "locationName": "ipamArn" }, "IpamRegion": { "shape": "String", "documentation": "The Amazon Web Services Region of the IPAM scope.
", "locationName": "ipamRegion" }, "IpamScopeType": { "shape": "IpamScopeType", "documentation": "The type of the scope.
", "locationName": "ipamScopeType" }, "IsDefault": { "shape": "Boolean", "documentation": "Defines if the scope is the default scope or not.
", "locationName": "isDefault" }, "Description": { "shape": "String", "documentation": "The description of the scope.
", "locationName": "description" }, "PoolCount": { "shape": "Integer", "documentation": "The number of pools in the scope.
", "locationName": "poolCount" }, "State": { "shape": "IpamScopeState", "documentation": "The state of the IPAM scope.
", "locationName": "state" }, "Tags": { "shape": "TagList", "documentation": "The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see How IPAM works in the Amazon VPC IPAM User Guide.
" }, "IpamScopeId": { "type": "string" }, "IpamScopeSet": { "type": "list", "member": { "shape": "IpamScope", "locationName": "item" } }, "IpamScopeState": { "type": "string", "enum": [ "create-in-progress", "create-complete", "create-failed", "modify-in-progress", "modify-complete", "modify-failed", "delete-in-progress", "delete-complete", "delete-failed", "isolate-in-progress", "isolate-complete", "restore-in-progress" ] }, "IpamScopeType": { "type": "string", "enum": [ "public", "private" ] }, "IpamSet": { "type": "list", "member": { "shape": "Ipam", "locationName": "item" } }, "IpamState": { "type": "string", "enum": [ "create-in-progress", "create-complete", "create-failed", "modify-in-progress", "modify-complete", "modify-failed", "delete-in-progress", "delete-complete", "delete-failed", "isolate-in-progress", "isolate-complete", "restore-in-progress" ] }, "IpamTier": { "type": "string", "enum": [ "free", "advanced" ] }, "Ipv4PoolCoipId": { "type": "string" }, "Ipv4PoolEc2Id": { "type": "string" }, "Ipv4PrefixList": { "type": "list", "member": { "shape": "Ipv4PrefixSpecificationRequest", "locationName": "item" } }, "Ipv4PrefixListResponse": { "type": "list", "member": { "shape": "Ipv4PrefixSpecificationResponse", "locationName": "item" } }, "Ipv4PrefixSpecification": { "type": "structure", "members": { "Ipv4Prefix": { "shape": "String", "documentation": "The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
", "locationName": "ipv4Prefix" } }, "documentation": "Describes an IPv4 prefix.
" }, "Ipv4PrefixSpecificationRequest": { "type": "structure", "members": { "Ipv4Prefix": { "shape": "String", "documentation": "The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
" } }, "documentation": "Describes the IPv4 prefix option for a network interface.
" }, "Ipv4PrefixSpecificationResponse": { "type": "structure", "members": { "Ipv4Prefix": { "shape": "String", "documentation": "The IPv4 delegated prefixes assigned to the network interface.
", "locationName": "ipv4Prefix" } }, "documentation": "Information about the IPv4 delegated prefixes assigned to a network interface.
" }, "Ipv4PrefixesList": { "type": "list", "member": { "shape": "Ipv4PrefixSpecification", "locationName": "item" } }, "Ipv6Address": { "type": "string" }, "Ipv6AddressList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "Ipv6CidrAssociation": { "type": "structure", "members": { "Ipv6Cidr": { "shape": "String", "documentation": "The IPv6 CIDR block.
", "locationName": "ipv6Cidr" }, "AssociatedResource": { "shape": "String", "documentation": "The resource that's associated with the IPv6 CIDR block.
", "locationName": "associatedResource" } }, "documentation": "Describes an IPv6 CIDR block association.
" }, "Ipv6CidrAssociationSet": { "type": "list", "member": { "shape": "Ipv6CidrAssociation", "locationName": "item" } }, "Ipv6CidrBlock": { "type": "structure", "members": { "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 CIDR block.
", "locationName": "ipv6CidrBlock" } }, "documentation": "Describes an IPv6 CIDR block.
" }, "Ipv6CidrBlockSet": { "type": "list", "member": { "shape": "Ipv6CidrBlock", "locationName": "item" } }, "Ipv6Flag": { "type": "boolean" }, "Ipv6Pool": { "type": "structure", "members": { "PoolId": { "shape": "String", "documentation": "The ID of the address pool.
", "locationName": "poolId" }, "Description": { "shape": "String", "documentation": "The description for the address pool.
", "locationName": "description" }, "PoolCidrBlocks": { "shape": "PoolCidrBlocksSet", "documentation": "The CIDR blocks for the address pool.
", "locationName": "poolCidrBlockSet" }, "Tags": { "shape": "TagList", "documentation": "Any tags for the address pool.
", "locationName": "tagSet" } }, "documentation": "Describes an IPv6 address pool.
" }, "Ipv6PoolEc2Id": { "type": "string" }, "Ipv6PoolIdList": { "type": "list", "member": { "shape": "Ipv6PoolEc2Id", "locationName": "item" } }, "Ipv6PoolMaxResults": { "type": "integer", "max": 1000, "min": 1 }, "Ipv6PoolSet": { "type": "list", "member": { "shape": "Ipv6Pool", "locationName": "item" } }, "Ipv6PrefixList": { "type": "list", "member": { "shape": "Ipv6PrefixSpecificationRequest", "locationName": "item" } }, "Ipv6PrefixListResponse": { "type": "list", "member": { "shape": "Ipv6PrefixSpecificationResponse", "locationName": "item" } }, "Ipv6PrefixSpecification": { "type": "structure", "members": { "Ipv6Prefix": { "shape": "String", "documentation": "The IPv6 prefix.
", "locationName": "ipv6Prefix" } }, "documentation": "Describes the IPv6 prefix.
" }, "Ipv6PrefixSpecificationRequest": { "type": "structure", "members": { "Ipv6Prefix": { "shape": "String", "documentation": "The IPv6 prefix.
" } }, "documentation": "Describes the IPv4 prefix option for a network interface.
" }, "Ipv6PrefixSpecificationResponse": { "type": "structure", "members": { "Ipv6Prefix": { "shape": "String", "documentation": "The IPv6 delegated prefixes assigned to the network interface.
", "locationName": "ipv6Prefix" } }, "documentation": "Information about the IPv6 delegated prefixes assigned to a network interface.
" }, "Ipv6PrefixesList": { "type": "list", "member": { "shape": "Ipv6PrefixSpecification", "locationName": "item" } }, "Ipv6Range": { "type": "structure", "members": { "CidrIpv6": { "shape": "String", "documentation": "The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
", "locationName": "cidrIpv6" }, "Description": { "shape": "String", "documentation": "A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", "locationName": "description" } }, "documentation": "Describes an IPv6 address range.
" }, "Ipv6RangeList": { "type": "list", "member": { "shape": "Ipv6Range", "locationName": "item" } }, "Ipv6SupportValue": { "type": "string", "enum": [ "enable", "disable" ] }, "KernelId": { "type": "string" }, "KeyFormat": { "type": "string", "enum": [ "pem", "ppk" ] }, "KeyNameStringList": { "type": "list", "member": { "shape": "KeyPairName", "locationName": "KeyName" } }, "KeyPair": { "type": "structure", "members": { "KeyFingerprint": { "shape": "String", "documentation": "For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
An unencrypted PEM encoded RSA or ED25519 private key.
", "locationName": "keyMaterial" }, "KeyName": { "shape": "String", "documentation": "The name of the key pair.
", "locationName": "keyName" }, "KeyPairId": { "shape": "String", "documentation": "The ID of the key pair.
", "locationName": "keyPairId" }, "Tags": { "shape": "TagList", "documentation": "Any tags applied to the key pair.
", "locationName": "tagSet" } }, "documentation": "Describes a key pair.
" }, "KeyPairId": { "type": "string" }, "KeyPairIdStringList": { "type": "list", "member": { "shape": "KeyPairId", "locationName": "KeyPairId" } }, "KeyPairInfo": { "type": "structure", "members": { "KeyPairId": { "shape": "String", "documentation": "The ID of the key pair.
", "locationName": "keyPairId" }, "KeyFingerprint": { "shape": "String", "documentation": "If you used CreateKeyPair to create the key pair:
For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used ImportKeyPair to provide Amazon Web Services the public key:
For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
The name of the key pair.
", "locationName": "keyName" }, "KeyType": { "shape": "KeyType", "documentation": "The type of key pair.
", "locationName": "keyType" }, "Tags": { "shape": "TagList", "documentation": "Any tags applied to the key pair.
", "locationName": "tagSet" }, "PublicKey": { "shape": "String", "documentation": "The public key material.
", "locationName": "publicKey" }, "CreateTime": { "shape": "MillisecondDateTime", "documentation": "If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
", "locationName": "createTime" } }, "documentation": "Describes a key pair.
" }, "KeyPairList": { "type": "list", "member": { "shape": "KeyPairInfo", "locationName": "item" } }, "KeyPairName": { "type": "string" }, "KeyType": { "type": "string", "enum": [ "rsa", "ed25519" ] }, "KmsKeyArn": { "type": "string" }, "KmsKeyId": { "type": "string" }, "LastError": { "type": "structure", "members": { "Message": { "shape": "String", "documentation": "The error message for the VPC endpoint error.
", "locationName": "message" }, "Code": { "shape": "String", "documentation": "The error code for the VPC endpoint error.
", "locationName": "code" } }, "documentation": "The last error that occurred for a VPC endpoint.
" }, "LaunchPermission": { "type": "structure", "members": { "Group": { "shape": "PermissionGroup", "documentation": "The name of the group.
", "locationName": "group" }, "UserId": { "shape": "String", "documentation": "The Amazon Web Services account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
", "locationName": "userId" }, "OrganizationArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of an organization.
", "locationName": "organizationArn" }, "OrganizationalUnitArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of an organizational unit (OU).
", "locationName": "organizationalUnitArn" } }, "documentation": "Describes a launch permission.
" }, "LaunchPermissionList": { "type": "list", "member": { "shape": "LaunchPermission", "locationName": "item" } }, "LaunchPermissionModifications": { "type": "structure", "members": { "Add": { "shape": "LaunchPermissionList", "documentation": "The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.
" }, "Remove": { "shape": "LaunchPermissionList", "documentation": "The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.
" } }, "documentation": "Describes a launch permission modification.
" }, "LaunchSpecification": { "type": "structure", "members": { "UserData": { "shape": "SensitiveUserData", "documentation": "The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", "locationName": "userData" }, "SecurityGroups": { "shape": "GroupIdentifierList", "documentation": "The IDs of the security groups.
", "locationName": "groupSet" }, "AddressingType": { "shape": "String", "documentation": "Deprecated.
", "locationName": "addressingType" }, "BlockDeviceMappings": { "shape": "BlockDeviceMappingList", "documentation": "The block device mapping entries.
", "locationName": "blockDeviceMapping" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
The IAM instance profile.
", "locationName": "iamInstanceProfile" }, "ImageId": { "shape": "String", "documentation": "The ID of the AMI.
", "locationName": "imageId" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type. Only one instance type can be specified.
", "locationName": "instanceType" }, "KernelId": { "shape": "String", "documentation": "The ID of the kernel.
", "locationName": "kernelId" }, "KeyName": { "shape": "String", "documentation": "The name of the key pair.
", "locationName": "keyName" }, "NetworkInterfaces": { "shape": "InstanceNetworkInterfaceSpecificationList", "documentation": "The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
", "locationName": "networkInterfaceSet" }, "Placement": { "shape": "SpotPlacement", "documentation": "The placement information for the instance.
", "locationName": "placement" }, "RamdiskId": { "shape": "String", "documentation": "The ID of the RAM disk.
", "locationName": "ramdiskId" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet in which to launch the instance.
", "locationName": "subnetId" }, "Monitoring": { "shape": "RunInstancesMonitoringEnabled", "locationName": "monitoring" } }, "documentation": "Describes the launch specification for an instance.
" }, "LaunchSpecsList": { "type": "list", "member": { "shape": "SpotFleetLaunchSpecification", "locationName": "item" } }, "LaunchTemplate": { "type": "structure", "members": { "LaunchTemplateId": { "shape": "String", "documentation": "The ID of the launch template.
", "locationName": "launchTemplateId" }, "LaunchTemplateName": { "shape": "LaunchTemplateName", "documentation": "The name of the launch template.
", "locationName": "launchTemplateName" }, "CreateTime": { "shape": "DateTime", "documentation": "The time launch template was created.
", "locationName": "createTime" }, "CreatedBy": { "shape": "String", "documentation": "The principal that created the launch template.
", "locationName": "createdBy" }, "DefaultVersionNumber": { "shape": "Long", "documentation": "The version number of the default version of the launch template.
", "locationName": "defaultVersionNumber" }, "LatestVersionNumber": { "shape": "Long", "documentation": "The version number of the latest version of the launch template.
", "locationName": "latestVersionNumber" }, "Tags": { "shape": "TagList", "documentation": "The tags for the launch template.
", "locationName": "tagSet" } }, "documentation": "Describes a launch template.
" }, "LaunchTemplateAndOverridesResponse": { "type": "structure", "members": { "LaunchTemplateSpecification": { "shape": "FleetLaunchTemplateSpecification", "documentation": "The launch template.
", "locationName": "launchTemplateSpecification" }, "Overrides": { "shape": "FleetLaunchTemplateOverrides", "documentation": "Any parameters that you specify override the same parameters in the launch template.
", "locationName": "overrides" } }, "documentation": "Describes a launch template and overrides.
" }, "LaunchTemplateAutoRecoveryState": { "type": "string", "enum": [ "default", "disabled" ] }, "LaunchTemplateBlockDeviceMapping": { "type": "structure", "members": { "DeviceName": { "shape": "String", "documentation": "The device name.
", "locationName": "deviceName" }, "VirtualName": { "shape": "String", "documentation": "The virtual device name (ephemeralN).
", "locationName": "virtualName" }, "Ebs": { "shape": "LaunchTemplateEbsBlockDevice", "documentation": "Information about the block device for an EBS volume.
", "locationName": "ebs" }, "NoDevice": { "shape": "String", "documentation": "To omit the device from the block device mapping, specify an empty string.
", "locationName": "noDevice" } }, "documentation": "Describes a block device mapping.
" }, "LaunchTemplateBlockDeviceMappingList": { "type": "list", "member": { "shape": "LaunchTemplateBlockDeviceMapping", "locationName": "item" } }, "LaunchTemplateBlockDeviceMappingRequest": { "type": "structure", "members": { "DeviceName": { "shape": "String", "documentation": "The device name (for example, /dev/sdh or xvdh).
" }, "VirtualName": { "shape": "String", "documentation": "The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
" }, "Ebs": { "shape": "LaunchTemplateEbsBlockDeviceRequest", "documentation": "Parameters used to automatically set up EBS volumes when the instance is launched.
" }, "NoDevice": { "shape": "String", "documentation": "To omit the device from the block device mapping, specify an empty string.
" } }, "documentation": "Describes a block device mapping.
" }, "LaunchTemplateBlockDeviceMappingRequestList": { "type": "list", "member": { "shape": "LaunchTemplateBlockDeviceMappingRequest", "locationName": "BlockDeviceMapping" } }, "LaunchTemplateCapacityReservationSpecificationRequest": { "type": "structure", "members": { "CapacityReservationPreference": { "shape": "CapacityReservationPreference", "documentation": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
Information about the target Capacity Reservation or Capacity Reservation group.
" } }, "documentation": "Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
Information about the target Capacity Reservation or Capacity Reservation group.
", "locationName": "capacityReservationTarget" } }, "documentation": "Information about the Capacity Reservation targeting option.
" }, "LaunchTemplateConfig": { "type": "structure", "members": { "LaunchTemplateSpecification": { "shape": "FleetLaunchTemplateSpecification", "documentation": "The launch template to use. Make sure that the launch template does not contain the NetworkInterfaceId parameter because you can't specify a network interface ID in a Spot Fleet.
Any parameters that you specify override the same parameters in the launch template.
", "locationName": "overrides" } }, "documentation": "Describes a launch template and overrides.
" }, "LaunchTemplateConfigList": { "type": "list", "member": { "shape": "LaunchTemplateConfig", "locationName": "item" } }, "LaunchTemplateCpuOptions": { "type": "structure", "members": { "CoreCount": { "shape": "Integer", "documentation": "The number of CPU cores for the instance.
", "locationName": "coreCount" }, "ThreadsPerCore": { "shape": "Integer", "documentation": "The number of threads per CPU core.
", "locationName": "threadsPerCore" }, "AmdSevSnp": { "shape": "AmdSevSnpSpecification", "documentation": "Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP.
", "locationName": "amdSevSnp" } }, "documentation": "The CPU options for the instance.
" }, "LaunchTemplateCpuOptionsRequest": { "type": "structure", "members": { "CoreCount": { "shape": "Integer", "documentation": "The number of CPU cores for the instance.
" }, "ThreadsPerCore": { "shape": "Integer", "documentation": "The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.
Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see AMD SEV-SNP.
" } }, "documentation": "The CPU options for the instance. Both the core count and threads per core must be specified in the request.
" }, "LaunchTemplateEbsBlockDevice": { "type": "structure", "members": { "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the EBS volume is encrypted.
", "locationName": "encrypted" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the EBS volume is deleted on instance termination.
", "locationName": "deleteOnTermination" }, "Iops": { "shape": "Integer", "documentation": "The number of I/O operations per second (IOPS) that the volume supports.
", "locationName": "iops" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The ARN of the Key Management Service (KMS) CMK used for encryption.
", "locationName": "kmsKeyId" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot.
", "locationName": "snapshotId" }, "VolumeSize": { "shape": "Integer", "documentation": "The size of the volume, in GiB.
", "locationName": "volumeSize" }, "VolumeType": { "shape": "VolumeType", "documentation": "The volume type.
", "locationName": "volumeType" }, "Throughput": { "shape": "Integer", "documentation": "The throughput that the volume supports, in MiB/s.
", "locationName": "throughput" } }, "documentation": "Describes a block device for an EBS volume.
" }, "LaunchTemplateEbsBlockDeviceRequest": { "type": "structure", "members": { "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the EBS volume is deleted on instance termination.
" }, "Iops": { "shape": "Integer", "documentation": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only.
The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot.
" }, "VolumeSize": { "shape": "Integer", "documentation": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
" }, "Throughput": { "shape": "Integer", "documentation": "The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
" } }, "documentation": "The parameters for a block device for an EBS volume.
" }, "LaunchTemplateElasticInferenceAccelerator": { "type": "structure", "required": [ "Type" ], "members": { "Type": { "shape": "String", "documentation": "The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
" }, "Count": { "shape": "LaunchTemplateElasticInferenceAcceleratorCount", "documentation": "The number of elastic inference accelerators to attach to the instance.
Default: 1
" } }, "documentation": "Describes an elastic inference accelerator.
" }, "LaunchTemplateElasticInferenceAcceleratorCount": { "type": "integer", "min": 1 }, "LaunchTemplateElasticInferenceAcceleratorList": { "type": "list", "member": { "shape": "LaunchTemplateElasticInferenceAccelerator", "locationName": "item" } }, "LaunchTemplateElasticInferenceAcceleratorResponse": { "type": "structure", "members": { "Type": { "shape": "String", "documentation": "The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
", "locationName": "type" }, "Count": { "shape": "Integer", "documentation": "The number of elastic inference accelerators to attach to the instance.
Default: 1
", "locationName": "count" } }, "documentation": "Describes an elastic inference accelerator.
" }, "LaunchTemplateElasticInferenceAcceleratorResponseList": { "type": "list", "member": { "shape": "LaunchTemplateElasticInferenceAcceleratorResponse", "locationName": "item" } }, "LaunchTemplateEnaSrdSpecification": { "type": "structure", "members": { "EnaSrdEnabled": { "shape": "Boolean", "documentation": "Indicates whether ENA Express is enabled for the network interface.
", "locationName": "enaSrdEnabled" }, "EnaSrdUdpSpecification": { "shape": "LaunchTemplateEnaSrdUdpSpecification", "documentation": "Configures ENA Express for UDP network traffic.
", "locationName": "enaSrdUdpSpecification" } }, "documentation": "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. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.
To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.
" }, "LaunchTemplateEnaSrdUdpSpecification": { "type": "structure", "members": { "EnaSrdUdpEnabled": { "shape": "Boolean", "documentation": "Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
", "locationName": "enaSrdUdpEnabled" } }, "documentation": "ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.
" }, "LaunchTemplateEnclaveOptions": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
" }, "LaunchTemplateEnclaveOptionsRequest": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
" }, "LaunchTemplateErrorCode": { "type": "string", "enum": [ "launchTemplateIdDoesNotExist", "launchTemplateIdMalformed", "launchTemplateNameDoesNotExist", "launchTemplateNameMalformed", "launchTemplateVersionDoesNotExist", "unexpectedError" ] }, "LaunchTemplateHibernationOptions": { "type": "structure", "members": { "Configured": { "shape": "Boolean", "documentation": "If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
Indicates whether an instance is configured for hibernation.
" }, "LaunchTemplateHibernationOptionsRequest": { "type": "structure", "members": { "Configured": { "shape": "Boolean", "documentation": "If you set this parameter to true, the instance is enabled for hibernation.
Default: false
Indicates whether the instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites.
" }, "LaunchTemplateHttpTokensState": { "type": "string", "enum": [ "optional", "required" ] }, "LaunchTemplateIamInstanceProfileSpecification": { "type": "structure", "members": { "Arn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the instance profile.
", "locationName": "arn" }, "Name": { "shape": "String", "documentation": "The name of the instance profile.
", "locationName": "name" } }, "documentation": "Describes an IAM instance profile.
" }, "LaunchTemplateIamInstanceProfileSpecificationRequest": { "type": "structure", "members": { "Arn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the instance profile.
" }, "Name": { "shape": "String", "documentation": "The name of the instance profile.
" } }, "documentation": "An IAM instance profile.
" }, "LaunchTemplateId": { "type": "string" }, "LaunchTemplateIdStringList": { "type": "list", "member": { "shape": "LaunchTemplateId", "locationName": "item" } }, "LaunchTemplateInstanceMaintenanceOptions": { "type": "structure", "members": { "AutoRecovery": { "shape": "LaunchTemplateAutoRecoveryState", "documentation": "Disables the automatic recovery behavior of your instance or sets it to default.
", "locationName": "autoRecovery" } }, "documentation": "The maintenance options of your instance.
" }, "LaunchTemplateInstanceMaintenanceOptionsRequest": { "type": "structure", "members": { "AutoRecovery": { "shape": "LaunchTemplateAutoRecoveryState", "documentation": "Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.
" } }, "documentation": "The maintenance options of your instance.
" }, "LaunchTemplateInstanceMarketOptions": { "type": "structure", "members": { "MarketType": { "shape": "MarketType", "documentation": "The market type.
", "locationName": "marketType" }, "SpotOptions": { "shape": "LaunchTemplateSpotMarketOptions", "documentation": "The options for Spot Instances.
", "locationName": "spotOptions" } }, "documentation": "The market (purchasing) option for the instances.
" }, "LaunchTemplateInstanceMarketOptionsRequest": { "type": "structure", "members": { "MarketType": { "shape": "MarketType", "documentation": "The market type.
" }, "SpotOptions": { "shape": "LaunchTemplateSpotMarketOptionsRequest", "documentation": "The options for Spot Instances.
" } }, "documentation": "The market (purchasing) option for the instances.
" }, "LaunchTemplateInstanceMetadataEndpointState": { "type": "string", "enum": [ "disabled", "enabled" ] }, "LaunchTemplateInstanceMetadataOptions": { "type": "structure", "members": { "State": { "shape": "LaunchTemplateInstanceMetadataOptionsState", "documentation": "The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
Indicates whether IMDSv2 is required.
optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.
required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
", "locationName": "httpPutResponseHopLimit" }, "HttpEndpoint": { "shape": "LaunchTemplateInstanceMetadataEndpointState", "documentation": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.
" }, "LaunchTemplateInstanceMetadataOptionsRequest": { "type": "structure", "members": { "HttpTokens": { "shape": "LaunchTemplateHttpTokensState", "documentation": "Indicates whether IMDSv2 is required.
optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.
required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
" }, "HttpEndpoint": { "shape": "LaunchTemplateInstanceMetadataEndpointState", "documentation": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.
" }, "LaunchTemplateInstanceMetadataOptionsState": { "type": "string", "enum": [ "pending", "applied" ] }, "LaunchTemplateInstanceMetadataProtocolIpv6": { "type": "string", "enum": [ "disabled", "enabled" ] }, "LaunchTemplateInstanceMetadataTagsState": { "type": "string", "enum": [ "disabled", "enabled" ] }, "LaunchTemplateInstanceNetworkInterfaceSpecification": { "type": "structure", "members": { "AssociateCarrierIpAddress": { "shape": "Boolean", "documentation": "Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
", "locationName": "associateCarrierIpAddress" }, "AssociatePublicIpAddress": { "shape": "Boolean", "documentation": "Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
", "locationName": "associatePublicIpAddress" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the network interface is deleted when the instance is terminated.
", "locationName": "deleteOnTermination" }, "Description": { "shape": "String", "documentation": "A description for the network interface.
", "locationName": "description" }, "DeviceIndex": { "shape": "Integer", "documentation": "The device index for the network interface attachment.
", "locationName": "deviceIndex" }, "Groups": { "shape": "GroupIdStringList", "documentation": "The IDs of one or more security groups.
", "locationName": "groupSet" }, "InterfaceType": { "shape": "String", "documentation": "The type of network interface.
", "locationName": "interfaceType" }, "Ipv6AddressCount": { "shape": "Integer", "documentation": "The number of IPv6 addresses for the network interface.
", "locationName": "ipv6AddressCount" }, "Ipv6Addresses": { "shape": "InstanceIpv6AddressList", "documentation": "The IPv6 addresses for the network interface.
", "locationName": "ipv6AddressesSet" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "PrivateIpAddress": { "shape": "String", "documentation": "The primary private IPv4 address of the network interface.
", "locationName": "privateIpAddress" }, "PrivateIpAddresses": { "shape": "PrivateIpAddressSpecificationList", "documentation": "One or more private IPv4 addresses.
", "locationName": "privateIpAddressesSet" }, "SecondaryPrivateIpAddressCount": { "shape": "Integer", "documentation": "The number of secondary private IPv4 addresses for the network interface.
", "locationName": "secondaryPrivateIpAddressCount" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet for the network interface.
", "locationName": "subnetId" }, "NetworkCardIndex": { "shape": "Integer", "documentation": "The index of the network card.
", "locationName": "networkCardIndex" }, "Ipv4Prefixes": { "shape": "Ipv4PrefixListResponse", "documentation": "One or more IPv4 prefixes assigned to the network interface.
", "locationName": "ipv4PrefixSet" }, "Ipv4PrefixCount": { "shape": "Integer", "documentation": "The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.
", "locationName": "ipv4PrefixCount" }, "Ipv6Prefixes": { "shape": "Ipv6PrefixListResponse", "documentation": "One or more IPv6 prefixes assigned to the network interface.
", "locationName": "ipv6PrefixSet" }, "Ipv6PrefixCount": { "shape": "Integer", "documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.
", "locationName": "ipv6PrefixCount" }, "PrimaryIpv6": { "shape": "Boolean", "documentation": "The primary IPv6 address of the network interface. 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 about primary IPv6 addresses, see RunInstances.
", "locationName": "primaryIpv6" }, "EnaSrdSpecification": { "shape": "LaunchTemplateEnaSrdSpecification", "documentation": "Contains the ENA Express settings for instances launched from your launch template.
", "locationName": "enaSrdSpecification" }, "ConnectionTrackingSpecification": { "shape": "ConnectionTrackingSpecification", "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.
", "locationName": "connectionTrackingSpecification" } }, "documentation": "Describes a network interface.
" }, "LaunchTemplateInstanceNetworkInterfaceSpecificationList": { "type": "list", "member": { "shape": "LaunchTemplateInstanceNetworkInterfaceSpecification", "locationName": "item" } }, "LaunchTemplateInstanceNetworkInterfaceSpecificationRequest": { "type": "structure", "members": { "AssociateCarrierIpAddress": { "shape": "Boolean", "documentation": "Associates a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
" }, "AssociatePublicIpAddress": { "shape": "Boolean", "documentation": "Associates a public IPv4 address with eth0 for a new network interface.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the network interface is deleted when the instance is terminated.
" }, "Description": { "shape": "String", "documentation": "A description for the network interface.
" }, "DeviceIndex": { "shape": "Integer", "documentation": "The device index for the network interface attachment.
" }, "Groups": { "shape": "SecurityGroupIdStringList", "documentation": "The IDs of one or more security groups.
", "locationName": "SecurityGroupId" }, "InterfaceType": { "shape": "String", "documentation": "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
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
" }, "Ipv6Addresses": { "shape": "InstanceIpv6AddressListRequest", "documentation": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
" }, "PrivateIpAddress": { "shape": "String", "documentation": "The primary private IPv4 address of the network interface.
" }, "PrivateIpAddresses": { "shape": "PrivateIpAddressSpecificationList", "documentation": "One or more private IPv4 addresses.
" }, "SecondaryPrivateIpAddressCount": { "shape": "Integer", "documentation": "The number of secondary private IPv4 addresses to assign to a network interface.
" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet for the network interface.
" }, "NetworkCardIndex": { "shape": "Integer", "documentation": "The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
" }, "Ipv4Prefixes": { "shape": "Ipv4PrefixList", "documentation": "One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
The primary IPv6 address of the network interface. 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 about primary IPv6 addresses, see RunInstances.
" }, "EnaSrdSpecification": { "shape": "EnaSrdSpecificationRequest", "documentation": "Configure ENA Express settings for your launch template.
" }, "ConnectionTrackingSpecification": { "shape": "ConnectionTrackingSpecificationRequest", "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.
" } }, "documentation": "The parameters for a network interface.
" }, "LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList": { "type": "list", "member": { "shape": "LaunchTemplateInstanceNetworkInterfaceSpecificationRequest", "locationName": "InstanceNetworkInterfaceSpecification" } }, "LaunchTemplateLicenseConfiguration": { "type": "structure", "members": { "LicenseConfigurationArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the license configuration.
", "locationName": "licenseConfigurationArn" } }, "documentation": "Describes a license configuration.
" }, "LaunchTemplateLicenseConfigurationRequest": { "type": "structure", "members": { "LicenseConfigurationArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the license configuration.
" } }, "documentation": "Describes a license configuration.
" }, "LaunchTemplateLicenseList": { "type": "list", "member": { "shape": "LaunchTemplateLicenseConfiguration", "locationName": "item" } }, "LaunchTemplateLicenseSpecificationListRequest": { "type": "list", "member": { "shape": "LaunchTemplateLicenseConfigurationRequest", "locationName": "item" } }, "LaunchTemplateName": { "type": "string", "max": 128, "min": 3, "pattern": "[a-zA-Z0-9\\(\\)\\.\\-/_]+" }, "LaunchTemplateNameStringList": { "type": "list", "member": { "shape": "LaunchTemplateName", "locationName": "item" } }, "LaunchTemplateOverrides": { "type": "structure", "members": { "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
", "locationName": "instanceType" }, "SpotPrice": { "shape": "String", "documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The ID of the subnet in which to launch the instances.
", "locationName": "subnetId" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which to launch the instances.
", "locationName": "availabilityZone" }, "WeightedCapacity": { "shape": "Double", "documentation": "The number of units provided by the specified instance type.
When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.
If you specify InstanceRequirements, you can't specify InstanceType.
Describes overrides for a launch template.
" }, "LaunchTemplateOverridesList": { "type": "list", "member": { "shape": "LaunchTemplateOverrides", "locationName": "item" } }, "LaunchTemplatePlacement": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone of the instance.
", "locationName": "availabilityZone" }, "Affinity": { "shape": "String", "documentation": "The affinity setting for the instance on the Dedicated Host.
", "locationName": "affinity" }, "GroupName": { "shape": "String", "documentation": "The name of the placement group for the instance.
", "locationName": "groupName" }, "HostId": { "shape": "String", "documentation": "The ID of the Dedicated Host for the instance.
", "locationName": "hostId" }, "Tenancy": { "shape": "Tenancy", "documentation": "The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
Reserved for future use.
", "locationName": "spreadDomain" }, "HostResourceGroupArn": { "shape": "String", "documentation": "The ARN of the host resource group in which to launch the instances.
", "locationName": "hostResourceGroupArn" }, "PartitionNumber": { "shape": "Integer", "documentation": "The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The Group ID of the placement group. You must specify the Placement Group Group ID to launch an instance in a shared placement group.
", "locationName": "groupId" } }, "documentation": "Describes the placement of an instance.
" }, "LaunchTemplatePlacementRequest": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone for the instance.
" }, "Affinity": { "shape": "String", "documentation": "The affinity setting for an instance on a Dedicated Host.
" }, "GroupName": { "shape": "PlacementGroupName", "documentation": "The name of the placement group for the instance.
" }, "HostId": { "shape": "DedicatedHostId", "documentation": "The ID of the Dedicated Host for the instance.
" }, "Tenancy": { "shape": "Tenancy", "documentation": "The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
" }, "SpreadDomain": { "shape": "String", "documentation": "Reserved for future use.
" }, "HostResourceGroupArn": { "shape": "String", "documentation": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
" } }, "documentation": "Describes the placement of an instance.
" }, "LaunchTemplatePrivateDnsNameOptions": { "type": "structure", "members": { "HostnameType": { "shape": "HostnameType", "documentation": "The type of hostname to assign to an instance.
", "locationName": "hostnameType" }, "EnableResourceNameDnsARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
", "locationName": "enableResourceNameDnsARecord" }, "EnableResourceNameDnsAAAARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
", "locationName": "enableResourceNameDnsAAAARecord" } }, "documentation": "Describes the options for instance hostnames.
" }, "LaunchTemplatePrivateDnsNameOptionsRequest": { "type": "structure", "members": { "HostnameType": { "shape": "HostnameType", "documentation": "The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
" }, "EnableResourceNameDnsARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
" }, "EnableResourceNameDnsAAAARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
" } }, "documentation": "Describes the options for instance hostnames.
" }, "LaunchTemplateSet": { "type": "list", "member": { "shape": "LaunchTemplate", "locationName": "item" } }, "LaunchTemplateSpecification": { "type": "structure", "members": { "LaunchTemplateId": { "shape": "LaunchTemplateId", "documentation": "The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "LaunchTemplateName": { "shape": "String", "documentation": "The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "Version": { "shape": "String", "documentation": "The launch template version number, $Latest, or $Default.
A value of $Latest uses the latest version of the launch template.
A value of $Default uses the default version of the launch template.
Default: The default version of the launch template.
" } }, "documentation": "Describes the launch template to use.
" }, "LaunchTemplateSpotMarketOptions": { "type": "structure", "members": { "MaxPrice": { "shape": "String", "documentation": "The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
The Spot Instance request type.
", "locationName": "spotInstanceType" }, "BlockDurationMinutes": { "shape": "Integer", "documentation": "The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
", "locationName": "blockDurationMinutes" }, "ValidUntil": { "shape": "DateTime", "documentation": "The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
", "locationName": "validUntil" }, "InstanceInterruptionBehavior": { "shape": "InstanceInterruptionBehavior", "documentation": "The behavior when a Spot Instance is interrupted.
", "locationName": "instanceInterruptionBehavior" } }, "documentation": "The options for Spot Instances.
" }, "LaunchTemplateSpotMarketOptionsRequest": { "type": "structure", "members": { "MaxPrice": { "shape": "String", "documentation": "The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
The Spot Instance request type.
" }, "BlockDurationMinutes": { "shape": "Integer", "documentation": "Deprecated.
" }, "ValidUntil": { "shape": "DateTime", "documentation": "The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, ValidUntil is not supported. The request remains active until all instances launch or you cancel the request.
Default: 7 days from the current date
" }, "InstanceInterruptionBehavior": { "shape": "InstanceInterruptionBehavior", "documentation": "The behavior when a Spot Instance is interrupted. The default is terminate.
The options for Spot Instances.
" }, "LaunchTemplateTagSpecification": { "type": "structure", "members": { "ResourceType": { "shape": "ResourceType", "documentation": "The type of resource to tag.
", "locationName": "resourceType" }, "Tags": { "shape": "TagList", "documentation": "The tags for the resource.
", "locationName": "tagSet" } }, "documentation": "The tags specification for the launch template.
" }, "LaunchTemplateTagSpecificationList": { "type": "list", "member": { "shape": "LaunchTemplateTagSpecification", "locationName": "item" } }, "LaunchTemplateTagSpecificationRequest": { "type": "structure", "members": { "ResourceType": { "shape": "ResourceType", "documentation": "The type of resource to tag.
Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only: instance | volume | network-interface | spot-instances-request. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.
To tag a resource after it has been created, see CreateTags.
" }, "Tags": { "shape": "TagList", "documentation": "The tags to apply to the resource.
", "locationName": "Tag" } }, "documentation": "The tags specification for the resources that are created during instance launch.
" }, "LaunchTemplateTagSpecificationRequestList": { "type": "list", "member": { "shape": "LaunchTemplateTagSpecificationRequest", "locationName": "LaunchTemplateTagSpecificationRequest" } }, "LaunchTemplateVersion": { "type": "structure", "members": { "LaunchTemplateId": { "shape": "String", "documentation": "The ID of the launch template.
", "locationName": "launchTemplateId" }, "LaunchTemplateName": { "shape": "LaunchTemplateName", "documentation": "The name of the launch template.
", "locationName": "launchTemplateName" }, "VersionNumber": { "shape": "Long", "documentation": "The version number.
", "locationName": "versionNumber" }, "VersionDescription": { "shape": "VersionDescription", "documentation": "The description for the version.
", "locationName": "versionDescription" }, "CreateTime": { "shape": "DateTime", "documentation": "The time the version was created.
", "locationName": "createTime" }, "CreatedBy": { "shape": "String", "documentation": "The principal that created the version.
", "locationName": "createdBy" }, "DefaultVersion": { "shape": "Boolean", "documentation": "Indicates whether the version is the default version.
", "locationName": "defaultVersion" }, "LaunchTemplateData": { "shape": "ResponseLaunchTemplateData", "documentation": "Information about the launch template.
", "locationName": "launchTemplateData" } }, "documentation": "Describes a launch template version.
" }, "LaunchTemplateVersionSet": { "type": "list", "member": { "shape": "LaunchTemplateVersion", "locationName": "item" } }, "LaunchTemplatesMonitoring": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
", "locationName": "enabled" } }, "documentation": "Describes the monitoring for the instance.
" }, "LaunchTemplatesMonitoringRequest": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
Describes the monitoring for the instance.
" }, "LicenseConfiguration": { "type": "structure", "members": { "LicenseConfigurationArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the license configuration.
", "locationName": "licenseConfigurationArn" } }, "documentation": "Describes a license configuration.
" }, "LicenseConfigurationRequest": { "type": "structure", "members": { "LicenseConfigurationArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the license configuration.
" } }, "documentation": "Describes a license configuration.
" }, "LicenseList": { "type": "list", "member": { "shape": "LicenseConfiguration", "locationName": "item" } }, "LicenseSpecificationListRequest": { "type": "list", "member": { "shape": "LicenseConfigurationRequest", "locationName": "item" } }, "ListImagesInRecycleBinMaxResults": { "type": "integer", "max": 1000, "min": 1 }, "ListImagesInRecycleBinRequest": { "type": "structure", "members": { "ImageIds": { "shape": "ImageIdStringList", "documentation": "The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request.
", "locationName": "ImageId" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "MaxResults": { "shape": "ListImagesInRecycleBinMaxResults", "documentation": "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.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the AMIs.
", "locationName": "imageSet" }, "NextToken": { "shape": "String", "documentation": "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.
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.
" }, "NextToken": { "shape": "String", "documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" }, "SnapshotIds": { "shape": "SnapshotIdStringList", "documentation": "The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
", "locationName": "SnapshotId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the snapshots.
", "locationName": "snapshotSet" }, "NextToken": { "shape": "String", "documentation": "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.
The Classic Load Balancers.
", "locationName": "classicLoadBalancersConfig" }, "TargetGroupsConfig": { "shape": "TargetGroupsConfig", "documentation": "The target groups.
", "locationName": "targetGroupsConfig" } }, "documentation": "Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.
" }, "LoadPermission": { "type": "structure", "members": { "UserId": { "shape": "String", "documentation": "The Amazon Web Services account ID.
", "locationName": "userId" }, "Group": { "shape": "PermissionGroup", "documentation": "The name of the group.
", "locationName": "group" } }, "documentation": "Describes a load permission.
" }, "LoadPermissionList": { "type": "list", "member": { "shape": "LoadPermission", "locationName": "item" } }, "LoadPermissionListRequest": { "type": "list", "member": { "shape": "LoadPermissionRequest", "locationName": "item" } }, "LoadPermissionModifications": { "type": "structure", "members": { "Add": { "shape": "LoadPermissionListRequest", "documentation": "The load permissions to add.
" }, "Remove": { "shape": "LoadPermissionListRequest", "documentation": "The load permissions to remove.
" } }, "documentation": "Describes modifications to the load permissions of an Amazon FPGA image (AFI).
" }, "LoadPermissionRequest": { "type": "structure", "members": { "Group": { "shape": "PermissionGroup", "documentation": "The name of the group.
" }, "UserId": { "shape": "String", "documentation": "The Amazon Web Services account ID.
" } }, "documentation": "Describes a load permission.
" }, "LocalGateway": { "type": "structure", "members": { "LocalGatewayId": { "shape": "LocalGatewayId", "documentation": "The ID of the local gateway.
", "locationName": "localGatewayId" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", "locationName": "outpostArn" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the local gateway.
", "locationName": "ownerId" }, "State": { "shape": "String", "documentation": "The state of the local gateway.
", "locationName": "state" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the local gateway.
", "locationName": "tagSet" } }, "documentation": "Describes a local gateway.
" }, "LocalGatewayId": { "type": "string" }, "LocalGatewayIdSet": { "type": "list", "member": { "shape": "LocalGatewayId", "locationName": "item" } }, "LocalGatewayMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "LocalGatewayRoute": { "type": "structure", "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR block used for destination matches.
", "locationName": "destinationCidrBlock" }, "LocalGatewayVirtualInterfaceGroupId": { "shape": "LocalGatewayVirtualInterfaceGroupId", "documentation": "The ID of the virtual interface group.
", "locationName": "localGatewayVirtualInterfaceGroupId" }, "Type": { "shape": "LocalGatewayRouteType", "documentation": "The route type.
", "locationName": "type" }, "State": { "shape": "LocalGatewayRouteState", "documentation": "The state of the route.
", "locationName": "state" }, "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
", "locationName": "localGatewayRouteTableId" }, "LocalGatewayRouteTableArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the local gateway route table.
", "locationName": "localGatewayRouteTableArn" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the local gateway route.
", "locationName": "ownerId" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "CoipPoolId": { "shape": "CoipPoolId", "documentation": "The ID of the customer-owned address pool.
", "locationName": "coipPoolId" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "DestinationPrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list.
", "locationName": "destinationPrefixListId" } }, "documentation": "Describes a route for a local gateway route table.
" }, "LocalGatewayRouteList": { "type": "list", "member": { "shape": "LocalGatewayRoute", "locationName": "item" } }, "LocalGatewayRouteState": { "type": "string", "enum": [ "pending", "active", "blackhole", "deleting", "deleted" ] }, "LocalGatewayRouteTable": { "type": "structure", "members": { "LocalGatewayRouteTableId": { "shape": "String", "documentation": "The ID of the local gateway route table.
", "locationName": "localGatewayRouteTableId" }, "LocalGatewayRouteTableArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the local gateway route table.
", "locationName": "localGatewayRouteTableArn" }, "LocalGatewayId": { "shape": "LocalGatewayId", "documentation": "The ID of the local gateway.
", "locationName": "localGatewayId" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", "locationName": "outpostArn" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the local gateway route table.
", "locationName": "ownerId" }, "State": { "shape": "String", "documentation": "The state of the local gateway route table.
", "locationName": "state" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the local gateway route table.
", "locationName": "tagSet" }, "Mode": { "shape": "LocalGatewayRouteTableMode", "documentation": "The mode of the local gateway route table.
", "locationName": "mode" }, "StateReason": { "shape": "StateReason", "documentation": "Information about the state change.
", "locationName": "stateReason" } }, "documentation": "Describes a local gateway route table.
" }, "LocalGatewayRouteTableIdSet": { "type": "list", "member": { "shape": "LocalGatewayRoutetableId", "locationName": "item" } }, "LocalGatewayRouteTableMode": { "type": "string", "enum": [ "direct-vpc-routing", "coip" ] }, "LocalGatewayRouteTableSet": { "type": "list", "member": { "shape": "LocalGatewayRouteTable", "locationName": "item" } }, "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { "type": "structure", "members": { "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { "shape": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", "documentation": "The ID of the association.
", "locationName": "localGatewayRouteTableVirtualInterfaceGroupAssociationId" }, "LocalGatewayVirtualInterfaceGroupId": { "shape": "LocalGatewayVirtualInterfaceGroupId", "documentation": "The ID of the virtual interface group.
", "locationName": "localGatewayVirtualInterfaceGroupId" }, "LocalGatewayId": { "shape": "String", "documentation": "The ID of the local gateway.
", "locationName": "localGatewayId" }, "LocalGatewayRouteTableId": { "shape": "LocalGatewayId", "documentation": "The ID of the local gateway route table.
", "locationName": "localGatewayRouteTableId" }, "LocalGatewayRouteTableArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
", "locationName": "localGatewayRouteTableArn" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
", "locationName": "ownerId" }, "State": { "shape": "String", "documentation": "The state of the association.
", "locationName": "state" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the association.
", "locationName": "tagSet" } }, "documentation": "Describes an association between a local gateway route table and a virtual interface group.
" }, "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { "type": "string" }, "LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet": { "type": "list", "member": { "shape": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", "locationName": "item" } }, "LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet": { "type": "list", "member": { "shape": "LocalGatewayRouteTableVirtualInterfaceGroupAssociation", "locationName": "item" } }, "LocalGatewayRouteTableVpcAssociation": { "type": "structure", "members": { "LocalGatewayRouteTableVpcAssociationId": { "shape": "LocalGatewayRouteTableVpcAssociationId", "documentation": "The ID of the association.
", "locationName": "localGatewayRouteTableVpcAssociationId" }, "LocalGatewayRouteTableId": { "shape": "String", "documentation": "The ID of the local gateway route table.
", "locationName": "localGatewayRouteTableId" }, "LocalGatewayRouteTableArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the local gateway route table for the association.
", "locationName": "localGatewayRouteTableArn" }, "LocalGatewayId": { "shape": "String", "documentation": "The ID of the local gateway.
", "locationName": "localGatewayId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the local gateway route table for the association.
", "locationName": "ownerId" }, "State": { "shape": "String", "documentation": "The state of the association.
", "locationName": "state" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the association.
", "locationName": "tagSet" } }, "documentation": "Describes an association between a local gateway route table and a VPC.
" }, "LocalGatewayRouteTableVpcAssociationId": { "type": "string" }, "LocalGatewayRouteTableVpcAssociationIdSet": { "type": "list", "member": { "shape": "LocalGatewayRouteTableVpcAssociationId", "locationName": "item" } }, "LocalGatewayRouteTableVpcAssociationSet": { "type": "list", "member": { "shape": "LocalGatewayRouteTableVpcAssociation", "locationName": "item" } }, "LocalGatewayRouteType": { "type": "string", "enum": [ "static", "propagated" ] }, "LocalGatewayRoutetableId": { "type": "string" }, "LocalGatewaySet": { "type": "list", "member": { "shape": "LocalGateway", "locationName": "item" } }, "LocalGatewayVirtualInterface": { "type": "structure", "members": { "LocalGatewayVirtualInterfaceId": { "shape": "LocalGatewayVirtualInterfaceId", "documentation": "The ID of the virtual interface.
", "locationName": "localGatewayVirtualInterfaceId" }, "LocalGatewayId": { "shape": "String", "documentation": "The ID of the local gateway.
", "locationName": "localGatewayId" }, "Vlan": { "shape": "Integer", "documentation": "The ID of the VLAN.
", "locationName": "vlan" }, "LocalAddress": { "shape": "String", "documentation": "The local address.
", "locationName": "localAddress" }, "PeerAddress": { "shape": "String", "documentation": "The peer address.
", "locationName": "peerAddress" }, "LocalBgpAsn": { "shape": "Integer", "documentation": "The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
", "locationName": "localBgpAsn" }, "PeerBgpAsn": { "shape": "Integer", "documentation": "The peer BGP ASN.
", "locationName": "peerBgpAsn" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the local gateway virtual interface.
", "locationName": "ownerId" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the virtual interface.
", "locationName": "tagSet" } }, "documentation": "Describes a local gateway virtual interface.
" }, "LocalGatewayVirtualInterfaceGroup": { "type": "structure", "members": { "LocalGatewayVirtualInterfaceGroupId": { "shape": "LocalGatewayVirtualInterfaceGroupId", "documentation": "The ID of the virtual interface group.
", "locationName": "localGatewayVirtualInterfaceGroupId" }, "LocalGatewayVirtualInterfaceIds": { "shape": "LocalGatewayVirtualInterfaceIdSet", "documentation": "The IDs of the virtual interfaces.
", "locationName": "localGatewayVirtualInterfaceIdSet" }, "LocalGatewayId": { "shape": "String", "documentation": "The ID of the local gateway.
", "locationName": "localGatewayId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
", "locationName": "ownerId" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the virtual interface group.
", "locationName": "tagSet" } }, "documentation": "Describes a local gateway virtual interface group.
" }, "LocalGatewayVirtualInterfaceGroupId": { "type": "string" }, "LocalGatewayVirtualInterfaceGroupIdSet": { "type": "list", "member": { "shape": "LocalGatewayVirtualInterfaceGroupId", "locationName": "item" } }, "LocalGatewayVirtualInterfaceGroupSet": { "type": "list", "member": { "shape": "LocalGatewayVirtualInterfaceGroup", "locationName": "item" } }, "LocalGatewayVirtualInterfaceId": { "type": "string" }, "LocalGatewayVirtualInterfaceIdSet": { "type": "list", "member": { "shape": "LocalGatewayVirtualInterfaceId", "locationName": "item" } }, "LocalGatewayVirtualInterfaceSet": { "type": "list", "member": { "shape": "LocalGatewayVirtualInterface", "locationName": "item" } }, "LocalStorage": { "type": "string", "enum": [ "included", "required", "excluded" ] }, "LocalStorageType": { "type": "string", "enum": [ "hdd", "ssd" ] }, "LocalStorageTypeSet": { "type": "list", "member": { "shape": "LocalStorageType", "locationName": "item" } }, "Location": { "type": "string" }, "LocationType": { "type": "string", "enum": [ "region", "availability-zone", "availability-zone-id", "outpost" ] }, "LockMode": { "type": "string", "enum": [ "compliance", "governance" ] }, "LockSnapshotRequest": { "type": "structure", "required": [ "SnapshotId", "LockMode" ], "members": { "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot to lock.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The mode in which to lock the snapshot. Specify one of the following:
governance - Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:
The lock duration expires.
The snapshot is unlocked by a user with the appropriate permissions.
Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to compliance at any time.
If you lock a snapshot in governance mode, omit CoolOffPeriod.
compliance - Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode to governance. However, users with appropriate IAM permissions can increase the lock duration at any time.
If you lock a snapshot in compliance mode, you can optionally specify CoolOffPeriod.
The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires.
The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter.
To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter.
If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails.
Allowed values: Min 1, max 72.
" }, "LockDuration": { "shape": "RetentionPeriodRequestDays", "documentation": "The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses.
You must specify either this parameter or ExpirationDate, but not both.
Allowed values: Min: 1, max 36500
" }, "ExpirationDate": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the snapshot lock is to automatically expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
You must specify either this parameter or LockDuration, but not both.
" } } }, "LockSnapshotResult": { "type": "structure", "members": { "SnapshotId": { "shape": "String", "documentation": "The ID of the snapshot
", "locationName": "snapshotId" }, "LockState": { "shape": "LockState", "documentation": "The state of the snapshot lock. Valid states include:
compliance-cooloff - The snapshot has been locked in compliance mode but it is still within the cooling-off period. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.
governance - The snapshot is locked in governance mode. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.
compliance - The snapshot is locked in compliance mode and the cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock duration can only be increased by users with appropriate permissions.
expired - The snapshot was locked in compliance or governance mode but the lock duration has expired. The snapshot is not locked and can be deleted.
The period of time for which the snapshot is locked, in days.
", "locationName": "lockDuration" }, "CoolOffPeriod": { "shape": "CoolOffPeriodResponseHours", "documentation": "The compliance mode cooling-off period, in hours.
", "locationName": "coolOffPeriod" }, "CoolOffPeriodExpiresOn": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the compliance mode cooling-off period expires, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the snapshot was locked, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the lock will expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the lock duration started, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The account ID of the Amazon Web Services account that owns the snapshot.
", "locationName": "ownerId" }, "SnapshotId": { "shape": "String", "documentation": "The ID of the snapshot.
", "locationName": "snapshotId" }, "LockState": { "shape": "LockState", "documentation": "The state of the snapshot lock. Valid states include:
compliance-cooloff - The snapshot has been locked in compliance mode but it is still within the cooling-off period. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.
governance - The snapshot is locked in governance mode. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.
compliance - The snapshot is locked in compliance mode and the cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock duration can only be increased by users with appropriate permissions.
expired - The snapshot was locked in compliance or governance mode but the lock duration has expired. The snapshot is not locked and can be deleted.
The period of time for which the snapshot is locked, in days.
", "locationName": "lockDuration" }, "CoolOffPeriod": { "shape": "CoolOffPeriodResponseHours", "documentation": "The compliance mode cooling-off period, in hours.
", "locationName": "coolOffPeriod" }, "CoolOffPeriodExpiresOn": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the compliance mode cooling-off period expires, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the snapshot was locked, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the lock duration started, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
If you lock a snapshot that is in the pending state, the lock duration starts only once the snapshot enters the completed state.
The date and time at which the lock will expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
Information about a locked snapshot.
" }, "LockedSnapshotsInfoList": { "type": "list", "member": { "shape": "LockedSnapshotsInfo", "locationName": "item" } }, "LogDestinationType": { "type": "string", "enum": [ "cloud-watch-logs", "s3", "kinesis-data-firehose" ] }, "Long": { "type": "long" }, "MacHost": { "type": "structure", "members": { "HostId": { "shape": "DedicatedHostId", "documentation": "The EC2 Mac Dedicated Host ID.
", "locationName": "hostId" }, "MacOSLatestSupportedVersions": { "shape": "MacOSVersionStringList", "documentation": "The latest macOS versions that the EC2 Mac Dedicated Host can launch without being upgraded.
", "locationName": "macOSLatestSupportedVersionSet" } }, "documentation": "Information about the EC2 Mac Dedicated Host.
" }, "MacHostList": { "type": "list", "member": { "shape": "MacHost", "locationName": "item" } }, "MacOSVersionStringList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "MaintenanceDetails": { "type": "structure", "members": { "PendingMaintenance": { "shape": "String", "documentation": "Verify existence of a pending maintenance.
", "locationName": "pendingMaintenance" }, "MaintenanceAutoAppliedAfter": { "shape": "MillisecondDateTime", "documentation": "The timestamp after which Amazon Web Services will automatically apply maintenance.
", "locationName": "maintenanceAutoAppliedAfter" }, "LastMaintenanceApplied": { "shape": "MillisecondDateTime", "documentation": "Timestamp of last applied maintenance.
", "locationName": "lastMaintenanceApplied" } }, "documentation": "Details for Site-to-Site VPN tunnel endpoint maintenance events.
" }, "ManagedPrefixList": { "type": "structure", "members": { "PrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list.
", "locationName": "prefixListId" }, "AddressFamily": { "shape": "String", "documentation": "The IP address version.
", "locationName": "addressFamily" }, "State": { "shape": "PrefixListState", "documentation": "The current state of the prefix list.
", "locationName": "state" }, "StateMessage": { "shape": "String", "documentation": "The state message.
", "locationName": "stateMessage" }, "PrefixListArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) for the prefix list.
", "locationName": "prefixListArn" }, "PrefixListName": { "shape": "String", "documentation": "The name of the prefix list.
", "locationName": "prefixListName" }, "MaxEntries": { "shape": "Integer", "documentation": "The maximum number of entries for the prefix list.
", "locationName": "maxEntries" }, "Version": { "shape": "Long", "documentation": "The version of the prefix list.
", "locationName": "version" }, "Tags": { "shape": "TagList", "documentation": "The tags for the prefix list.
", "locationName": "tagSet" }, "OwnerId": { "shape": "String", "documentation": "The ID of the owner of the prefix list.
", "locationName": "ownerId" } }, "documentation": "Describes a managed prefix list.
" }, "ManagedPrefixListSet": { "type": "list", "member": { "shape": "ManagedPrefixList", "locationName": "item" } }, "MarketType": { "type": "string", "enum": [ "spot", "capacity-block" ] }, "MaxIpv4AddrPerInterface": { "type": "integer" }, "MaxIpv6AddrPerInterface": { "type": "integer" }, "MaxNetworkInterfaces": { "type": "integer" }, "MaxResults": { "type": "integer" }, "MaxResultsParam": { "type": "integer", "max": 100, "min": 0 }, "MaximumBandwidthInMbps": { "type": "integer" }, "MaximumEfaInterfaces": { "type": "integer" }, "MaximumIops": { "type": "integer" }, "MaximumNetworkCards": { "type": "integer" }, "MaximumThroughputInMBps": { "type": "double" }, "MediaAcceleratorInfo": { "type": "structure", "members": { "Accelerators": { "shape": "MediaDeviceInfoList", "documentation": "Describes the media accelerators for the instance type.
", "locationName": "accelerators" }, "TotalMediaMemoryInMiB": { "shape": "TotalMediaMemory", "documentation": "The total size of the memory for the media accelerators for the instance type, in MiB.
", "locationName": "totalMediaMemoryInMiB" } }, "documentation": "Describes the media accelerators for the instance type.
" }, "MediaDeviceCount": { "type": "integer" }, "MediaDeviceInfo": { "type": "structure", "members": { "Count": { "shape": "MediaDeviceCount", "documentation": "The number of media accelerators for the instance type.
", "locationName": "count" }, "Name": { "shape": "MediaDeviceName", "documentation": "The name of the media accelerator.
", "locationName": "name" }, "Manufacturer": { "shape": "MediaDeviceManufacturerName", "documentation": "The manufacturer of the media accelerator.
", "locationName": "manufacturer" }, "MemoryInfo": { "shape": "MediaDeviceMemoryInfo", "documentation": "Describes the memory available to the media accelerator.
", "locationName": "memoryInfo" } }, "documentation": "Describes the media accelerators for the instance type.
" }, "MediaDeviceInfoList": { "type": "list", "member": { "shape": "MediaDeviceInfo", "locationName": "item" } }, "MediaDeviceManufacturerName": { "type": "string" }, "MediaDeviceMemoryInfo": { "type": "structure", "members": { "SizeInMiB": { "shape": "MediaDeviceMemorySize", "documentation": "The size of the memory available to each media accelerator, in MiB.
", "locationName": "sizeInMiB" } }, "documentation": "Describes the memory available to the media accelerator.
" }, "MediaDeviceMemorySize": { "type": "integer" }, "MediaDeviceName": { "type": "string" }, "MembershipType": { "type": "string", "enum": [ "static", "igmp" ] }, "MemoryGiBPerVCpu": { "type": "structure", "members": { "Min": { "shape": "Double", "documentation": "The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.
", "locationName": "min" }, "Max": { "shape": "Double", "documentation": "The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum amount of memory per vCPU, in GiB.
" }, "MemoryGiBPerVCpuRequest": { "type": "structure", "members": { "Min": { "shape": "Double", "documentation": "The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
" }, "Max": { "shape": "Double", "documentation": "The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
" } }, "documentation": "The minimum and maximum amount of memory per vCPU, in GiB.
" }, "MemoryInfo": { "type": "structure", "members": { "SizeInMiB": { "shape": "MemorySize", "documentation": "The size of the memory, in MiB.
", "locationName": "sizeInMiB" } }, "documentation": "Describes the memory for the instance type.
" }, "MemoryMiB": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.
", "locationName": "min" }, "Max": { "shape": "Integer", "documentation": "The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum amount of memory, in MiB.
" }, "MemoryMiBRequest": { "type": "structure", "required": [ "Min" ], "members": { "Min": { "shape": "Integer", "documentation": "The minimum amount of memory, in MiB. To specify no minimum limit, specify 0.
The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
" } }, "documentation": "The minimum and maximum amount of memory, in MiB.
" }, "MemorySize": { "type": "long" }, "MetadataDefaultHttpTokensState": { "type": "string", "enum": [ "optional", "required", "no-preference" ] }, "MetricPoint": { "type": "structure", "members": { "StartDate": { "shape": "MillisecondDateTime", "documentation": "The start date for the metric point. The starting date for the metric point. The starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.
The end date for the metric point. The ending time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.
The status of the metric point.
", "locationName": "status" } }, "documentation": "Indicates whether the network was healthy or degraded at a particular point. The value is aggregated from the startDate to the endDate. Currently only five_minutes is supported.
[EC2-VPC] The allocation ID.
" }, "DomainName": { "shape": "String", "documentation": "The domain name to modify for the IP address.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the Elastic IP address.
", "locationName": "address" } } }, "ModifyAvailabilityZoneGroupRequest": { "type": "structure", "required": [ "GroupName", "OptInStatus" ], "members": { "GroupName": { "shape": "String", "documentation": "The name of the Availability Zone group, Local Zone group, or Wavelength Zone group.
" }, "OptInStatus": { "shape": "ModifyAvailabilityZoneOptInStatus", "documentation": "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.
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.
Is true if the request succeeds, and an error otherwise.
The ID of the Capacity Reservation Fleet to modify.
" }, "TotalTargetCapacity": { "shape": "Integer", "documentation": "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.
" }, "EndDate": { "shape": "MillisecondDateTime", "documentation": "The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can't specify EndDate and RemoveEndDate in the same request.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.
You can't specify RemoveEndDate and EndDate in the same request.
" } } }, "ModifyCapacityReservationFleetResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The ID of the Capacity Reservation.
" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than 1000 in a single request.
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.
Reserved. Capacity Reservations you have created are accepted by default.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Reserved for future use.
" } } }, "ModifyCapacityReservationResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The ID of the Client VPN endpoint to modify.
" }, "ServerCertificateArn": { "shape": "String", "documentation": "The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).
" }, "ConnectionLogOptions": { "shape": "ConnectionLogOptions", "documentation": "Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
" }, "VpnPort": { "shape": "Integer", "documentation": "The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
A brief description of the Client VPN endpoint.
" }, "SplitTunnel": { "shape": "Boolean", "documentation": "Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of one or more security groups to apply to the target network.
", "locationName": "SecurityGroupId" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC to associate with the Client VPN endpoint.
" }, "SelfServicePortal": { "shape": "SelfServicePortal", "documentation": "Specify whether to enable the self-service portal for the Client VPN endpoint.
" }, "ClientConnectOptions": { "shape": "ClientConnectOptions", "documentation": "The options for managing connection authorization for new client connections.
" }, "SessionTimeoutHours": { "shape": "Integer", "documentation": "The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
" } } }, "ModifyClientVpnEndpointResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The instance family.
" }, "CpuCredits": { "shape": "String", "documentation": "The credit option for CPU usage of the instance family.
Valid Values: standard | unlimited
The default credit option for CPU usage of the instance family.
", "locationName": "instanceFamilyCreditSpecification" } } }, "ModifyEbsDefaultKmsKeyIdRequest": { "type": "structure", "required": [ "KmsKeyId" ], "members": { "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric KMS keys.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
", "locationName": "kmsKeyId" } } }, "ModifyFleetRequest": { "type": "structure", "required": [ "FleetId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Supported only for fleets of type maintain.
The launch template and overrides.
", "locationName": "LaunchTemplateConfig" }, "FleetId": { "shape": "FleetId", "documentation": "The ID of the EC2 Fleet.
" }, "TargetCapacitySpecification": { "shape": "TargetCapacitySpecificationRequest", "documentation": "The size of the EC2 Fleet.
" }, "Context": { "shape": "String", "documentation": "Reserved.
" } } }, "ModifyFleetResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.
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.
The ID of the AFI.
" }, "Attribute": { "shape": "FpgaImageAttributeName", "documentation": "The name of the attribute.
" }, "OperationType": { "shape": "OperationType", "documentation": "The operation type.
" }, "UserIds": { "shape": "UserIdStringList", "documentation": "The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
The user groups. This parameter is valid only when modifying the loadPermission attribute.
The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute.
The load permission for the AFI.
" }, "Description": { "shape": "String", "documentation": "A description for the AFI.
" }, "Name": { "shape": "String", "documentation": "A name for the AFI.
" } } }, "ModifyFpgaImageAttributeResult": { "type": "structure", "members": { "FpgaImageAttribute": { "shape": "FpgaImageAttribute", "documentation": "Information about the attribute.
", "locationName": "fpgaImageAttribute" } } }, "ModifyHostsRequest": { "type": "structure", "required": [ "HostIds" ], "members": { "AutoPlacement": { "shape": "AutoPlacement", "documentation": "Specify whether to enable or disable auto-placement.
", "locationName": "autoPlacement" }, "HostIds": { "shape": "RequestHostIdList", "documentation": "The IDs of the Dedicated Hosts to modify.
", "locationName": "hostId" }, "HostRecovery": { "shape": "HostRecovery", "documentation": "Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.
" }, "InstanceType": { "shape": "String", "documentation": "Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.
If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
" }, "InstanceFamily": { "shape": "String", "documentation": "Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
" }, "HostMaintenance": { "shape": "HostMaintenance", "documentation": "Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
" } } }, "ModifyHostsResult": { "type": "structure", "members": { "Successful": { "shape": "ResponseHostIdList", "documentation": "The IDs of the Dedicated Hosts that were successfully modified.
", "locationName": "successful" }, "Unsuccessful": { "shape": "UnsuccessfulItemList", "documentation": "The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
", "locationName": "unsuccessful" } } }, "ModifyIdFormatRequest": { "type": "structure", "required": [ "Resource", "UseLongIds" ], "members": { "Resource": { "shape": "String", "documentation": "The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Indicate whether the resource should use longer IDs (17-character IDs).
" } } }, "ModifyIdentityIdFormatRequest": { "type": "structure", "required": [ "PrincipalArn", "Resource", "UseLongIds" ], "members": { "PrincipalArn": { "shape": "String", "documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Indicates whether the resource should use longer IDs (17-character IDs)
", "locationName": "useLongIds" } } }, "ModifyImageAttributeRequest": { "type": "structure", "required": [ "ImageId" ], "members": { "Attribute": { "shape": "String", "documentation": "The name of the attribute to modify.
Valid values: description | imdsSupport | launchPermission
A new description for the AMI.
" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI.
" }, "LaunchPermission": { "shape": "LaunchPermissionModifications", "documentation": "A new launch permission for the AMI.
" }, "OperationType": { "shape": "OperationType", "documentation": "The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
Not supported.
", "locationName": "ProductCode" }, "UserGroups": { "shape": "UserGroupStringList", "documentation": "The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.
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.
The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.
Contains the parameters for ModifyImageAttribute.
" }, "ModifyInstanceAttributeRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "SourceDestCheck": { "shape": "AttributeBooleanValue", "documentation": "Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
The name of the attribute to modify.
You can modify the following attributes only: disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions
Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated. You can't modify the DeleteOnTermination attribute for volumes that are attached to Fargate tasks.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
", "locationName": "blockDeviceMapping" }, "DisableApiTermination": { "shape": "AttributeBooleanValue", "documentation": "If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.
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.
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
", "locationName": "ebsOptimized" }, "EnaSupport": { "shape": "AttributeBooleanValue", "documentation": "Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
", "locationName": "enaSupport" }, "Groups": { "shape": "GroupIdStringList", "documentation": "Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC.
", "locationName": "GroupId" }, "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "InstanceInitiatedShutdownBehavior": { "shape": "AttributeValue", "documentation": "Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", "locationName": "instanceInitiatedShutdownBehavior" }, "InstanceType": { "shape": "AttributeValue", "documentation": "Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
", "locationName": "kernel" }, "Ramdisk": { "shape": "AttributeValue", "documentation": "Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
", "locationName": "ramdisk" }, "SriovNetSupport": { "shape": "AttributeValue", "documentation": "Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
", "locationName": "sriovNetSupport" }, "UserData": { "shape": "BlobAttributeValue", "documentation": "Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
", "locationName": "userData" }, "Value": { "shape": "String", "documentation": "A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.
" } } }, "ModifyInstanceCapacityReservationAttributesRequest": { "type": "structure", "required": [ "InstanceId", "CapacityReservationSpecification" ], "members": { "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance to be modified.
" }, "CapacityReservationSpecification": { "shape": "CapacityReservationSpecification", "documentation": "Information about the Capacity Reservation targeting option.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
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.
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
" }, "InstanceCreditSpecifications": { "shape": "InstanceCreditSpecificationListRequest", "documentation": "Information about the credit option for CPU usage.
", "locationName": "InstanceCreditSpecification" } } }, "ModifyInstanceCreditSpecificationResult": { "type": "structure", "members": { "SuccessfulInstanceCreditSpecifications": { "shape": "SuccessfulInstanceCreditSpecificationSet", "documentation": "Information about the instances whose credit option for CPU usage was successfully modified.
", "locationName": "successfulInstanceCreditSpecificationSet" }, "UnsuccessfulInstanceCreditSpecifications": { "shape": "UnsuccessfulInstanceCreditSpecificationSet", "documentation": "Information about the instances whose credit option for CPU usage was not modified.
", "locationName": "unsuccessfulInstanceCreditSpecificationSet" } } }, "ModifyInstanceEventStartTimeRequest": { "type": "structure", "required": [ "InstanceId", "InstanceEventId", "NotBefore" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance with the scheduled event.
" }, "InstanceEventId": { "shape": "String", "documentation": "The ID of the event whose date and time you are modifying.
" }, "NotBefore": { "shape": "DateTime", "documentation": "The new date and time when the event will take place.
" } } }, "ModifyInstanceEventStartTimeResult": { "type": "structure", "members": { "Event": { "shape": "InstanceStatusEvent", "documentation": "Information about the event.
", "locationName": "event" } } }, "ModifyInstanceEventWindowRequest": { "type": "structure", "required": [ "InstanceEventWindowId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The name of the event window.
" }, "InstanceEventWindowId": { "shape": "InstanceEventWindowId", "documentation": "The ID of the event window.
" }, "TimeRanges": { "shape": "InstanceEventWindowTimeRangeRequestSet", "documentation": "The time ranges of the event window.
", "locationName": "TimeRange" }, "CronExpression": { "shape": "InstanceEventWindowCronExpression", "documentation": "The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
" } } }, "ModifyInstanceEventWindowResult": { "type": "structure", "members": { "InstanceEventWindow": { "shape": "InstanceEventWindow", "documentation": "Information about the event window.
", "locationName": "instanceEventWindow" } } }, "ModifyInstanceMaintenanceOptionsRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance.
" }, "AutoRecovery": { "shape": "InstanceAutoRecoveryState", "documentation": "Disables the automatic recovery behavior of your instance or sets it to default.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance.
", "locationName": "instanceId" }, "AutoRecovery": { "shape": "InstanceAutoRecoveryState", "documentation": "Provides information on the current automatic recovery behavior of your instance.
", "locationName": "autoRecovery" } } }, "ModifyInstanceMetadataDefaultsRequest": { "type": "structure", "members": { "HttpTokens": { "shape": "MetadataDefaultHttpTokensState", "documentation": "Indicates whether IMDSv2 is required.
optional – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.
required – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1.
Possible values: Integers from 1 to 64, and -1 to indicate no preference
Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.
" }, "InstanceMetadataTags": { "shape": "DefaultInstanceMetadataTagsState", "documentation": "Enables or disables access to an instance's tags from the instance metadata. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.
The ID of the instance.
" }, "HttpTokens": { "shape": "HttpTokensState", "documentation": "Indicates whether IMDSv2 is required.
optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.
required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default:
If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.
If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.
The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
" }, "HttpPutResponseHopLimit": { "shape": "Integer", "documentation": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
" }, "HttpEndpoint": { "shape": "InstanceMetadataEndpointState", "documentation": "Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of disabled, you cannot access your instance metadata.
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.
Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
" }, "InstanceMetadataTags": { "shape": "InstanceMetadataTagsState", "documentation": "Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
The ID of the instance.
", "locationName": "instanceId" }, "InstanceMetadataOptions": { "shape": "InstanceMetadataOptionsResponse", "documentation": "The metadata options for the instance.
", "locationName": "instanceMetadataOptions" } } }, "ModifyInstancePlacementRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "Affinity": { "shape": "Affinity", "documentation": "The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
", "locationName": "affinity" }, "GroupName": { "shape": "PlacementGroupName", "documentation": "The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string (\"\").
" }, "HostId": { "shape": "DedicatedHostId", "documentation": "The ID of the Dedicated Host with which to associate the instance.
", "locationName": "hostId" }, "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance that you are modifying.
", "locationName": "instanceId" }, "Tenancy": { "shape": "HostTenancy", "documentation": "The tenancy for the instance.
For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.
The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition.
The ARN of the host resource group in which to place the instance. The instance must have a tenancy of host to specify this parameter.
The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
" } } }, "ModifyInstancePlacementResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Is true if the request succeeds, and an error otherwise.
A check for 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.
The ID of the IPAM pool you want to modify.
" }, "Description": { "shape": "String", "documentation": "The description of the IPAM pool you want to modify.
" }, "AutoImport": { "shape": "Boolean", "documentation": "If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
" }, "AllocationMinNetmaskLength": { "shape": "IpamNetmaskLength", "documentation": "The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
" }, "AllocationMaxNetmaskLength": { "shape": "IpamNetmaskLength", "documentation": "The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
" }, "AllocationDefaultNetmaskLength": { "shape": "IpamNetmaskLength", "documentation": "The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
" }, "ClearAllocationDefaultNetmaskLength": { "shape": "Boolean", "documentation": "Clear the default netmask length allocation rule for this pool.
" }, "AddAllocationResourceTags": { "shape": "RequestIpamResourceTagList", "documentation": "Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
", "locationName": "AddAllocationResourceTag" }, "RemoveAllocationResourceTags": { "shape": "RequestIpamResourceTagList", "documentation": "Remove tag allocation rules from a pool.
", "locationName": "RemoveAllocationResourceTag" } } }, "ModifyIpamPoolResult": { "type": "structure", "members": { "IpamPool": { "shape": "IpamPool", "documentation": "The results of the modification.
", "locationName": "ipamPool" } } }, "ModifyIpamRequest": { "type": "structure", "required": [ "IpamId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the IPAM you want to modify.
" }, "Description": { "shape": "String", "documentation": "The description of the IPAM you want to modify.
" }, "AddOperatingRegions": { "shape": "AddIpamOperatingRegionSet", "documentation": "Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
", "locationName": "AddOperatingRegion" }, "RemoveOperatingRegions": { "shape": "RemoveIpamOperatingRegionSet", "documentation": "The operating Regions to remove.
", "locationName": "RemoveOperatingRegion" }, "Tier": { "shape": "IpamTier", "documentation": "IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
" } } }, "ModifyIpamResourceCidrRequest": { "type": "structure", "required": [ "ResourceId", "ResourceCidr", "ResourceRegion", "CurrentIpamScopeId", "Monitored" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the resource you want to modify.
" }, "ResourceCidr": { "shape": "String", "documentation": "The CIDR of the resource you want to modify.
" }, "ResourceRegion": { "shape": "String", "documentation": "The Amazon Web Services Region of the resource you want to modify.
" }, "CurrentIpamScopeId": { "shape": "IpamScopeId", "documentation": "The ID of the current scope that the resource CIDR is in.
" }, "DestinationIpamScopeId": { "shape": "IpamScopeId", "documentation": "The ID of the scope you want to transfer the resource CIDR to.
" }, "Monitored": { "shape": "Boolean", "documentation": "Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.
" } } }, "ModifyIpamResourceCidrResult": { "type": "structure", "members": { "IpamResourceCidr": { "shape": "IpamResourceCidr", "documentation": "The CIDR of the resource.
", "locationName": "ipamResourceCidr" } } }, "ModifyIpamResourceDiscoveryRequest": { "type": "structure", "required": [ "IpamResourceDiscoveryId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
A resource discovery ID.
" }, "Description": { "shape": "String", "documentation": "A resource discovery description.
" }, "AddOperatingRegions": { "shape": "AddIpamOperatingRegionSet", "documentation": "Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
", "locationName": "AddOperatingRegion" }, "RemoveOperatingRegions": { "shape": "RemoveIpamOperatingRegionSet", "documentation": "Remove operating Regions.
", "locationName": "RemoveOperatingRegion" } } }, "ModifyIpamResourceDiscoveryResult": { "type": "structure", "members": { "IpamResourceDiscovery": { "shape": "IpamResourceDiscovery", "documentation": "A resource discovery.
", "locationName": "ipamResourceDiscovery" } } }, "ModifyIpamResult": { "type": "structure", "members": { "Ipam": { "shape": "Ipam", "documentation": "The results of the modification.
", "locationName": "ipam" } } }, "ModifyIpamScopeRequest": { "type": "structure", "required": [ "IpamScopeId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the scope you want to modify.
" }, "Description": { "shape": "String", "documentation": "The description of the scope you want to modify.
" } } }, "ModifyIpamScopeResult": { "type": "structure", "members": { "IpamScope": { "shape": "IpamScope", "documentation": "The results of the modification.
", "locationName": "ipamScope" } } }, "ModifyLaunchTemplateRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
" }, "LaunchTemplateId": { "shape": "LaunchTemplateId", "documentation": "The ID of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "LaunchTemplateName": { "shape": "LaunchTemplateName", "documentation": "The name of the launch template.
You must specify either the launch template ID or the launch template name, but not both.
" }, "DefaultVersion": { "shape": "String", "documentation": "The version number of the launch template to set as the default version.
", "locationName": "SetDefaultVersion" } } }, "ModifyLaunchTemplateResult": { "type": "structure", "members": { "LaunchTemplate": { "shape": "LaunchTemplate", "documentation": "Information about the launch template.
", "locationName": "launchTemplate" } } }, "ModifyLocalGatewayRouteRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table.
" }, "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
" }, "LocalGatewayVirtualInterfaceGroupId": { "shape": "LocalGatewayVirtualInterfaceGroupId", "documentation": "The ID of the virtual interface group.
" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.
Information about the local gateway route table.
", "locationName": "route" } } }, "ModifyManagedPrefixListRequest": { "type": "structure", "required": [ "PrefixListId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the prefix list.
" }, "CurrentVersion": { "shape": "Long", "documentation": "The current version of the prefix list.
" }, "PrefixListName": { "shape": "String", "documentation": "A name for the prefix list.
" }, "AddEntries": { "shape": "AddPrefixListEntries", "documentation": "One or more entries to add to the prefix list.
", "locationName": "AddEntry" }, "RemoveEntries": { "shape": "RemovePrefixListEntries", "documentation": "One or more entries to remove from the prefix list.
", "locationName": "RemoveEntry" }, "MaxEntries": { "shape": "Integer", "documentation": "The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
" } } }, "ModifyManagedPrefixListResult": { "type": "structure", "members": { "PrefixList": { "shape": "ManagedPrefixList", "documentation": "Information about the prefix list.
", "locationName": "prefixList" } } }, "ModifyNetworkInterfaceAttributeRequest": { "type": "structure", "required": [ "NetworkInterfaceId" ], "members": { "Attachment": { "shape": "NetworkInterfaceAttachmentChanges", "documentation": "Information about the interface attachment. If modifying the delete on termination attribute, you must specify the ID of the interface attachment.
A description for the network interface.
", "locationName": "description" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
", "locationName": "SecurityGroupId" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "SourceDestCheck": { "shape": "AttributeBooleanValue", "documentation": "Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
Updates the ENA Express configuration for the network interface that’s attached to the instance.
" }, "EnablePrimaryIpv6": { "shape": "Boolean", "documentation": "If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
" }, "ConnectionTrackingSpecification": { "shape": "ConnectionTrackingSpecificationRequest", "documentation": "A connection tracking specification.
" }, "AssociatePublicIpAddress": { "shape": "Boolean", "documentation": "Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
" } }, "documentation": "Contains the parameters for ModifyNetworkInterfaceAttribute.
" }, "ModifyPrivateDnsNameOptionsRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the instance.
" }, "PrivateDnsHostnameType": { "shape": "HostnameType", "documentation": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
" }, "EnableResourceNameDnsARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
" }, "EnableResourceNameDnsAAAARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
" } } }, "ModifyPrivateDnsNameOptionsResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The IDs of the Reserved Instances to modify.
", "locationName": "ReservedInstancesId" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "locationName": "clientToken" }, "TargetConfigurations": { "shape": "ReservedInstancesConfigurationList", "documentation": "The configuration settings for the Reserved Instances to modify.
", "locationName": "ReservedInstancesConfigurationSetItemType" } }, "documentation": "Contains the parameters for ModifyReservedInstances.
" }, "ModifyReservedInstancesResult": { "type": "structure", "members": { "ReservedInstancesModificationId": { "shape": "String", "documentation": "The ID for the modification.
", "locationName": "reservedInstancesModificationId" } }, "documentation": "Contains the output of ModifyReservedInstances.
" }, "ModifySecurityGroupRulesRequest": { "type": "structure", "required": [ "GroupId", "SecurityGroupRules" ], "members": { "GroupId": { "shape": "SecurityGroupId", "documentation": "The ID of the security group.
" }, "SecurityGroupRules": { "shape": "SecurityGroupRuleUpdateList", "documentation": "Information about the security group properties to update.
", "locationName": "SecurityGroupRule" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, returns an error.
The snapshot attribute to modify. Only volume creation permissions can be modified.
" }, "CreateVolumePermission": { "shape": "CreateVolumePermissionModifications", "documentation": "A JSON representation of the snapshot attribute modification.
" }, "GroupNames": { "shape": "GroupNameStringList", "documentation": "The group to modify for the snapshot.
", "locationName": "UserGroup" }, "OperationType": { "shape": "OperationType", "documentation": "The type of operation to perform to the attribute.
" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot.
" }, "UserIds": { "shape": "UserIdStringList", "documentation": "The account ID to modify for the snapshot.
", "locationName": "UserId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the snapshot.
" }, "StorageTier": { "shape": "TargetStorageTier", "documentation": "The name of the storage tier. You must specify archive.
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.
The ID of the snapshot.
", "locationName": "snapshotId" }, "TieringStartTime": { "shape": "MillisecondDateTime", "documentation": "The date and time when the archive process was started.
", "locationName": "tieringStartTime" } } }, "ModifySpotFleetRequestRequest": { "type": "structure", "required": [ "SpotFleetRequestId" ], "members": { "ExcessCapacityTerminationPolicy": { "shape": "ExcessCapacityTerminationPolicy", "documentation": "Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.
The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" }, "TargetCapacity": { "shape": "Integer", "documentation": "The size of the fleet.
", "locationName": "targetCapacity" }, "OnDemandTargetCapacity": { "shape": "Integer", "documentation": "The number of On-Demand Instances in the fleet.
" }, "Context": { "shape": "String", "documentation": "Reserved.
" } }, "documentation": "Contains the parameters for ModifySpotFleetRequest.
" }, "ModifySpotFleetRequestResponse": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.
Contains the output of ModifySpotFleetRequest.
" }, "ModifySubnetAttributeRequest": { "type": "structure", "required": [ "SubnetId" ], "members": { "AssignIpv6AddressOnCreation": { "shape": "AttributeBooleanValue", "documentation": "Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API.
Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "MapCustomerOwnedIpOnLaunch": { "shape": "AttributeBooleanValue", "documentation": "Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
" }, "PrivateDnsHostnameTypeOnLaunch": { "shape": "HostnameType", "documentation": "The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).
" }, "EnableResourceNameDnsARecordOnLaunch": { "shape": "AttributeBooleanValue", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
" }, "EnableResourceNameDnsAAAARecordOnLaunch": { "shape": "AttributeBooleanValue", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
" }, "EnableLniAtDeviceIndex": { "shape": "Integer", "documentation": " Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0).
Specify true to indicate that local network interfaces at the current position should be disabled.
The ID of the Traffic Mirror filter.
" }, "AddNetworkServices": { "shape": "TrafficMirrorNetworkServiceList", "documentation": "The network service, for example Amazon DNS, that you want to mirror.
", "locationName": "AddNetworkService" }, "RemoveNetworkServices": { "shape": "TrafficMirrorNetworkServiceList", "documentation": "The network service, for example Amazon DNS, that you no longer want to mirror.
", "locationName": "RemoveNetworkService" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The Traffic Mirror filter that the network service is associated with.
", "locationName": "trafficMirrorFilter" } } }, "ModifyTrafficMirrorFilterRuleRequest": { "type": "structure", "required": [ "TrafficMirrorFilterRuleId" ], "members": { "TrafficMirrorFilterRuleId": { "shape": "TrafficMirrorFilterRuleIdWithResolver", "documentation": "The ID of the Traffic Mirror rule.
" }, "TrafficDirection": { "shape": "TrafficDirection", "documentation": "The type of traffic to assign to the rule.
" }, "RuleNumber": { "shape": "Integer", "documentation": "The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
" }, "RuleAction": { "shape": "TrafficMirrorRuleAction", "documentation": "The action to assign to the rule.
" }, "DestinationPortRange": { "shape": "TrafficMirrorPortRangeRequest", "documentation": "The destination ports that are associated with the Traffic Mirror rule.
" }, "SourcePortRange": { "shape": "TrafficMirrorPortRangeRequest", "documentation": "The port range to assign to the Traffic Mirror rule.
" }, "Protocol": { "shape": "Integer", "documentation": "The protocol, for example TCP, to assign to the Traffic Mirror rule.
" }, "DestinationCidrBlock": { "shape": "String", "documentation": "The destination CIDR block to assign to the Traffic Mirror rule.
" }, "SourceCidrBlock": { "shape": "String", "documentation": "The source CIDR block to assign to the Traffic Mirror rule.
" }, "Description": { "shape": "String", "documentation": "The description to assign to the Traffic Mirror rule.
" }, "RemoveFields": { "shape": "TrafficMirrorFilterRuleFieldList", "documentation": "The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
", "locationName": "RemoveField" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Modifies a Traffic Mirror rule.
", "locationName": "trafficMirrorFilterRule" } } }, "ModifyTrafficMirrorSessionRequest": { "type": "structure", "required": [ "TrafficMirrorSessionId" ], "members": { "TrafficMirrorSessionId": { "shape": "TrafficMirrorSessionId", "documentation": "The ID of the Traffic Mirror session.
" }, "TrafficMirrorTargetId": { "shape": "TrafficMirrorTargetId", "documentation": "The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
" }, "TrafficMirrorFilterId": { "shape": "TrafficMirrorFilterId", "documentation": "The ID of the Traffic Mirror filter.
" }, "PacketLength": { "shape": "Integer", "documentation": "The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
For sessions with Network Load Balancer (NLB) traffic mirror targets, the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
" }, "VirtualNetworkId": { "shape": "Integer", "documentation": "The virtual network ID of the Traffic Mirror session.
" }, "Description": { "shape": "String", "documentation": "The description to assign to the Traffic Mirror session.
" }, "RemoveFields": { "shape": "TrafficMirrorSessionFieldList", "documentation": "The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
", "locationName": "RemoveField" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the Traffic Mirror session.
", "locationName": "trafficMirrorSession" } } }, "ModifyTransitGatewayOptions": { "type": "structure", "members": { "AddTransitGatewayCidrBlocks": { "shape": "TransitGatewayCidrBlockStringList", "documentation": "Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
" }, "RemoveTransitGatewayCidrBlocks": { "shape": "TransitGatewayCidrBlockStringList", "documentation": "Removes CIDR blocks for the transit gateway.
" }, "VpnEcmpSupport": { "shape": "VpnEcmpSupportValue", "documentation": "Enable or disable Equal Cost Multipath Protocol support.
" }, "DnsSupport": { "shape": "DnsSupportValue", "documentation": "Enable or disable DNS support.
" }, "SecurityGroupReferencingSupport": { "shape": "SecurityGroupReferencingSupportValue", "documentation": "This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
" }, "AutoAcceptSharedAttachments": { "shape": "AutoAcceptSharedAttachmentsValue", "documentation": "Enable or disable automatic acceptance of attachment requests.
" }, "DefaultRouteTableAssociation": { "shape": "DefaultRouteTableAssociationValue", "documentation": "Enable or disable automatic association with the default association route table.
" }, "AssociationDefaultRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the default association route table.
" }, "DefaultRouteTablePropagation": { "shape": "DefaultRouteTablePropagationValue", "documentation": "Enable or disable automatic propagation of routes to the default propagation route table.
" }, "PropagationDefaultRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the default propagation route table.
" }, "AmazonSideAsn": { "shape": "Long", "documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
The modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.
" } }, "documentation": "The transit gateway options.
" }, "ModifyTransitGatewayPrefixListReferenceRequest": { "type": "structure", "required": [ "TransitGatewayRouteTableId", "PrefixListId" ], "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
" }, "PrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment to which traffic is routed.
" }, "Blackhole": { "shape": "Boolean", "documentation": "Indicates whether to drop traffic that matches this route.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the prefix list reference.
", "locationName": "transitGatewayPrefixListReference" } } }, "ModifyTransitGatewayRequest": { "type": "structure", "required": [ "TransitGatewayId" ], "members": { "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
" }, "Description": { "shape": "String", "documentation": "The description for the transit gateway.
" }, "Options": { "shape": "ModifyTransitGatewayOptions", "documentation": "The options to modify.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateway.
", "locationName": "transitGateway" } } }, "ModifyTransitGatewayVpcAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "AddSubnetIds": { "shape": "TransitGatewaySubnetIdList", "documentation": "The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
" }, "RemoveSubnetIds": { "shape": "TransitGatewaySubnetIdList", "documentation": "The IDs of one or more subnets to remove.
" }, "Options": { "shape": "ModifyTransitGatewayVpcAttachmentRequestOptions", "documentation": "The new VPC attachment options.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Enable or disable DNS support. The default is enable.
This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
" }, "Ipv6Support": { "shape": "Ipv6SupportValue", "documentation": "Enable or disable IPv6 support. The default is enable.
Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.
Describes the options for a VPC attachment.
" }, "ModifyTransitGatewayVpcAttachmentResult": { "type": "structure", "members": { "TransitGatewayVpcAttachment": { "shape": "TransitGatewayVpcAttachment", "documentation": "Information about the modified attachment.
", "locationName": "transitGatewayVpcAttachment" } } }, "ModifyVerifiedAccessEndpointEniOptions": { "type": "structure", "members": { "Protocol": { "shape": "VerifiedAccessEndpointProtocol", "documentation": "The IP protocol.
" }, "Port": { "shape": "VerifiedAccessEndpointPortNumber", "documentation": "The IP port number.
" } }, "documentation": "Describes the options when modifying a Verified Access endpoint with the network-interface type.
The IDs of the subnets.
", "locationName": "SubnetId" }, "Protocol": { "shape": "VerifiedAccessEndpointProtocol", "documentation": "The IP protocol.
" }, "Port": { "shape": "VerifiedAccessEndpointPortNumber", "documentation": "The IP port number.
" } }, "documentation": "Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the load-balancer type.
The ID of the Verified Access endpoint.
" }, "PolicyEnabled": { "shape": "Boolean", "documentation": "The status of the Verified Access policy.
" }, "PolicyDocument": { "shape": "String", "documentation": "The Verified Access policy document.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The options for server side encryption.
" } } }, "ModifyVerifiedAccessEndpointPolicyResult": { "type": "structure", "members": { "PolicyEnabled": { "shape": "Boolean", "documentation": "The status of the Verified Access policy.
", "locationName": "policyEnabled" }, "PolicyDocument": { "shape": "String", "documentation": "The Verified Access policy document.
", "locationName": "policyDocument" }, "SseSpecification": { "shape": "VerifiedAccessSseSpecificationResponse", "documentation": "The options in use for server side encryption.
", "locationName": "sseSpecification" } } }, "ModifyVerifiedAccessEndpointRequest": { "type": "structure", "required": [ "VerifiedAccessEndpointId" ], "members": { "VerifiedAccessEndpointId": { "shape": "VerifiedAccessEndpointId", "documentation": "The ID of the Verified Access endpoint.
" }, "VerifiedAccessGroupId": { "shape": "VerifiedAccessGroupId", "documentation": "The ID of the Verified Access group.
" }, "LoadBalancerOptions": { "shape": "ModifyVerifiedAccessEndpointLoadBalancerOptions", "documentation": "The load balancer details if creating the Verified Access endpoint as load-balancertype.
The network interface options.
" }, "Description": { "shape": "String", "documentation": "A description for the Verified Access endpoint.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access endpoint.
", "locationName": "verifiedAccessEndpoint" } } }, "ModifyVerifiedAccessEndpointSubnetIdList": { "type": "list", "member": { "shape": "SubnetId", "locationName": "item" } }, "ModifyVerifiedAccessGroupPolicyRequest": { "type": "structure", "required": [ "VerifiedAccessGroupId" ], "members": { "VerifiedAccessGroupId": { "shape": "VerifiedAccessGroupId", "documentation": "The ID of the Verified Access group.
" }, "PolicyEnabled": { "shape": "Boolean", "documentation": "The status of the Verified Access policy.
" }, "PolicyDocument": { "shape": "String", "documentation": "The Verified Access policy document.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The options for server side encryption.
" } } }, "ModifyVerifiedAccessGroupPolicyResult": { "type": "structure", "members": { "PolicyEnabled": { "shape": "Boolean", "documentation": "The status of the Verified Access policy.
", "locationName": "policyEnabled" }, "PolicyDocument": { "shape": "String", "documentation": "The Verified Access policy document.
", "locationName": "policyDocument" }, "SseSpecification": { "shape": "VerifiedAccessSseSpecificationResponse", "documentation": "The options in use for server side encryption.
", "locationName": "sseSpecification" } } }, "ModifyVerifiedAccessGroupRequest": { "type": "structure", "required": [ "VerifiedAccessGroupId" ], "members": { "VerifiedAccessGroupId": { "shape": "VerifiedAccessGroupId", "documentation": "The ID of the Verified Access group.
" }, "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "Description": { "shape": "String", "documentation": "A description for the Verified Access group.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
Details about the Verified Access group.
", "locationName": "verifiedAccessGroup" } } }, "ModifyVerifiedAccessInstanceLoggingConfigurationRequest": { "type": "structure", "required": [ "VerifiedAccessInstanceId", "AccessLogs" ], "members": { "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "AccessLogs": { "shape": "VerifiedAccessLogOptions", "documentation": "The configuration options for Verified Access instances.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true } } }, "ModifyVerifiedAccessInstanceLoggingConfigurationResult": { "type": "structure", "members": { "LoggingConfiguration": { "shape": "VerifiedAccessInstanceLoggingConfiguration", "documentation": "The logging configuration for the Verified Access instance.
", "locationName": "loggingConfiguration" } } }, "ModifyVerifiedAccessInstanceRequest": { "type": "structure", "required": [ "VerifiedAccessInstanceId" ], "members": { "VerifiedAccessInstanceId": { "shape": "VerifiedAccessInstanceId", "documentation": "The ID of the Verified Access instance.
" }, "Description": { "shape": "String", "documentation": "A description for the Verified Access instance.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true } } }, "ModifyVerifiedAccessInstanceResult": { "type": "structure", "members": { "VerifiedAccessInstance": { "shape": "VerifiedAccessInstance", "documentation": "Details about the Verified Access instance.
", "locationName": "verifiedAccessInstance" } } }, "ModifyVerifiedAccessTrustProviderDeviceOptions": { "type": "structure", "members": { "PublicSigningKeyUrl": { "shape": "String", "documentation": "The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens.
" } }, "documentation": "Modifies the configuration of the specified device-based Amazon Web Services Verified Access trust provider.
" }, "ModifyVerifiedAccessTrustProviderOidcOptions": { "type": "structure", "members": { "Issuer": { "shape": "String", "documentation": "The OIDC issuer.
" }, "AuthorizationEndpoint": { "shape": "String", "documentation": "The OIDC authorization endpoint.
" }, "TokenEndpoint": { "shape": "String", "documentation": "The OIDC token endpoint.
" }, "UserInfoEndpoint": { "shape": "String", "documentation": "The OIDC user info endpoint.
" }, "ClientId": { "shape": "String", "documentation": "The client identifier.
" }, "ClientSecret": { "shape": "ClientSecretType", "documentation": "The client secret.
" }, "Scope": { "shape": "String", "documentation": "OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.
" } }, "documentation": "Options for an OpenID Connect-compatible user-identity trust provider.
" }, "ModifyVerifiedAccessTrustProviderRequest": { "type": "structure", "required": [ "VerifiedAccessTrustProviderId" ], "members": { "VerifiedAccessTrustProviderId": { "shape": "VerifiedAccessTrustProviderId", "documentation": "The ID of the Verified Access trust provider.
" }, "OidcOptions": { "shape": "ModifyVerifiedAccessTrustProviderOidcOptions", "documentation": "The options for an OpenID Connect-compatible user-identity trust provider.
" }, "DeviceOptions": { "shape": "ModifyVerifiedAccessTrustProviderDeviceOptions", "documentation": "The options for a device-based trust provider. This parameter is required when the provider type is device.
A description for the Verified Access trust provider.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "SseSpecification": { "shape": "VerifiedAccessSseSpecificationRequest", "documentation": "The options for server side encryption.
" } } }, "ModifyVerifiedAccessTrustProviderResult": { "type": "structure", "members": { "VerifiedAccessTrustProvider": { "shape": "VerifiedAccessTrustProvider", "documentation": "Details about the Verified Access trust provider.
", "locationName": "verifiedAccessTrustProvider" } } }, "ModifyVolumeAttributeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "AutoEnableIO": { "shape": "AttributeBooleanValue", "documentation": "Indicates whether the volume should be auto-enabled for I/O operations.
" }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
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.
The ID of the volume.
" }, "Size": { "shape": "Integer", "documentation": "The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
Default: The existing size is retained.
" }, "VolumeType": { "shape": "VolumeType", "documentation": "The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
Default: The existing type is retained.
" }, "Iops": { "shape": "Integer", "documentation": "The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on 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.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
" }, "MultiAttachEnabled": { "shape": "Boolean", "documentation": "Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.
Information about the volume modification.
", "locationName": "volumeModification" } } }, "ModifyVpcAttributeRequest": { "type": "structure", "required": [ "VpcId" ], "members": { "EnableDnsHostnames": { "shape": "AttributeBooleanValue", "documentation": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
" }, "EnableDnsSupport": { "shape": "AttributeBooleanValue", "documentation": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
" }, "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "EnableNetworkAddressUsageMetrics": { "shape": "AttributeBooleanValue", "documentation": "Indicates whether Network Address Usage metrics are enabled for your VPC.
" } } }, "ModifyVpcEndpointConnectionNotificationRequest": { "type": "structure", "required": [ "ConnectionNotificationId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the notification.
" }, "ConnectionNotificationArn": { "shape": "String", "documentation": "The ARN for the SNS topic for the notification.
" }, "ConnectionEvents": { "shape": "ValueStringList", "documentation": "The events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.
Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the endpoint.
" }, "ResetPolicy": { "shape": "Boolean", "documentation": "(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
" }, "AddRouteTableIds": { "shape": "VpcEndpointRouteTableIdList", "documentation": "(Gateway endpoint) The IDs of the route tables to associate with the endpoint.
", "locationName": "AddRouteTableId" }, "RemoveRouteTableIds": { "shape": "VpcEndpointRouteTableIdList", "documentation": "(Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.
", "locationName": "RemoveRouteTableId" }, "AddSubnetIds": { "shape": "VpcEndpointSubnetIdList", "documentation": "(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
", "locationName": "AddSubnetId" }, "RemoveSubnetIds": { "shape": "VpcEndpointSubnetIdList", "documentation": "(Interface endpoint) The IDs of the subnets from which to remove the endpoint.
", "locationName": "RemoveSubnetId" }, "AddSecurityGroupIds": { "shape": "VpcEndpointSecurityGroupIdList", "documentation": "(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.
", "locationName": "AddSecurityGroupId" }, "RemoveSecurityGroupIds": { "shape": "VpcEndpointSecurityGroupIdList", "documentation": "(Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces.
", "locationName": "RemoveSecurityGroupId" }, "IpAddressType": { "shape": "IpAddressType", "documentation": "The IP address type for the endpoint.
" }, "DnsOptions": { "shape": "DnsOptionsSpecification", "documentation": "The DNS options for the endpoint.
" }, "PrivateDnsEnabled": { "shape": "Boolean", "documentation": "(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
" }, "SubnetConfigurations": { "shape": "SubnetConfigurationsList", "documentation": "The subnet configurations for the endpoint.
", "locationName": "SubnetConfiguration" } } }, "ModifyVpcEndpointResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the service.
" }, "PrivateDnsName": { "shape": "String", "documentation": "(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
" }, "RemovePrivateDnsName": { "shape": "Boolean", "documentation": "(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
" }, "AcceptanceRequired": { "shape": "Boolean", "documentation": "Indicates whether requests to create an endpoint to your service must be accepted.
" }, "AddNetworkLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
", "locationName": "AddNetworkLoadBalancerArn" }, "RemoveNetworkLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
", "locationName": "RemoveNetworkLoadBalancerArn" }, "AddGatewayLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
", "locationName": "AddGatewayLoadBalancerArn" }, "RemoveGatewayLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
", "locationName": "RemoveGatewayLoadBalancerArn" }, "AddSupportedIpAddressTypes": { "shape": "ValueStringList", "documentation": "The IP address types to add to your service configuration.
", "locationName": "AddSupportedIpAddressType" }, "RemoveSupportedIpAddressTypes": { "shape": "ValueStringList", "documentation": "The IP address types to remove from your service configuration.
", "locationName": "RemoveSupportedIpAddressType" } } }, "ModifyVpcEndpointServiceConfigurationResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the service.
" }, "PayerResponsibility": { "shape": "PayerResponsibility", "documentation": "The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.
" } } }, "ModifyVpcEndpointServicePayerResponsibilityResult": { "type": "structure", "members": { "ReturnValue": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the service.
" }, "AddAllowedPrincipals": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).
" }, "RemoveAllowedPrincipals": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list.
" } } }, "ModifyVpcEndpointServicePermissionsResult": { "type": "structure", "members": { "AddedPrincipals": { "shape": "AddedPrincipalSet", "documentation": "Information about the added principals.
", "locationName": "addedPrincipalSet" }, "ReturnValue": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The VPC peering connection options for the accepter VPC.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The VPC peering connection options for the requester VPC.
" }, "VpcPeeringConnectionId": { "shape": "VpcPeeringConnectionId", "documentation": "The ID of the VPC peering connection.
" } } }, "ModifyVpcPeeringConnectionOptionsResult": { "type": "structure", "members": { "AccepterPeeringConnectionOptions": { "shape": "PeeringConnectionOptions", "documentation": "Information about the VPC peering connection options for the accepter VPC.
", "locationName": "accepterPeeringConnectionOptions" }, "RequesterPeeringConnectionOptions": { "shape": "PeeringConnectionOptions", "documentation": "Information about the VPC peering connection options for the requester VPC.
", "locationName": "requesterPeeringConnectionOptions" } } }, "ModifyVpcTenancyRequest": { "type": "structure", "required": [ "VpcId", "InstanceTenancy" ], "members": { "VpcId": { "shape": "VpcId", "documentation": "The ID of the VPC.
" }, "InstanceTenancy": { "shape": "VpcTenancy", "documentation": "The instance tenancy attribute for the VPC.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, returns an error.
The ID of the Site-to-Site VPN connection.
" }, "LocalIpv4NetworkCidr": { "shape": "String", "documentation": "The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
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.
Information about the VPN connection.
", "locationName": "vpnConnection" } } }, "ModifyVpnConnectionRequest": { "type": "structure", "required": [ "VpnConnectionId" ], "members": { "VpnConnectionId": { "shape": "VpnConnectionId", "documentation": "The ID of the VPN connection.
" }, "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
" }, "CustomerGatewayId": { "shape": "CustomerGatewayId", "documentation": "The ID of the customer gateway at your end of the VPN connection.
" }, "VpnGatewayId": { "shape": "VpnGatewayId", "documentation": "The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the VPN connection.
", "locationName": "vpnConnection" } } }, "ModifyVpnTunnelCertificateRequest": { "type": "structure", "required": [ "VpnConnectionId", "VpnTunnelOutsideIpAddress" ], "members": { "VpnConnectionId": { "shape": "VpnConnectionId", "documentation": "The ID of the Amazon Web Services Site-to-Site VPN connection.
" }, "VpnTunnelOutsideIpAddress": { "shape": "String", "documentation": "The external IP address of the VPN tunnel.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the VPN connection.
", "locationName": "vpnConnection" } } }, "ModifyVpnTunnelOptionsRequest": { "type": "structure", "required": [ "VpnConnectionId", "VpnTunnelOutsideIpAddress", "TunnelOptions" ], "members": { "VpnConnectionId": { "shape": "VpnConnectionId", "documentation": "The ID of the Amazon Web Services Site-to-Site VPN connection.
" }, "VpnTunnelOutsideIpAddress": { "shape": "String", "documentation": "The external IP address of the VPN tunnel.
" }, "TunnelOptions": { "shape": "ModifyVpnTunnelOptionsSpecification", "documentation": "The tunnel options to modify.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off EnableTunnelLifecycleControl.
Valid values: True | False
Information about the VPN connection.
", "locationName": "vpnConnection" } } }, "ModifyVpnTunnelOptionsSpecification": { "type": "structure", "members": { "TunnelInsideCidr": { "shape": "String", "documentation": "The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
" }, "Phase1LifetimeSeconds": { "shape": "Integer", "documentation": "The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 270
The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 seconds means that the VPN endpoint will consider the peer dead 30 seconds after the first failed keep-alive.
Constraints: A value greater than or equal to 30.
Default: 40
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
Options for logging VPN tunnel activity.
" }, "EnableTunnelLifecycleControl": { "shape": "Boolean", "documentation": "Turn on or off tunnel endpoint lifecycle control feature.
" } }, "documentation": "The Amazon Web Services Site-to-Site VPN tunnel options to modify.
", "sensitive": true }, "MonitorInstancesRequest": { "type": "structure", "required": [ "InstanceIds" ], "members": { "InstanceIds": { "shape": "InstanceIdStringList", "documentation": "The IDs of the instances.
", "locationName": "InstanceId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The monitoring information.
", "locationName": "instancesSet" } } }, "Monitoring": { "type": "structure", "members": { "State": { "shape": "MonitoringState", "documentation": "Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
", "locationName": "state" } }, "documentation": "Describes the monitoring of an instance.
" }, "MonitoringState": { "type": "string", "enum": [ "disabled", "disabling", "enabled", "pending" ] }, "MoveAddressToVpcRequest": { "type": "structure", "required": [ "PublicIp" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The Elastic IP address.
", "locationName": "publicIp" } } }, "MoveAddressToVpcResult": { "type": "structure", "members": { "AllocationId": { "shape": "String", "documentation": "The allocation ID for the Elastic IP address.
", "locationName": "allocationId" }, "Status": { "shape": "Status", "documentation": "The status of the move of the IP address.
", "locationName": "status" } } }, "MoveByoipCidrToIpamRequest": { "type": "structure", "required": [ "Cidr", "IpamPoolId", "IpamPoolOwner" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The BYOIP CIDR.
" }, "IpamPoolId": { "shape": "IpamPoolId", "documentation": "The IPAM pool ID.
" }, "IpamPoolOwner": { "shape": "String", "documentation": "The Amazon Web Services account ID of the owner of the IPAM pool.
" } } }, "MoveByoipCidrToIpamResult": { "type": "structure", "members": { "ByoipCidr": { "shape": "ByoipCidr", "documentation": "The BYOIP CIDR.
", "locationName": "byoipCidr" } } }, "MoveStatus": { "type": "string", "enum": [ "movingToVpc", "restoringToClassic" ] }, "MovingAddressStatus": { "type": "structure", "members": { "MoveStatus": { "shape": "MoveStatus", "documentation": "The status of the Elastic IP address that's being moved or restored.
", "locationName": "moveStatus" }, "PublicIp": { "shape": "String", "documentation": "The Elastic IP address.
", "locationName": "publicIp" } }, "documentation": "This action is deprecated.
Describes the status of a moving Elastic IP address.
" }, "MovingAddressStatusSet": { "type": "list", "member": { "shape": "MovingAddressStatus", "locationName": "item" } }, "MulticastSupportValue": { "type": "string", "enum": [ "enable", "disable" ] }, "NatGateway": { "type": "structure", "members": { "CreateTime": { "shape": "DateTime", "documentation": "The date and time the NAT gateway was created.
", "locationName": "createTime" }, "DeleteTime": { "shape": "DateTime", "documentation": "The date and time the NAT gateway was deleted, if applicable.
", "locationName": "deleteTime" }, "FailureCode": { "shape": "String", "documentation": "If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"
For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"
For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"
For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"
For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"
For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"
Information about the IP addresses and network interface associated with the NAT gateway.
", "locationName": "natGatewayAddressSet" }, "NatGatewayId": { "shape": "String", "documentation": "The ID of the NAT gateway.
", "locationName": "natGatewayId" }, "ProvisionedBandwidth": { "shape": "ProvisionedBandwidth", "documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", "locationName": "provisionedBandwidth" }, "State": { "shape": "NatGatewayState", "documentation": "The state of the NAT gateway.
pending: The NAT gateway is being created and is not ready to process traffic.
failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.
deleted: The NAT gateway has been terminated and is no longer processing traffic.
The ID of the subnet in which the NAT gateway is located.
", "locationName": "subnetId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC in which the NAT gateway is located.
", "locationName": "vpcId" }, "Tags": { "shape": "TagList", "documentation": "The tags for the NAT gateway.
", "locationName": "tagSet" }, "ConnectivityType": { "shape": "ConnectivityType", "documentation": "Indicates whether the NAT gateway supports public or private connectivity.
", "locationName": "connectivityType" } }, "documentation": "Describes a NAT gateway.
" }, "NatGatewayAddress": { "type": "structure", "members": { "AllocationId": { "shape": "String", "documentation": "[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
", "locationName": "allocationId" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface associated with the NAT gateway.
", "locationName": "networkInterfaceId" }, "PrivateIp": { "shape": "String", "documentation": "The private IP address associated with the NAT gateway.
", "locationName": "privateIp" }, "PublicIp": { "shape": "String", "documentation": "[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
", "locationName": "publicIp" }, "AssociationId": { "shape": "String", "documentation": "[Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway.
", "locationName": "associationId" }, "IsPrimary": { "shape": "Boolean", "documentation": "Defines if the IP address is the primary address.
", "locationName": "isPrimary" }, "FailureMessage": { "shape": "String", "documentation": "The address failure message.
", "locationName": "failureMessage" }, "Status": { "shape": "NatGatewayAddressStatus", "documentation": "The address status.
", "locationName": "status" } }, "documentation": "Describes the IP addresses and network interface associated with a NAT gateway.
" }, "NatGatewayAddressList": { "type": "list", "member": { "shape": "NatGatewayAddress", "locationName": "item" } }, "NatGatewayAddressStatus": { "type": "string", "enum": [ "assigning", "unassigning", "associating", "disassociating", "succeeded", "failed" ] }, "NatGatewayId": { "type": "string" }, "NatGatewayIdStringList": { "type": "list", "member": { "shape": "NatGatewayId", "locationName": "item" } }, "NatGatewayList": { "type": "list", "member": { "shape": "NatGateway", "locationName": "item" } }, "NatGatewayState": { "type": "string", "enum": [ "pending", "failed", "available", "deleting", "deleted" ] }, "NetmaskLength": { "type": "integer" }, "NetworkAcl": { "type": "structure", "members": { "Associations": { "shape": "NetworkAclAssociationList", "documentation": "Any associations between the network ACL and one or more subnets
", "locationName": "associationSet" }, "Entries": { "shape": "NetworkAclEntryList", "documentation": "The entries (rules) in the network ACL.
", "locationName": "entrySet" }, "IsDefault": { "shape": "Boolean", "documentation": "Indicates whether this is the default network ACL for the VPC.
", "locationName": "default" }, "NetworkAclId": { "shape": "String", "documentation": "The ID of the network ACL.
", "locationName": "networkAclId" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the network ACL.
", "locationName": "tagSet" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC for the network ACL.
", "locationName": "vpcId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the network ACL.
", "locationName": "ownerId" } }, "documentation": "Describes a network ACL.
" }, "NetworkAclAssociation": { "type": "structure", "members": { "NetworkAclAssociationId": { "shape": "String", "documentation": "The ID of the association between a network ACL and a subnet.
", "locationName": "networkAclAssociationId" }, "NetworkAclId": { "shape": "String", "documentation": "The ID of the network ACL.
", "locationName": "networkAclId" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" } }, "documentation": "Describes an association between a network ACL and a subnet.
" }, "NetworkAclAssociationId": { "type": "string" }, "NetworkAclAssociationList": { "type": "list", "member": { "shape": "NetworkAclAssociation", "locationName": "item" } }, "NetworkAclEntry": { "type": "structure", "members": { "CidrBlock": { "shape": "String", "documentation": "The IPv4 network range to allow or deny, in CIDR notation.
", "locationName": "cidrBlock" }, "Egress": { "shape": "Boolean", "documentation": "Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
", "locationName": "egress" }, "IcmpTypeCode": { "shape": "IcmpTypeCode", "documentation": "ICMP protocol: The ICMP type and code.
", "locationName": "icmpTypeCode" }, "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 network range to allow or deny, in CIDR notation.
", "locationName": "ipv6CidrBlock" }, "PortRange": { "shape": "PortRange", "documentation": "TCP or UDP protocols: The range of ports the rule applies to.
", "locationName": "portRange" }, "Protocol": { "shape": "String", "documentation": "The protocol number. A value of \"-1\" means all protocols.
", "locationName": "protocol" }, "RuleAction": { "shape": "RuleAction", "documentation": "Indicates whether to allow or deny the traffic that matches the rule.
", "locationName": "ruleAction" }, "RuleNumber": { "shape": "Integer", "documentation": "The rule number for the entry. ACL entries are processed in ascending order by rule number.
", "locationName": "ruleNumber" } }, "documentation": "Describes an entry in a network ACL.
" }, "NetworkAclEntryList": { "type": "list", "member": { "shape": "NetworkAclEntry", "locationName": "item" } }, "NetworkAclId": { "type": "string" }, "NetworkAclIdStringList": { "type": "list", "member": { "shape": "NetworkAclId", "locationName": "item" } }, "NetworkAclList": { "type": "list", "member": { "shape": "NetworkAcl", "locationName": "item" } }, "NetworkBandwidthGbps": { "type": "structure", "members": { "Min": { "shape": "Double", "documentation": "The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
", "locationName": "min" }, "Max": { "shape": "Double", "documentation": "The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see Available instance bandwidth in the Amazon EC2 User Guide.
The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.
" }, "Max": { "shape": "Double", "documentation": "The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
" } }, "documentation": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see Available instance bandwidth in the Amazon EC2 User Guide.
The index of the network card.
", "locationName": "networkCardIndex" }, "NetworkPerformance": { "shape": "NetworkPerformance", "documentation": "The network performance of the network card.
", "locationName": "networkPerformance" }, "MaximumNetworkInterfaces": { "shape": "MaxNetworkInterfaces", "documentation": "The maximum number of network interfaces for the network card.
", "locationName": "maximumNetworkInterfaces" }, "BaselineBandwidthInGbps": { "shape": "BaselineBandwidthInGbps", "documentation": "The baseline network performance of the network card, in Gbps.
", "locationName": "baselineBandwidthInGbps" }, "PeakBandwidthInGbps": { "shape": "PeakBandwidthInGbps", "documentation": "The peak (burst) network performance of the network card, in Gbps.
", "locationName": "peakBandwidthInGbps" } }, "documentation": "Describes the network card support of the instance type.
" }, "NetworkCardInfoList": { "type": "list", "member": { "shape": "NetworkCardInfo", "locationName": "item" } }, "NetworkInfo": { "type": "structure", "members": { "NetworkPerformance": { "shape": "NetworkPerformance", "documentation": "The network performance.
", "locationName": "networkPerformance" }, "MaximumNetworkInterfaces": { "shape": "MaxNetworkInterfaces", "documentation": "The maximum number of network interfaces for the instance type.
", "locationName": "maximumNetworkInterfaces" }, "MaximumNetworkCards": { "shape": "MaximumNetworkCards", "documentation": "The maximum number of physical network cards that can be allocated to the instance.
", "locationName": "maximumNetworkCards" }, "DefaultNetworkCardIndex": { "shape": "DefaultNetworkCardIndex", "documentation": "The index of the default network card, starting at 0.
", "locationName": "defaultNetworkCardIndex" }, "NetworkCards": { "shape": "NetworkCardInfoList", "documentation": "Describes the network cards for the instance type.
", "locationName": "networkCards" }, "Ipv4AddressesPerInterface": { "shape": "MaxIpv4AddrPerInterface", "documentation": "The maximum number of IPv4 addresses per network interface.
", "locationName": "ipv4AddressesPerInterface" }, "Ipv6AddressesPerInterface": { "shape": "MaxIpv6AddrPerInterface", "documentation": "The maximum number of IPv6 addresses per network interface.
", "locationName": "ipv6AddressesPerInterface" }, "Ipv6Supported": { "shape": "Ipv6Flag", "documentation": "Indicates whether IPv6 is supported.
", "locationName": "ipv6Supported" }, "EnaSupport": { "shape": "EnaSupport", "documentation": "Indicates whether Elastic Network Adapter (ENA) is supported.
", "locationName": "enaSupport" }, "EfaSupported": { "shape": "EfaSupportedFlag", "documentation": "Indicates whether Elastic Fabric Adapter (EFA) is supported.
", "locationName": "efaSupported" }, "EfaInfo": { "shape": "EfaInfo", "documentation": "Describes the Elastic Fabric Adapters for the instance type.
", "locationName": "efaInfo" }, "EncryptionInTransitSupported": { "shape": "EncryptionInTransitSupported", "documentation": "Indicates whether the instance type automatically encrypts in-transit traffic between instances.
", "locationName": "encryptionInTransitSupported" }, "EnaSrdSupported": { "shape": "EnaSrdSupported", "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 and minimize tail latency of network traffic between EC2 instances.
", "locationName": "enaSrdSupported" } }, "documentation": "Describes the networking features of the instance type.
" }, "NetworkInsightsAccessScope": { "type": "structure", "members": { "NetworkInsightsAccessScopeId": { "shape": "NetworkInsightsAccessScopeId", "documentation": "The ID of the Network Access Scope.
", "locationName": "networkInsightsAccessScopeId" }, "NetworkInsightsAccessScopeArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the Network Access Scope.
", "locationName": "networkInsightsAccessScopeArn" }, "CreatedDate": { "shape": "MillisecondDateTime", "documentation": "The creation date.
", "locationName": "createdDate" }, "UpdatedDate": { "shape": "MillisecondDateTime", "documentation": "The last updated date.
", "locationName": "updatedDate" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" } }, "documentation": "Describes a Network Access Scope.
" }, "NetworkInsightsAccessScopeAnalysis": { "type": "structure", "members": { "NetworkInsightsAccessScopeAnalysisId": { "shape": "NetworkInsightsAccessScopeAnalysisId", "documentation": "The ID of the Network Access Scope analysis.
", "locationName": "networkInsightsAccessScopeAnalysisId" }, "NetworkInsightsAccessScopeAnalysisArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the Network Access Scope analysis.
", "locationName": "networkInsightsAccessScopeAnalysisArn" }, "NetworkInsightsAccessScopeId": { "shape": "NetworkInsightsAccessScopeId", "documentation": "The ID of the Network Access Scope.
", "locationName": "networkInsightsAccessScopeId" }, "Status": { "shape": "AnalysisStatus", "documentation": "The status.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "The status message.
", "locationName": "statusMessage" }, "WarningMessage": { "shape": "String", "documentation": "The warning message.
", "locationName": "warningMessage" }, "StartDate": { "shape": "MillisecondDateTime", "documentation": "The analysis start date.
", "locationName": "startDate" }, "EndDate": { "shape": "MillisecondDateTime", "documentation": "The analysis end date.
", "locationName": "endDate" }, "FindingsFound": { "shape": "FindingsFound", "documentation": "Indicates whether there are findings.
", "locationName": "findingsFound" }, "AnalyzedEniCount": { "shape": "Integer", "documentation": "The number of network interfaces analyzed.
", "locationName": "analyzedEniCount" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" } }, "documentation": "Describes a Network Access Scope analysis.
" }, "NetworkInsightsAccessScopeAnalysisId": { "type": "string" }, "NetworkInsightsAccessScopeAnalysisIdList": { "type": "list", "member": { "shape": "NetworkInsightsAccessScopeAnalysisId", "locationName": "item" } }, "NetworkInsightsAccessScopeAnalysisList": { "type": "list", "member": { "shape": "NetworkInsightsAccessScopeAnalysis", "locationName": "item" } }, "NetworkInsightsAccessScopeContent": { "type": "structure", "members": { "NetworkInsightsAccessScopeId": { "shape": "NetworkInsightsAccessScopeId", "documentation": "The ID of the Network Access Scope.
", "locationName": "networkInsightsAccessScopeId" }, "MatchPaths": { "shape": "AccessScopePathList", "documentation": "The paths to match.
", "locationName": "matchPathSet" }, "ExcludePaths": { "shape": "AccessScopePathList", "documentation": "The paths to exclude.
", "locationName": "excludePathSet" } }, "documentation": "Describes the Network Access Scope content.
" }, "NetworkInsightsAccessScopeId": { "type": "string" }, "NetworkInsightsAccessScopeIdList": { "type": "list", "member": { "shape": "NetworkInsightsAccessScopeId", "locationName": "item" } }, "NetworkInsightsAccessScopeList": { "type": "list", "member": { "shape": "NetworkInsightsAccessScope", "locationName": "item" } }, "NetworkInsightsAnalysis": { "type": "structure", "members": { "NetworkInsightsAnalysisId": { "shape": "NetworkInsightsAnalysisId", "documentation": "The ID of the network insights analysis.
", "locationName": "networkInsightsAnalysisId" }, "NetworkInsightsAnalysisArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the network insights analysis.
", "locationName": "networkInsightsAnalysisArn" }, "NetworkInsightsPathId": { "shape": "NetworkInsightsPathId", "documentation": "The ID of the path.
", "locationName": "networkInsightsPathId" }, "AdditionalAccounts": { "shape": "ValueStringList", "documentation": "The member accounts that contain resources that the path can traverse.
", "locationName": "additionalAccountSet" }, "FilterInArns": { "shape": "ArnList", "documentation": "The Amazon Resource Names (ARN) of the resources that the path must traverse.
", "locationName": "filterInArnSet" }, "StartDate": { "shape": "MillisecondDateTime", "documentation": "The time the analysis started.
", "locationName": "startDate" }, "Status": { "shape": "AnalysisStatus", "documentation": "The status of the network insights analysis.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "The status message, if the status is failed.
The warning message.
", "locationName": "warningMessage" }, "NetworkPathFound": { "shape": "Boolean", "documentation": "Indicates whether the destination is reachable from the source.
", "locationName": "networkPathFound" }, "ForwardPathComponents": { "shape": "PathComponentList", "documentation": "The components in the path from source to destination.
", "locationName": "forwardPathComponentSet" }, "ReturnPathComponents": { "shape": "PathComponentList", "documentation": "The components in the path from destination to source.
", "locationName": "returnPathComponentSet" }, "Explanations": { "shape": "ExplanationList", "documentation": "The explanations. For more information, see Reachability Analyzer explanation codes.
", "locationName": "explanationSet" }, "AlternatePathHints": { "shape": "AlternatePathHintList", "documentation": "Potential intermediate components.
", "locationName": "alternatePathHintSet" }, "SuggestedAccounts": { "shape": "ValueStringList", "documentation": "Potential intermediate accounts.
", "locationName": "suggestedAccountSet" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" } }, "documentation": "Describes a network insights analysis.
" }, "NetworkInsightsAnalysisId": { "type": "string" }, "NetworkInsightsAnalysisIdList": { "type": "list", "member": { "shape": "NetworkInsightsAnalysisId", "locationName": "item" } }, "NetworkInsightsAnalysisList": { "type": "list", "member": { "shape": "NetworkInsightsAnalysis", "locationName": "item" } }, "NetworkInsightsMaxResults": { "type": "integer", "max": 100, "min": 1 }, "NetworkInsightsPath": { "type": "structure", "members": { "NetworkInsightsPathId": { "shape": "NetworkInsightsPathId", "documentation": "The ID of the path.
", "locationName": "networkInsightsPathId" }, "NetworkInsightsPathArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the path.
", "locationName": "networkInsightsPathArn" }, "CreatedDate": { "shape": "MillisecondDateTime", "documentation": "The time stamp when the path was created.
", "locationName": "createdDate" }, "Source": { "shape": "String", "documentation": "The ID of the source.
", "locationName": "source" }, "Destination": { "shape": "String", "documentation": "The ID of the destination.
", "locationName": "destination" }, "SourceArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the source.
", "locationName": "sourceArn" }, "DestinationArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the destination.
", "locationName": "destinationArn" }, "SourceIp": { "shape": "IpAddress", "documentation": "The IP address of the source.
", "locationName": "sourceIp" }, "DestinationIp": { "shape": "IpAddress", "documentation": "The IP address of the destination.
", "locationName": "destinationIp" }, "Protocol": { "shape": "Protocol", "documentation": "The protocol.
", "locationName": "protocol" }, "DestinationPort": { "shape": "Integer", "documentation": "The destination port.
", "locationName": "destinationPort" }, "Tags": { "shape": "TagList", "documentation": "The tags associated with the path.
", "locationName": "tagSet" }, "FilterAtSource": { "shape": "PathFilter", "documentation": "Scopes the analysis to network paths that match specific filters at the source.
", "locationName": "filterAtSource" }, "FilterAtDestination": { "shape": "PathFilter", "documentation": "Scopes the analysis to network paths that match specific filters at the destination.
", "locationName": "filterAtDestination" } }, "documentation": "Describes a path.
" }, "NetworkInsightsPathId": { "type": "string" }, "NetworkInsightsPathIdList": { "type": "list", "member": { "shape": "NetworkInsightsPathId", "locationName": "item" } }, "NetworkInsightsPathList": { "type": "list", "member": { "shape": "NetworkInsightsPath", "locationName": "item" } }, "NetworkInsightsResourceId": { "type": "string" }, "NetworkInterface": { "type": "structure", "members": { "Association": { "shape": "NetworkInterfaceAssociation", "documentation": "The association information for an Elastic IP address (IPv4) associated with the network interface.
", "locationName": "association" }, "Attachment": { "shape": "NetworkInterfaceAttachment", "documentation": "The network interface attachment.
", "locationName": "attachment" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "ConnectionTrackingConfiguration": { "shape": "ConnectionTrackingConfiguration", "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.
", "locationName": "connectionTrackingConfiguration" }, "Description": { "shape": "String", "documentation": "A description.
", "locationName": "description" }, "Groups": { "shape": "GroupIdentifierList", "documentation": "Any security groups for the network interface.
", "locationName": "groupSet" }, "InterfaceType": { "shape": "NetworkInterfaceType", "documentation": "The type of network interface.
", "locationName": "interfaceType" }, "Ipv6Addresses": { "shape": "NetworkInterfaceIpv6AddressesList", "documentation": "The IPv6 addresses associated with the network interface.
", "locationName": "ipv6AddressesSet" }, "MacAddress": { "shape": "String", "documentation": "The MAC address.
", "locationName": "macAddress" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", "locationName": "outpostArn" }, "OwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID of the owner of the network interface.
", "locationName": "ownerId" }, "PrivateDnsName": { "shape": "String", "documentation": "The private DNS name.
", "locationName": "privateDnsName" }, "PrivateIpAddress": { "shape": "String", "documentation": "The IPv4 address of the network interface within the subnet.
", "locationName": "privateIpAddress" }, "PrivateIpAddresses": { "shape": "NetworkInterfacePrivateIpAddressList", "documentation": "The private IPv4 addresses associated with the network interface.
", "locationName": "privateIpAddressesSet" }, "Ipv4Prefixes": { "shape": "Ipv4PrefixesList", "documentation": "The IPv4 prefixes that are assigned to the network interface.
", "locationName": "ipv4PrefixSet" }, "Ipv6Prefixes": { "shape": "Ipv6PrefixesList", "documentation": "The IPv6 prefixes that are assigned to the network interface.
", "locationName": "ipv6PrefixSet" }, "RequesterId": { "shape": "String", "documentation": "The alias or Amazon Web Services account ID of the principal or service that created the network interface.
", "locationName": "requesterId" }, "RequesterManaged": { "shape": "Boolean", "documentation": "Indicates whether the network interface is being managed by Amazon Web Services.
", "locationName": "requesterManaged" }, "SourceDestCheck": { "shape": "Boolean", "documentation": "Indicates whether source/destination checking is enabled.
", "locationName": "sourceDestCheck" }, "Status": { "shape": "NetworkInterfaceStatus", "documentation": "The status of the network interface.
", "locationName": "status" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "TagSet": { "shape": "TagList", "documentation": "Any tags assigned to the network interface.
", "locationName": "tagSet" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "DenyAllIgwTraffic": { "shape": "Boolean", "documentation": "Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.
Indicates whether this is an IPv6 only network interface.
", "locationName": "ipv6Native" }, "Ipv6Address": { "shape": "String", "documentation": "The IPv6 globally unique address associated with the network interface.
", "locationName": "ipv6Address" } }, "documentation": "Describes a network interface.
" }, "NetworkInterfaceAssociation": { "type": "structure", "members": { "AllocationId": { "shape": "String", "documentation": "The allocation ID.
", "locationName": "allocationId" }, "AssociationId": { "shape": "String", "documentation": "The association ID.
", "locationName": "associationId" }, "IpOwnerId": { "shape": "String", "documentation": "The ID of the Elastic IP address owner.
", "locationName": "ipOwnerId" }, "PublicDnsName": { "shape": "String", "documentation": "The public DNS name.
", "locationName": "publicDnsName" }, "PublicIp": { "shape": "String", "documentation": "The address of the Elastic IP address bound to the network interface.
", "locationName": "publicIp" }, "CustomerOwnedIp": { "shape": "String", "documentation": "The customer-owned IP address associated with the network interface.
", "locationName": "customerOwnedIp" }, "CarrierIp": { "shape": "String", "documentation": "The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
", "locationName": "carrierIp" } }, "documentation": "Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone).
" }, "NetworkInterfaceAttachment": { "type": "structure", "members": { "AttachTime": { "shape": "DateTime", "documentation": "The timestamp indicating when the attachment initiated.
", "locationName": "attachTime" }, "AttachmentId": { "shape": "String", "documentation": "The ID of the network interface attachment.
", "locationName": "attachmentId" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the network interface is deleted when the instance is terminated.
", "locationName": "deleteOnTermination" }, "DeviceIndex": { "shape": "Integer", "documentation": "The device index of the network interface attachment on the instance.
", "locationName": "deviceIndex" }, "NetworkCardIndex": { "shape": "Integer", "documentation": "The index of the network card.
", "locationName": "networkCardIndex" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "InstanceOwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID of the owner of the instance.
", "locationName": "instanceOwnerId" }, "Status": { "shape": "AttachmentStatus", "documentation": "The attachment state.
", "locationName": "status" }, "EnaSrdSpecification": { "shape": "AttachmentEnaSrdSpecification", "documentation": "Configures ENA Express for the network interface that this action attaches to the instance.
", "locationName": "enaSrdSpecification" } }, "documentation": "Describes a network interface attachment.
" }, "NetworkInterfaceAttachmentChanges": { "type": "structure", "members": { "AttachmentId": { "shape": "NetworkInterfaceAttachmentId", "documentation": "The ID of the network interface attachment.
", "locationName": "attachmentId" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the network interface is deleted when the instance is terminated.
", "locationName": "deleteOnTermination" } }, "documentation": "Describes an attachment change.
" }, "NetworkInterfaceAttachmentId": { "type": "string" }, "NetworkInterfaceAttribute": { "type": "string", "enum": [ "description", "groupSet", "sourceDestCheck", "attachment", "associatePublicIpAddress" ] }, "NetworkInterfaceCount": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.
", "locationName": "min" }, "Max": { "shape": "Integer", "documentation": "The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum number of network interfaces.
" }, "NetworkInterfaceCountRequest": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
" }, "Max": { "shape": "Integer", "documentation": "The maximum number of network interfaces. To specify no maximum limit, omit this parameter.
" } }, "documentation": "The minimum and maximum number of network interfaces.
" }, "NetworkInterfaceCreationType": { "type": "string", "enum": [ "efa", "branch", "trunk" ] }, "NetworkInterfaceId": { "type": "string" }, "NetworkInterfaceIdList": { "type": "list", "member": { "shape": "NetworkInterfaceId", "locationName": "item" } }, "NetworkInterfaceIdSet": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "NetworkInterfaceIpv6Address": { "type": "structure", "members": { "Ipv6Address": { "shape": "String", "documentation": "The IPv6 address.
", "locationName": "ipv6Address" }, "IsPrimaryIpv6": { "shape": "Boolean", "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.
", "locationName": "isPrimaryIpv6" } }, "documentation": "Describes an IPv6 address associated with a network interface.
" }, "NetworkInterfaceIpv6AddressesList": { "type": "list", "member": { "shape": "NetworkInterfaceIpv6Address", "locationName": "item" } }, "NetworkInterfaceList": { "type": "list", "member": { "shape": "NetworkInterface", "locationName": "item" } }, "NetworkInterfacePermission": { "type": "structure", "members": { "NetworkInterfacePermissionId": { "shape": "String", "documentation": "The ID of the network interface permission.
", "locationName": "networkInterfacePermissionId" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "AwsAccountId": { "shape": "String", "documentation": "The Amazon Web Services account ID.
", "locationName": "awsAccountId" }, "AwsService": { "shape": "String", "documentation": "The Amazon Web Service.
", "locationName": "awsService" }, "Permission": { "shape": "InterfacePermissionType", "documentation": "The type of permission.
", "locationName": "permission" }, "PermissionState": { "shape": "NetworkInterfacePermissionState", "documentation": "Information about the state of the permission.
", "locationName": "permissionState" } }, "documentation": "Describes a permission for a network interface.
" }, "NetworkInterfacePermissionId": { "type": "string" }, "NetworkInterfacePermissionIdList": { "type": "list", "member": { "shape": "NetworkInterfacePermissionId" } }, "NetworkInterfacePermissionList": { "type": "list", "member": { "shape": "NetworkInterfacePermission", "locationName": "item" } }, "NetworkInterfacePermissionState": { "type": "structure", "members": { "State": { "shape": "NetworkInterfacePermissionStateCode", "documentation": "The state of the permission.
", "locationName": "state" }, "StatusMessage": { "shape": "String", "documentation": "A status message, if applicable.
", "locationName": "statusMessage" } }, "documentation": "Describes the state of a network interface permission.
" }, "NetworkInterfacePermissionStateCode": { "type": "string", "enum": [ "pending", "granted", "revoking", "revoked" ] }, "NetworkInterfacePrivateIpAddress": { "type": "structure", "members": { "Association": { "shape": "NetworkInterfaceAssociation", "documentation": "The association information for an Elastic IP address (IPv4) associated with the network interface.
", "locationName": "association" }, "Primary": { "shape": "Boolean", "documentation": "Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
", "locationName": "primary" }, "PrivateDnsName": { "shape": "String", "documentation": "The private DNS name.
", "locationName": "privateDnsName" }, "PrivateIpAddress": { "shape": "String", "documentation": "The private IPv4 address.
", "locationName": "privateIpAddress" } }, "documentation": "Describes the private IPv4 address of a network interface.
" }, "NetworkInterfacePrivateIpAddressList": { "type": "list", "member": { "shape": "NetworkInterfacePrivateIpAddress", "locationName": "item" } }, "NetworkInterfaceStatus": { "type": "string", "enum": [ "available", "associated", "attaching", "in-use", "detaching" ] }, "NetworkInterfaceType": { "type": "string", "enum": [ "interface", "natGateway", "efa", "trunk", "load_balancer", "network_load_balancer", "vpc_endpoint", "branch", "transit_gateway", "lambda", "quicksight", "global_accelerator_managed", "api_gateway_managed", "gateway_load_balancer", "gateway_load_balancer_endpoint", "iot_rules_managed", "aws_codestar_connections_managed" ] }, "NetworkNodesList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "NetworkPerformance": { "type": "string" }, "NeuronDeviceCoreCount": { "type": "integer" }, "NeuronDeviceCoreInfo": { "type": "structure", "members": { "Count": { "shape": "NeuronDeviceCoreCount", "documentation": "The number of cores available to the neuron accelerator.
", "locationName": "count" }, "Version": { "shape": "NeuronDeviceCoreVersion", "documentation": "The version of the neuron accelerator.
", "locationName": "version" } }, "documentation": "Describes the cores available to the neuron accelerator.
" }, "NeuronDeviceCoreVersion": { "type": "integer" }, "NeuronDeviceCount": { "type": "integer" }, "NeuronDeviceInfo": { "type": "structure", "members": { "Count": { "shape": "NeuronDeviceCount", "documentation": "The number of neuron accelerators for the instance type.
", "locationName": "count" }, "Name": { "shape": "NeuronDeviceName", "documentation": "The name of the neuron accelerator.
", "locationName": "name" }, "CoreInfo": { "shape": "NeuronDeviceCoreInfo", "documentation": "Describes the cores available to each neuron accelerator.
", "locationName": "coreInfo" }, "MemoryInfo": { "shape": "NeuronDeviceMemoryInfo", "documentation": "Describes the memory available to each neuron accelerator.
", "locationName": "memoryInfo" } }, "documentation": "Describes the neuron accelerators for the instance type.
" }, "NeuronDeviceInfoList": { "type": "list", "member": { "shape": "NeuronDeviceInfo", "locationName": "item" } }, "NeuronDeviceMemoryInfo": { "type": "structure", "members": { "SizeInMiB": { "shape": "NeuronDeviceMemorySize", "documentation": "The size of the memory available to the neuron accelerator, in MiB.
", "locationName": "sizeInMiB" } }, "documentation": "Describes the memory available to the neuron accelerator.
" }, "NeuronDeviceMemorySize": { "type": "integer" }, "NeuronDeviceName": { "type": "string" }, "NeuronInfo": { "type": "structure", "members": { "NeuronDevices": { "shape": "NeuronDeviceInfoList", "documentation": "Describes the neuron accelerators for the instance type.
", "locationName": "neuronDevices" }, "TotalNeuronDeviceMemoryInMiB": { "shape": "TotalNeuronMemory", "documentation": "The total size of the memory for the neuron accelerators for the instance type, in MiB.
", "locationName": "totalNeuronDeviceMemoryInMiB" } }, "documentation": "Describes the neuron accelerators for the instance type.
" }, "NewDhcpConfiguration": { "type": "structure", "members": { "Key": { "shape": "String", "documentation": "The name of a DHCP option.
" }, "Values": { "shape": "ValueStringList", "documentation": "The values for the DHCP option.
", "locationName": "Value" } }, "documentation": "Describes a DHCP configuration option.
" }, "NewDhcpConfigurationList": { "type": "list", "member": { "shape": "NewDhcpConfiguration", "locationName": "item" } }, "NextToken": { "type": "string" }, "NitroEnclavesSupport": { "type": "string", "enum": [ "unsupported", "supported" ] }, "NitroTpmInfo": { "type": "structure", "members": { "SupportedVersions": { "shape": "NitroTpmSupportedVersionsList", "documentation": "Indicates the supported NitroTPM versions.
", "locationName": "supportedVersions" } }, "documentation": "Describes the supported NitroTPM versions for the instance type.
" }, "NitroTpmSupport": { "type": "string", "enum": [ "unsupported", "supported" ] }, "NitroTpmSupportedVersionType": { "type": "string" }, "NitroTpmSupportedVersionsList": { "type": "list", "member": { "shape": "NitroTpmSupportedVersionType", "locationName": "item" } }, "OccurrenceDayRequestSet": { "type": "list", "member": { "shape": "Integer", "locationName": "OccurenceDay" } }, "OccurrenceDaySet": { "type": "list", "member": { "shape": "Integer", "locationName": "item" } }, "OfferingClassType": { "type": "string", "enum": [ "standard", "convertible" ] }, "OfferingId": { "type": "string" }, "OfferingTypeValues": { "type": "string", "enum": [ "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront" ] }, "OidcOptions": { "type": "structure", "members": { "Issuer": { "shape": "String", "documentation": "The OIDC issuer.
", "locationName": "issuer" }, "AuthorizationEndpoint": { "shape": "String", "documentation": "The OIDC authorization endpoint.
", "locationName": "authorizationEndpoint" }, "TokenEndpoint": { "shape": "String", "documentation": "The OIDC token endpoint.
", "locationName": "tokenEndpoint" }, "UserInfoEndpoint": { "shape": "String", "documentation": "The OIDC user info endpoint.
", "locationName": "userInfoEndpoint" }, "ClientId": { "shape": "String", "documentation": "The client identifier.
", "locationName": "clientId" }, "ClientSecret": { "shape": "ClientSecretType", "documentation": "The client secret.
", "locationName": "clientSecret" }, "Scope": { "shape": "String", "documentation": "The OpenID Connect (OIDC) scope specified.
", "locationName": "scope" } }, "documentation": "Describes the options for an OpenID Connect-compatible user-identity trust provider.
" }, "OnDemandAllocationStrategy": { "type": "string", "enum": [ "lowestPrice", "prioritized" ] }, "OnDemandOptions": { "type": "structure", "members": { "AllocationStrategy": { "shape": "FleetOnDemandAllocationStrategy", "documentation": "The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
Default: lowest-price
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type instant.
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.
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.
Describes the configuration of On-Demand Instances in an EC2 Fleet.
" }, "OnDemandOptionsRequest": { "type": "structure", "members": { "AllocationStrategy": { "shape": "FleetOnDemandAllocationStrategy", "documentation": "The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
Default: lowest-price
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type instant.
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.
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.
Describes the configuration of On-Demand Instances in an EC2 Fleet.
" }, "OperationType": { "type": "string", "enum": [ "add", "remove" ] }, "OrganizationArnStringList": { "type": "list", "member": { "shape": "String", "locationName": "OrganizationArn" } }, "OrganizationalUnitArnStringList": { "type": "list", "member": { "shape": "String", "locationName": "OrganizationalUnitArn" } }, "OutpostArn": { "type": "string", "pattern": "^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" }, "OwnerStringList": { "type": "list", "member": { "shape": "String", "locationName": "Owner" } }, "PacketHeaderStatement": { "type": "structure", "members": { "SourceAddresses": { "shape": "ValueStringList", "documentation": "The source addresses.
", "locationName": "sourceAddressSet" }, "DestinationAddresses": { "shape": "ValueStringList", "documentation": "The destination addresses.
", "locationName": "destinationAddressSet" }, "SourcePorts": { "shape": "ValueStringList", "documentation": "The source ports.
", "locationName": "sourcePortSet" }, "DestinationPorts": { "shape": "ValueStringList", "documentation": "The destination ports.
", "locationName": "destinationPortSet" }, "SourcePrefixLists": { "shape": "ValueStringList", "documentation": "The source prefix lists.
", "locationName": "sourcePrefixListSet" }, "DestinationPrefixLists": { "shape": "ValueStringList", "documentation": "The destination prefix lists.
", "locationName": "destinationPrefixListSet" }, "Protocols": { "shape": "ProtocolList", "documentation": "The protocols.
", "locationName": "protocolSet" } }, "documentation": "Describes a packet header statement.
" }, "PacketHeaderStatementRequest": { "type": "structure", "members": { "SourceAddresses": { "shape": "ValueStringList", "documentation": "The source addresses.
", "locationName": "SourceAddress" }, "DestinationAddresses": { "shape": "ValueStringList", "documentation": "The destination addresses.
", "locationName": "DestinationAddress" }, "SourcePorts": { "shape": "ValueStringList", "documentation": "The source ports.
", "locationName": "SourcePort" }, "DestinationPorts": { "shape": "ValueStringList", "documentation": "The destination ports.
", "locationName": "DestinationPort" }, "SourcePrefixLists": { "shape": "ValueStringList", "documentation": "The source prefix lists.
", "locationName": "SourcePrefixList" }, "DestinationPrefixLists": { "shape": "ValueStringList", "documentation": "The destination prefix lists.
", "locationName": "DestinationPrefixList" }, "Protocols": { "shape": "ProtocolList", "documentation": "The protocols.
", "locationName": "Protocol" } }, "documentation": "Describes a packet header statement.
" }, "PartitionLoadFrequency": { "type": "string", "enum": [ "none", "daily", "weekly", "monthly" ] }, "PasswordData": { "type": "string", "sensitive": true }, "PathComponent": { "type": "structure", "members": { "SequenceNumber": { "shape": "Integer", "documentation": "The sequence number.
", "locationName": "sequenceNumber" }, "AclRule": { "shape": "AnalysisAclRule", "documentation": "The network ACL rule.
", "locationName": "aclRule" }, "AttachedTo": { "shape": "AnalysisComponent", "documentation": "The resource to which the path component is attached.
", "locationName": "attachedTo" }, "Component": { "shape": "AnalysisComponent", "documentation": "The component.
", "locationName": "component" }, "DestinationVpc": { "shape": "AnalysisComponent", "documentation": "The destination VPC.
", "locationName": "destinationVpc" }, "OutboundHeader": { "shape": "AnalysisPacketHeader", "documentation": "The outbound header.
", "locationName": "outboundHeader" }, "InboundHeader": { "shape": "AnalysisPacketHeader", "documentation": "The inbound header.
", "locationName": "inboundHeader" }, "RouteTableRoute": { "shape": "AnalysisRouteTableRoute", "documentation": "The route table route.
", "locationName": "routeTableRoute" }, "SecurityGroupRule": { "shape": "AnalysisSecurityGroupRule", "documentation": "The security group rule.
", "locationName": "securityGroupRule" }, "SourceVpc": { "shape": "AnalysisComponent", "documentation": "The source VPC.
", "locationName": "sourceVpc" }, "Subnet": { "shape": "AnalysisComponent", "documentation": "The subnet.
", "locationName": "subnet" }, "Vpc": { "shape": "AnalysisComponent", "documentation": "The component VPC.
", "locationName": "vpc" }, "AdditionalDetails": { "shape": "AdditionalDetailList", "documentation": "The additional details.
", "locationName": "additionalDetailSet" }, "TransitGateway": { "shape": "AnalysisComponent", "documentation": "The transit gateway.
", "locationName": "transitGateway" }, "TransitGatewayRouteTableRoute": { "shape": "TransitGatewayRouteTableRoute", "documentation": "The route in a transit gateway route table.
", "locationName": "transitGatewayRouteTableRoute" }, "Explanations": { "shape": "ExplanationList", "documentation": "The explanation codes.
", "locationName": "explanationSet" }, "ElasticLoadBalancerListener": { "shape": "AnalysisComponent", "documentation": "The load balancer listener.
", "locationName": "elasticLoadBalancerListener" }, "FirewallStatelessRule": { "shape": "FirewallStatelessRule", "documentation": "The Network Firewall stateless rule.
", "locationName": "firewallStatelessRule" }, "FirewallStatefulRule": { "shape": "FirewallStatefulRule", "documentation": "The Network Firewall stateful rule.
", "locationName": "firewallStatefulRule" }, "ServiceName": { "shape": "String", "documentation": "The name of the VPC endpoint service.
", "locationName": "serviceName" } }, "documentation": "Describes a path component.
" }, "PathComponentList": { "type": "list", "member": { "shape": "PathComponent", "locationName": "item" } }, "PathFilter": { "type": "structure", "members": { "SourceAddress": { "shape": "IpAddress", "documentation": "The source IPv4 address.
", "locationName": "sourceAddress" }, "SourcePortRange": { "shape": "FilterPortRange", "documentation": "The source port range.
", "locationName": "sourcePortRange" }, "DestinationAddress": { "shape": "IpAddress", "documentation": "The destination IPv4 address.
", "locationName": "destinationAddress" }, "DestinationPortRange": { "shape": "FilterPortRange", "documentation": "The destination port range.
", "locationName": "destinationPortRange" } }, "documentation": "Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.
" }, "PathRequestFilter": { "type": "structure", "members": { "SourceAddress": { "shape": "IpAddress", "documentation": "The source IPv4 address.
" }, "SourcePortRange": { "shape": "RequestFilterPortRange", "documentation": "The source port range.
" }, "DestinationAddress": { "shape": "IpAddress", "documentation": "The destination IPv4 address.
" }, "DestinationPortRange": { "shape": "RequestFilterPortRange", "documentation": "The destination port range.
" } }, "documentation": "Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.
" }, "PathStatement": { "type": "structure", "members": { "PacketHeaderStatement": { "shape": "PacketHeaderStatement", "documentation": "The packet header statement.
", "locationName": "packetHeaderStatement" }, "ResourceStatement": { "shape": "ResourceStatement", "documentation": "The resource statement.
", "locationName": "resourceStatement" } }, "documentation": "Describes a path statement.
" }, "PathStatementRequest": { "type": "structure", "members": { "PacketHeaderStatement": { "shape": "PacketHeaderStatementRequest", "documentation": "The packet header statement.
" }, "ResourceStatement": { "shape": "ResourceStatementRequest", "documentation": "The resource statement.
" } }, "documentation": "Describes a path statement.
" }, "PayerResponsibility": { "type": "string", "enum": [ "ServiceOwner" ] }, "PaymentOption": { "type": "string", "enum": [ "AllUpfront", "PartialUpfront", "NoUpfront" ] }, "PciId": { "type": "structure", "members": { "DeviceId": { "shape": "String", "documentation": "The ID of the device.
" }, "VendorId": { "shape": "String", "documentation": "The ID of the vendor.
" }, "SubsystemId": { "shape": "String", "documentation": "The ID of the subsystem.
" }, "SubsystemVendorId": { "shape": "String", "documentation": "The ID of the vendor for the subsystem.
" } }, "documentation": "Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.
" }, "PeakBandwidthInGbps": { "type": "double" }, "PeeringAttachmentStatus": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The status code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The status message, if applicable.
", "locationName": "message" } }, "documentation": "The status of the transit gateway peering attachment.
" }, "PeeringConnectionOptions": { "type": "structure", "members": { "AllowDnsResolutionFromRemoteVpc": { "shape": "Boolean", "documentation": "If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.
", "locationName": "allowDnsResolutionFromRemoteVpc" }, "AllowEgressFromLocalClassicLinkToRemoteVpc": { "shape": "Boolean", "documentation": "Deprecated.
", "locationName": "allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink": { "shape": "Boolean", "documentation": "Deprecated.
", "locationName": "allowEgressFromLocalVpcToRemoteClassicLink" } }, "documentation": "Describes the VPC peering connection options.
" }, "PeeringConnectionOptionsRequest": { "type": "structure", "members": { "AllowDnsResolutionFromRemoteVpc": { "shape": "Boolean", "documentation": "If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
" }, "AllowEgressFromLocalClassicLinkToRemoteVpc": { "shape": "Boolean", "documentation": "Deprecated.
" }, "AllowEgressFromLocalVpcToRemoteClassicLink": { "shape": "Boolean", "documentation": "Deprecated.
" } }, "documentation": "The VPC peering connection options.
" }, "PeeringTgwInfo": { "type": "structure", "members": { "TransitGatewayId": { "shape": "String", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "CoreNetworkId": { "shape": "String", "documentation": "The ID of the core network where the transit gateway peer is located.
", "locationName": "coreNetworkId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the transit gateway.
", "locationName": "ownerId" }, "Region": { "shape": "String", "documentation": "The Region of the transit gateway.
", "locationName": "region" } }, "documentation": "Information about the transit gateway in the peering attachment.
" }, "PeriodType": { "type": "string", "enum": [ "five-minutes", "fifteen-minutes", "one-hour", "three-hours", "one-day", "one-week" ] }, "PermissionGroup": { "type": "string", "enum": [ "all" ] }, "Phase1DHGroupNumbersList": { "type": "list", "member": { "shape": "Phase1DHGroupNumbersListValue", "locationName": "item" } }, "Phase1DHGroupNumbersListValue": { "type": "structure", "members": { "Value": { "shape": "Integer", "documentation": "The Diffie-Hellmann group number.
", "locationName": "value" } }, "documentation": "The Diffie-Hellmann group number for phase 1 IKE negotiations.
" }, "Phase1DHGroupNumbersRequestList": { "type": "list", "member": { "shape": "Phase1DHGroupNumbersRequestListValue", "locationName": "item" } }, "Phase1DHGroupNumbersRequestListValue": { "type": "structure", "members": { "Value": { "shape": "Integer", "documentation": "The Diffie-Hellmann group number.
" } }, "documentation": "Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.
" }, "Phase1EncryptionAlgorithmsList": { "type": "list", "member": { "shape": "Phase1EncryptionAlgorithmsListValue", "locationName": "item" } }, "Phase1EncryptionAlgorithmsListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The value for the encryption algorithm.
", "locationName": "value" } }, "documentation": "The encryption algorithm for phase 1 IKE negotiations.
" }, "Phase1EncryptionAlgorithmsRequestList": { "type": "list", "member": { "shape": "Phase1EncryptionAlgorithmsRequestListValue", "locationName": "item" } }, "Phase1EncryptionAlgorithmsRequestListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The value for the encryption algorithm.
" } }, "documentation": "Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.
" }, "Phase1IntegrityAlgorithmsList": { "type": "list", "member": { "shape": "Phase1IntegrityAlgorithmsListValue", "locationName": "item" } }, "Phase1IntegrityAlgorithmsListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The value for the integrity algorithm.
", "locationName": "value" } }, "documentation": "The integrity algorithm for phase 1 IKE negotiations.
" }, "Phase1IntegrityAlgorithmsRequestList": { "type": "list", "member": { "shape": "Phase1IntegrityAlgorithmsRequestListValue", "locationName": "item" } }, "Phase1IntegrityAlgorithmsRequestListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The value for the integrity algorithm.
" } }, "documentation": "Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.
" }, "Phase2DHGroupNumbersList": { "type": "list", "member": { "shape": "Phase2DHGroupNumbersListValue", "locationName": "item" } }, "Phase2DHGroupNumbersListValue": { "type": "structure", "members": { "Value": { "shape": "Integer", "documentation": "The Diffie-Hellmann group number.
", "locationName": "value" } }, "documentation": "The Diffie-Hellmann group number for phase 2 IKE negotiations.
" }, "Phase2DHGroupNumbersRequestList": { "type": "list", "member": { "shape": "Phase2DHGroupNumbersRequestListValue", "locationName": "item" } }, "Phase2DHGroupNumbersRequestListValue": { "type": "structure", "members": { "Value": { "shape": "Integer", "documentation": "The Diffie-Hellmann group number.
" } }, "documentation": "Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.
" }, "Phase2EncryptionAlgorithmsList": { "type": "list", "member": { "shape": "Phase2EncryptionAlgorithmsListValue", "locationName": "item" } }, "Phase2EncryptionAlgorithmsListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The encryption algorithm.
", "locationName": "value" } }, "documentation": "The encryption algorithm for phase 2 IKE negotiations.
" }, "Phase2EncryptionAlgorithmsRequestList": { "type": "list", "member": { "shape": "Phase2EncryptionAlgorithmsRequestListValue", "locationName": "item" } }, "Phase2EncryptionAlgorithmsRequestListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The encryption algorithm.
" } }, "documentation": "Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.
" }, "Phase2IntegrityAlgorithmsList": { "type": "list", "member": { "shape": "Phase2IntegrityAlgorithmsListValue", "locationName": "item" } }, "Phase2IntegrityAlgorithmsListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The integrity algorithm.
", "locationName": "value" } }, "documentation": "The integrity algorithm for phase 2 IKE negotiations.
" }, "Phase2IntegrityAlgorithmsRequestList": { "type": "list", "member": { "shape": "Phase2IntegrityAlgorithmsRequestListValue", "locationName": "item" } }, "Phase2IntegrityAlgorithmsRequestListValue": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The integrity algorithm.
" } }, "documentation": "Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.
" }, "Placement": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported for CreateFleet.
", "locationName": "availabilityZone" }, "Affinity": { "shape": "String", "documentation": "The affinity setting for the instance on the Dedicated Host.
This parameter is not supported for CreateFleet or ImportInstance.
", "locationName": "affinity" }, "GroupName": { "shape": "PlacementGroupName", "documentation": "The name of the placement group that the instance is in. If you specify GroupName, you can't specify GroupId.
The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported for CreateFleet.
", "locationName": "partitionNumber" }, "HostId": { "shape": "String", "documentation": "The ID of the Dedicated Host on which the instance resides.
This parameter is not supported for CreateFleet or ImportInstance.
", "locationName": "hostId" }, "Tenancy": { "shape": "Tenancy", "documentation": "The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.
Reserved for future use.
", "locationName": "spreadDomain" }, "HostResourceGroupArn": { "shape": "String", "documentation": "The ARN of the host resource group in which to launch the instances.
If you specify this parameter, either omit the Tenancy parameter or set it to host.
This parameter is not supported for CreateFleet.
", "locationName": "hostResourceGroupArn" }, "GroupId": { "shape": "PlacementGroupId", "documentation": "The ID of the placement group that the instance is in. If you specify GroupId, you can't specify GroupName.
Describes the placement of an instance.
" }, "PlacementGroup": { "type": "structure", "members": { "GroupName": { "shape": "String", "documentation": "The name of the placement group.
", "locationName": "groupName" }, "State": { "shape": "PlacementGroupState", "documentation": "The state of the placement group.
", "locationName": "state" }, "Strategy": { "shape": "PlacementStrategy", "documentation": "The placement strategy.
", "locationName": "strategy" }, "PartitionCount": { "shape": "Integer", "documentation": "The number of partitions. Valid only if strategy is set to partition.
The ID of the placement group.
", "locationName": "groupId" }, "Tags": { "shape": "TagList", "documentation": "Any tags applied to the placement group.
", "locationName": "tagSet" }, "GroupArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the placement group.
", "locationName": "groupArn" }, "SpreadLevel": { "shape": "SpreadLevel", "documentation": "The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
", "locationName": "spreadLevel" } }, "documentation": "Describes a placement group.
" }, "PlacementGroupArn": { "type": "string", "pattern": "^arn:aws([a-z-]+)?:ec2:[a-z\\d-]+:\\d{12}:placement-group/^.{1,255}$" }, "PlacementGroupId": { "type": "string" }, "PlacementGroupIdStringList": { "type": "list", "member": { "shape": "PlacementGroupId", "locationName": "GroupId" } }, "PlacementGroupInfo": { "type": "structure", "members": { "SupportedStrategies": { "shape": "PlacementGroupStrategyList", "documentation": "The supported placement group types.
", "locationName": "supportedStrategies" } }, "documentation": "Describes the placement group support of the instance type.
" }, "PlacementGroupList": { "type": "list", "member": { "shape": "PlacementGroup", "locationName": "item" } }, "PlacementGroupName": { "type": "string" }, "PlacementGroupState": { "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStrategy": { "type": "string", "enum": [ "cluster", "partition", "spread" ] }, "PlacementGroupStrategyList": { "type": "list", "member": { "shape": "PlacementGroupStrategy", "locationName": "item" } }, "PlacementGroupStringList": { "type": "list", "member": { "shape": "PlacementGroupName" } }, "PlacementResponse": { "type": "structure", "members": { "GroupName": { "shape": "PlacementGroupName", "documentation": "The name of the placement group that the instance is in.
", "locationName": "groupName" } }, "documentation": "Describes the placement of an instance.
" }, "PlacementStrategy": { "type": "string", "enum": [ "cluster", "spread", "partition" ] }, "PlatformValues": { "type": "string", "enum": [ "Windows" ] }, "PoolCidrBlock": { "type": "structure", "members": { "Cidr": { "shape": "String", "documentation": "The CIDR block.
", "locationName": "poolCidrBlock" } }, "documentation": "Describes a CIDR block for an address pool.
" }, "PoolCidrBlocksSet": { "type": "list", "member": { "shape": "PoolCidrBlock", "locationName": "item" } }, "PoolMaxResults": { "type": "integer", "max": 10, "min": 1 }, "Port": { "type": "integer", "max": 65535, "min": 0 }, "PortRange": { "type": "structure", "members": { "From": { "shape": "Integer", "documentation": "The first port in the range.
", "locationName": "from" }, "To": { "shape": "Integer", "documentation": "The last port in the range.
", "locationName": "to" } }, "documentation": "Describes a range of ports.
" }, "PortRangeList": { "type": "list", "member": { "shape": "PortRange", "locationName": "item" } }, "PrefixList": { "type": "structure", "members": { "Cidrs": { "shape": "ValueStringList", "documentation": "The IP address range of the Amazon Web Service.
", "locationName": "cidrSet" }, "PrefixListId": { "shape": "String", "documentation": "The ID of the prefix.
", "locationName": "prefixListId" }, "PrefixListName": { "shape": "String", "documentation": "The name of the prefix.
", "locationName": "prefixListName" } }, "documentation": "Describes prefixes for Amazon Web Services services.
" }, "PrefixListAssociation": { "type": "structure", "members": { "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceOwner": { "shape": "String", "documentation": "The owner of the resource.
", "locationName": "resourceOwner" } }, "documentation": "Describes the resource with which a prefix list is associated.
" }, "PrefixListAssociationSet": { "type": "list", "member": { "shape": "PrefixListAssociation", "locationName": "item" } }, "PrefixListEntry": { "type": "structure", "members": { "Cidr": { "shape": "String", "documentation": "The CIDR block.
", "locationName": "cidr" }, "Description": { "shape": "String", "documentation": "The description.
", "locationName": "description" } }, "documentation": "Describes a prefix list entry.
" }, "PrefixListEntrySet": { "type": "list", "member": { "shape": "PrefixListEntry", "locationName": "item" } }, "PrefixListId": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
", "locationName": "description" }, "PrefixListId": { "shape": "String", "documentation": "The ID of the prefix.
", "locationName": "prefixListId" } }, "documentation": "Describes a prefix list ID.
" }, "PrefixListIdList": { "type": "list", "member": { "shape": "PrefixListId", "locationName": "item" } }, "PrefixListIdSet": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "PrefixListMaxResults": { "type": "integer", "max": 100, "min": 1 }, "PrefixListResourceId": { "type": "string" }, "PrefixListResourceIdStringList": { "type": "list", "member": { "shape": "PrefixListResourceId", "locationName": "item" } }, "PrefixListSet": { "type": "list", "member": { "shape": "PrefixList", "locationName": "item" } }, "PrefixListState": { "type": "string", "enum": [ "create-in-progress", "create-complete", "create-failed", "modify-in-progress", "modify-complete", "modify-failed", "restore-in-progress", "restore-complete", "restore-failed", "delete-in-progress", "delete-complete", "delete-failed" ] }, "PriceSchedule": { "type": "structure", "members": { "Active": { "shape": "Boolean", "documentation": "The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
", "locationName": "active" }, "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
The fixed price for the term.
", "locationName": "price" }, "Term": { "shape": "Long", "documentation": "The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", "locationName": "term" } }, "documentation": "Describes the price for a Reserved Instance.
" }, "PriceScheduleList": { "type": "list", "member": { "shape": "PriceSchedule", "locationName": "item" } }, "PriceScheduleSpecification": { "type": "structure", "members": { "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
The fixed price for the term.
", "locationName": "price" }, "Term": { "shape": "Long", "documentation": "The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", "locationName": "term" } }, "documentation": "Describes the price for a Reserved Instance.
" }, "PriceScheduleSpecificationList": { "type": "list", "member": { "shape": "PriceScheduleSpecification", "locationName": "item" } }, "PricingDetail": { "type": "structure", "members": { "Count": { "shape": "Integer", "documentation": "The number of reservations available for the price.
", "locationName": "count" }, "Price": { "shape": "Double", "documentation": "The price per instance.
", "locationName": "price" } }, "documentation": "Describes a Reserved Instance offering.
" }, "PricingDetailsList": { "type": "list", "member": { "shape": "PricingDetail", "locationName": "item" } }, "PrincipalIdFormat": { "type": "structure", "members": { "Arn": { "shape": "String", "documentation": "PrincipalIdFormatARN description
", "locationName": "arn" }, "Statuses": { "shape": "IdFormatList", "documentation": "PrincipalIdFormatStatuses description
", "locationName": "statusSet" } }, "documentation": "PrincipalIdFormat description
" }, "PrincipalIdFormatList": { "type": "list", "member": { "shape": "PrincipalIdFormat", "locationName": "item" } }, "PrincipalType": { "type": "string", "enum": [ "All", "Service", "OrganizationUnit", "Account", "User", "Role" ] }, "Priority": { "type": "integer", "max": 65535, "min": -1 }, "PrivateDnsDetails": { "type": "structure", "members": { "PrivateDnsName": { "shape": "String", "documentation": "The private DNS name assigned to the VPC endpoint service.
", "locationName": "privateDnsName" } }, "documentation": "Information about the Private DNS name for interface endpoints.
" }, "PrivateDnsDetailsSet": { "type": "list", "member": { "shape": "PrivateDnsDetails", "locationName": "item" } }, "PrivateDnsNameConfiguration": { "type": "structure", "members": { "State": { "shape": "DnsNameState", "documentation": "The verification state of the VPC endpoint service.
>Consumers of the endpoint service can use the private name only when the state is verified.
The endpoint service verification type, for example TXT.
", "locationName": "type" }, "Value": { "shape": "String", "documentation": "The value the service provider adds to the private DNS name domain record before verification.
", "locationName": "value" }, "Name": { "shape": "String", "documentation": "The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.
Information about the private DNS name for the service endpoint.
" }, "PrivateDnsNameOptionsOnLaunch": { "type": "structure", "members": { "HostnameType": { "shape": "HostnameType", "documentation": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
", "locationName": "hostnameType" }, "EnableResourceNameDnsARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
", "locationName": "enableResourceNameDnsARecord" }, "EnableResourceNameDnsAAAARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
", "locationName": "enableResourceNameDnsAAAARecord" } }, "documentation": "Describes the options for instance hostnames.
" }, "PrivateDnsNameOptionsRequest": { "type": "structure", "members": { "HostnameType": { "shape": "HostnameType", "documentation": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.
" }, "EnableResourceNameDnsARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
" }, "EnableResourceNameDnsAAAARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
" } }, "documentation": "Describes the options for instance hostnames.
" }, "PrivateDnsNameOptionsResponse": { "type": "structure", "members": { "HostnameType": { "shape": "HostnameType", "documentation": "The type of hostname to assign to an instance.
", "locationName": "hostnameType" }, "EnableResourceNameDnsARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
", "locationName": "enableResourceNameDnsARecord" }, "EnableResourceNameDnsAAAARecord": { "shape": "Boolean", "documentation": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
", "locationName": "enableResourceNameDnsAAAARecord" } }, "documentation": "Describes the options for instance hostnames.
" }, "PrivateIpAddressConfigSet": { "type": "list", "member": { "shape": "ScheduledInstancesPrivateIpAddressConfig", "locationName": "PrivateIpAddressConfigSet" } }, "PrivateIpAddressCount": { "type": "integer", "max": 31, "min": 1 }, "PrivateIpAddressSpecification": { "type": "structure", "members": { "Primary": { "shape": "Boolean", "documentation": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
", "locationName": "primary" }, "PrivateIpAddress": { "shape": "String", "documentation": "The private IPv4 address.
", "locationName": "privateIpAddress" } }, "documentation": "Describes a secondary private IPv4 address for a network interface.
" }, "PrivateIpAddressSpecificationList": { "type": "list", "member": { "shape": "PrivateIpAddressSpecification", "locationName": "item" } }, "PrivateIpAddressStringList": { "type": "list", "member": { "shape": "String", "locationName": "PrivateIpAddress" } }, "ProcessorInfo": { "type": "structure", "members": { "SupportedArchitectures": { "shape": "ArchitectureTypeList", "documentation": "The architectures supported by the instance type.
", "locationName": "supportedArchitectures" }, "SustainedClockSpeedInGhz": { "shape": "ProcessorSustainedClockSpeed", "documentation": "The speed of the processor, in GHz.
", "locationName": "sustainedClockSpeedInGhz" }, "SupportedFeatures": { "shape": "SupportedAdditionalProcessorFeatureList", "documentation": "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.
The manufacturer of the processor.
", "locationName": "manufacturer" } }, "documentation": "Describes the processor used by the instance type.
" }, "ProcessorSustainedClockSpeed": { "type": "double" }, "ProductCode": { "type": "structure", "members": { "ProductCodeId": { "shape": "String", "documentation": "The product code.
", "locationName": "productCode" }, "ProductCodeType": { "shape": "ProductCodeValues", "documentation": "The type of product code.
", "locationName": "type" } }, "documentation": "Describes a product code.
" }, "ProductCodeList": { "type": "list", "member": { "shape": "ProductCode", "locationName": "item" } }, "ProductCodeStringList": { "type": "list", "member": { "shape": "String", "locationName": "ProductCode" } }, "ProductCodeValues": { "type": "string", "enum": [ "devpay", "marketplace" ] }, "ProductDescriptionList": { "type": "list", "member": { "shape": "String" } }, "PropagatingVgw": { "type": "structure", "members": { "GatewayId": { "shape": "String", "documentation": "The ID of the virtual private gateway.
", "locationName": "gatewayId" } }, "documentation": "Describes a virtual private gateway propagating route.
" }, "PropagatingVgwList": { "type": "list", "member": { "shape": "PropagatingVgw", "locationName": "item" } }, "Protocol": { "type": "string", "enum": [ "tcp", "udp" ] }, "ProtocolInt": { "type": "integer", "max": 255, "min": 0 }, "ProtocolIntList": { "type": "list", "member": { "shape": "ProtocolInt", "locationName": "item" } }, "ProtocolList": { "type": "list", "member": { "shape": "Protocol", "locationName": "item" } }, "ProtocolValue": { "type": "string", "enum": [ "gre" ] }, "ProvisionByoipCidrRequest": { "type": "structure", "required": [ "Cidr" ], "members": { "Cidr": { "shape": "String", "documentation": "The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
" }, "CidrAuthorizationContext": { "shape": "CidrAuthorizationContext", "documentation": "A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
" }, "PubliclyAdvertisable": { "shape": "Boolean", "documentation": "(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
" }, "Description": { "shape": "String", "documentation": "A description for the address range and the address pool.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tags to apply to the address pool.
", "locationName": "PoolTagSpecification" }, "MultiRegion": { "shape": "Boolean", "documentation": "Reserved.
" }, "NetworkBorderGroup": { "shape": "String", "documentation": "If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
Information about the address range.
", "locationName": "byoipCidr" } } }, "ProvisionIpamByoasnRequest": { "type": "structure", "required": [ "IpamId", "Asn", "AsnAuthorizationContext" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
An IPAM ID.
" }, "Asn": { "shape": "String", "documentation": "A public 2-byte or 4-byte ASN.
" }, "AsnAuthorizationContext": { "shape": "AsnAuthorizationContext", "documentation": "An ASN authorization context.
" } } }, "ProvisionIpamByoasnResult": { "type": "structure", "members": { "Byoasn": { "shape": "Byoasn", "documentation": "An ASN and BYOIP CIDR association.
", "locationName": "byoasn" } } }, "ProvisionIpamPoolCidrRequest": { "type": "structure", "required": [ "IpamPoolId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the IPAM pool to which you want to assign a CIDR.
" }, "Cidr": { "shape": "String", "documentation": "The CIDR you want to assign to the IPAM pool. Either \"NetmaskLength\" or \"Cidr\" is required. This value will be null if you specify \"NetmaskLength\" and will be filled in during the provisioning process.
" }, "CidrAuthorizationContext": { "shape": "IpamCidrAuthorizationContext", "documentation": "A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
" }, "NetmaskLength": { "shape": "Integer", "documentation": "The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either \"NetmaskLength\" or \"Cidr\" is required.
" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true } } }, "ProvisionIpamPoolCidrResult": { "type": "structure", "members": { "IpamPoolCidr": { "shape": "IpamPoolCidr", "documentation": "Information about the provisioned CIDR.
", "locationName": "ipamPoolCidr" } } }, "ProvisionPublicIpv4PoolCidrRequest": { "type": "structure", "required": [ "IpamPoolId", "PoolId", "NetmaskLength" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the IPAM pool you would like to use to allocate this CIDR.
" }, "PoolId": { "shape": "Ipv4PoolEc2Id", "documentation": "The ID of the public IPv4 pool you would like to use for this CIDR.
" }, "NetmaskLength": { "shape": "Integer", "documentation": "The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
" } } }, "ProvisionPublicIpv4PoolCidrResult": { "type": "structure", "members": { "PoolId": { "shape": "Ipv4PoolEc2Id", "documentation": "The ID of the pool that you want to provision the CIDR to.
", "locationName": "poolId" }, "PoolAddressRange": { "shape": "PublicIpv4PoolRange", "documentation": "Information about the address range of the public IPv4 pool.
", "locationName": "poolAddressRange" } } }, "ProvisionedBandwidth": { "type": "structure", "members": { "ProvisionTime": { "shape": "DateTime", "documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", "locationName": "provisionTime" }, "Provisioned": { "shape": "String", "documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", "locationName": "provisioned" }, "RequestTime": { "shape": "DateTime", "documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", "locationName": "requestTime" }, "Requested": { "shape": "String", "documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", "locationName": "requested" }, "Status": { "shape": "String", "documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
", "locationName": "status" } }, "documentation": "Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
" }, "PtrUpdateStatus": { "type": "structure", "members": { "Value": { "shape": "String", "documentation": "The value for the PTR record update.
", "locationName": "value" }, "Status": { "shape": "String", "documentation": "The status of the PTR record update.
", "locationName": "status" }, "Reason": { "shape": "String", "documentation": "The reason for the PTR record update.
", "locationName": "reason" } }, "documentation": "The status of an updated pointer (PTR) record for an Elastic IP address.
" }, "PublicIpAddress": { "type": "string" }, "PublicIpStringList": { "type": "list", "member": { "shape": "String", "locationName": "PublicIp" } }, "PublicIpv4Pool": { "type": "structure", "members": { "PoolId": { "shape": "String", "documentation": "The ID of the address pool.
", "locationName": "poolId" }, "Description": { "shape": "String", "documentation": "A description of the address pool.
", "locationName": "description" }, "PoolAddressRanges": { "shape": "PublicIpv4PoolRangeSet", "documentation": "The address ranges.
", "locationName": "poolAddressRangeSet" }, "TotalAddressCount": { "shape": "Integer", "documentation": "The total number of addresses.
", "locationName": "totalAddressCount" }, "TotalAvailableAddressCount": { "shape": "Integer", "documentation": "The total number of available addresses.
", "locationName": "totalAvailableAddressCount" }, "NetworkBorderGroup": { "shape": "String", "documentation": "The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.
", "locationName": "networkBorderGroup" }, "Tags": { "shape": "TagList", "documentation": "Any tags for the address pool.
", "locationName": "tagSet" } }, "documentation": "Describes an IPv4 address pool.
" }, "PublicIpv4PoolIdStringList": { "type": "list", "member": { "shape": "Ipv4PoolEc2Id", "locationName": "item" } }, "PublicIpv4PoolRange": { "type": "structure", "members": { "FirstAddress": { "shape": "String", "documentation": "The first IP address in the range.
", "locationName": "firstAddress" }, "LastAddress": { "shape": "String", "documentation": "The last IP address in the range.
", "locationName": "lastAddress" }, "AddressCount": { "shape": "Integer", "documentation": "The number of addresses in the range.
", "locationName": "addressCount" }, "AvailableAddressCount": { "shape": "Integer", "documentation": "The number of available addresses in the range.
", "locationName": "availableAddressCount" } }, "documentation": "Describes an address range of an IPv4 address pool.
" }, "PublicIpv4PoolRangeSet": { "type": "list", "member": { "shape": "PublicIpv4PoolRange", "locationName": "item" } }, "PublicIpv4PoolSet": { "type": "list", "member": { "shape": "PublicIpv4Pool", "locationName": "item" } }, "Purchase": { "type": "structure", "members": { "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.
The duration of the reservation's term in seconds.
", "locationName": "duration" }, "HostIdSet": { "shape": "ResponseHostIdSet", "documentation": "The IDs of the Dedicated Hosts associated with the reservation.
", "locationName": "hostIdSet" }, "HostReservationId": { "shape": "HostReservationId", "documentation": "The ID of the reservation.
", "locationName": "hostReservationId" }, "HourlyPrice": { "shape": "String", "documentation": "The hourly price of the reservation per hour.
", "locationName": "hourlyPrice" }, "InstanceFamily": { "shape": "String", "documentation": "The instance family on the Dedicated Host that the reservation can be associated with.
", "locationName": "instanceFamily" }, "PaymentOption": { "shape": "PaymentOption", "documentation": "The payment option for the reservation.
", "locationName": "paymentOption" }, "UpfrontPrice": { "shape": "String", "documentation": "The upfront price of the reservation.
", "locationName": "upfrontPrice" } }, "documentation": "Describes the result of the purchase.
" }, "PurchaseCapacityBlockRequest": { "type": "structure", "required": [ "CapacityBlockOfferingId", "InstancePlatform" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The tags to apply to the Capacity Block during launch.
", "locationName": "TagSpecification" }, "CapacityBlockOfferingId": { "shape": "OfferingId", "documentation": "The ID of the Capacity Block offering.
" }, "InstancePlatform": { "shape": "CapacityReservationInstancePlatform", "documentation": "The type of operating system for which to reserve capacity.
" } } }, "PurchaseCapacityBlockResult": { "type": "structure", "members": { "CapacityReservation": { "shape": "CapacityReservation", "documentation": "The Capacity Reservation.
", "locationName": "capacityReservation" } } }, "PurchaseHostReservationRequest": { "type": "structure", "required": [ "HostIdSet", "OfferingId" ], "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
" }, "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
The IDs of the Dedicated Hosts with which the reservation will be associated.
" }, "LimitPrice": { "shape": "String", "documentation": "The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.
The ID of the offering.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the Dedicated Host Reservation during purchase.
", "locationName": "TagSpecification" } } }, "PurchaseHostReservationResult": { "type": "structure", "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "locationName": "clientToken" }, "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
Describes the details of the purchase.
", "locationName": "purchase" }, "TotalHourlyPrice": { "shape": "String", "documentation": "The total hourly price of the reservation calculated per hour.
", "locationName": "totalHourlyPrice" }, "TotalUpfrontPrice": { "shape": "String", "documentation": "The total amount charged to your account when you purchase the reservation.
", "locationName": "totalUpfrontPrice" } } }, "PurchaseRequest": { "type": "structure", "required": [ "InstanceCount", "PurchaseToken" ], "members": { "InstanceCount": { "shape": "Integer", "documentation": "The number of instances.
" }, "PurchaseToken": { "shape": "String", "documentation": "The purchase token.
" } }, "documentation": "Describes a request to purchase Scheduled Instances.
" }, "PurchaseRequestSet": { "type": "list", "member": { "shape": "PurchaseRequest", "locationName": "PurchaseRequest" }, "min": 1 }, "PurchaseReservedInstancesOfferingRequest": { "type": "structure", "required": [ "InstanceCount", "ReservedInstancesOfferingId" ], "members": { "InstanceCount": { "shape": "Integer", "documentation": "The number of Reserved Instances to purchase.
" }, "ReservedInstancesOfferingId": { "shape": "ReservedInstancesOfferingId", "documentation": "The ID of the Reserved Instance offering to purchase.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
", "locationName": "limitPrice" }, "PurchaseTime": { "shape": "DateTime", "documentation": "The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
" } }, "documentation": "Contains the parameters for PurchaseReservedInstancesOffering.
" }, "PurchaseReservedInstancesOfferingResult": { "type": "structure", "members": { "ReservedInstancesId": { "shape": "String", "documentation": "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.
", "locationName": "reservedInstancesId" } }, "documentation": "Contains the output of PurchaseReservedInstancesOffering.
" }, "PurchaseScheduledInstancesRequest": { "type": "structure", "required": [ "PurchaseRequests" ], "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The purchase requests.
", "locationName": "PurchaseRequest" } }, "documentation": "Contains the parameters for PurchaseScheduledInstances.
" }, "PurchaseScheduledInstancesResult": { "type": "structure", "members": { "ScheduledInstanceSet": { "shape": "PurchasedScheduledInstanceSet", "documentation": "Information about the Scheduled Instances.
", "locationName": "scheduledInstanceSet" } }, "documentation": "Contains the output of PurchaseScheduledInstances.
" }, "PurchaseSet": { "type": "list", "member": { "shape": "Purchase", "locationName": "item" } }, "PurchasedScheduledInstanceSet": { "type": "list", "member": { "shape": "ScheduledInstance", "locationName": "item" } }, "RIProductDescription": { "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "RamdiskId": { "type": "string" }, "ReasonCodesList": { "type": "list", "member": { "shape": "ReportInstanceReasonCodes", "locationName": "item" } }, "RebootInstancesRequest": { "type": "structure", "required": [ "InstanceIds" ], "members": { "InstanceIds": { "shape": "InstanceIdStringList", "documentation": "The instance IDs.
", "locationName": "InstanceId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The amount of the recurring charge.
", "locationName": "amount" }, "Frequency": { "shape": "RecurringChargeFrequency", "documentation": "The frequency of the recurring charge.
", "locationName": "frequency" } }, "documentation": "Describes a recurring charge.
" }, "RecurringChargeFrequency": { "type": "string", "enum": [ "Hourly" ] }, "RecurringChargesList": { "type": "list", "member": { "shape": "RecurringCharge", "locationName": "item" } }, "ReferencedSecurityGroup": { "type": "structure", "members": { "GroupId": { "shape": "String", "documentation": "The ID of the security group.
", "locationName": "groupId" }, "PeeringStatus": { "shape": "String", "documentation": "The status of a VPC peering connection, if applicable.
", "locationName": "peeringStatus" }, "UserId": { "shape": "String", "documentation": "The Amazon Web Services account ID.
", "locationName": "userId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "VpcPeeringConnectionId": { "shape": "String", "documentation": "The ID of the VPC peering connection (if applicable).
", "locationName": "vpcPeeringConnectionId" } }, "documentation": "Describes the security group that is referenced in the security group rule.
" }, "Region": { "type": "structure", "members": { "Endpoint": { "shape": "String", "documentation": "The Region service endpoint.
", "locationName": "regionEndpoint" }, "RegionName": { "shape": "String", "documentation": "The name of the Region.
", "locationName": "regionName" }, "OptInStatus": { "shape": "String", "documentation": "The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.
Describes a Region.
" }, "RegionList": { "type": "list", "member": { "shape": "Region", "locationName": "item" } }, "RegionNameStringList": { "type": "list", "member": { "shape": "String", "locationName": "RegionName" } }, "RegionNames": { "type": "list", "member": { "shape": "String" }, "max": 10, "min": 0 }, "RegisterImageRequest": { "type": "structure", "required": [ "Name" ], "members": { "ImageLocation": { "shape": "String", "documentation": "The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.
The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
", "locationName": "BlockDeviceMapping" }, "Description": { "shape": "String", "documentation": "A description for your AMI.
", "locationName": "description" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", "locationName": "enaSupport" }, "KernelId": { "shape": "KernelId", "documentation": "The ID of the kernel.
", "locationName": "kernelId" }, "Name": { "shape": "String", "documentation": "A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", "locationName": "name" }, "BillingProducts": { "shape": "BillingProductList", "documentation": "The billing product codes. Your account must be authorized to specify billing product codes.
If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.
", "locationName": "BillingProduct" }, "RamdiskId": { "shape": "RamdiskId", "documentation": "The ID of the RAM disk.
", "locationName": "ramdiskId" }, "RootDeviceName": { "shape": "String", "documentation": "The device name of the root device volume (for example, /dev/sda1).
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", "locationName": "sriovNetSupport" }, "VirtualizationType": { "shape": "String", "documentation": "The type of virtualization (hvm | paravirtual).
Default: paravirtual
The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Boot modes in the Amazon EC2 User Guide.
" }, "TpmSupport": { "shape": "TpmSupportValues", "documentation": "Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
" }, "ImdsSupport": { "shape": "ImdsSupportValues", "documentation": "Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
The tags to apply to the AMI.
To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.
To tag an AMI after it has been registered, see CreateTags.
", "locationName": "TagSpecification" } }, "documentation": "Contains the parameters for RegisterImage.
" }, "RegisterImageResult": { "type": "structure", "members": { "ImageId": { "shape": "String", "documentation": "The ID of the newly registered AMI.
", "locationName": "imageId" } }, "documentation": "Contains the output of RegisterImage.
" }, "RegisterInstanceEventNotificationAttributesRequest": { "type": "structure", "required": [ "InstanceTagAttribute" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the tag keys to register.
" } } }, "RegisterInstanceEventNotificationAttributesResult": { "type": "structure", "members": { "InstanceTagAttribute": { "shape": "InstanceTagNotificationAttribute", "documentation": "The resulting set of tag keys.
", "locationName": "instanceTagAttribute" } } }, "RegisterInstanceTagAttributeRequest": { "type": "structure", "members": { "IncludeAllTagsOfInstance": { "shape": "Boolean", "documentation": "Indicates whether to register all tag keys in the current Region. Specify true to register all tag keys.
The tag keys to register.
", "locationName": "InstanceTagKey" } }, "documentation": "Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
The ID of the transit gateway multicast domain.
" }, "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
" }, "NetworkInterfaceIds": { "shape": "TransitGatewayNetworkInterfaceIdList", "documentation": "The group members' network interface IDs to register with the transit gateway multicast group.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the registered transit gateway multicast group members.
", "locationName": "registeredMulticastGroupMembers" } } }, "RegisterTransitGatewayMulticastGroupSourcesRequest": { "type": "structure", "required": [ "TransitGatewayMulticastDomainId", "NetworkInterfaceIds" ], "members": { "TransitGatewayMulticastDomainId": { "shape": "TransitGatewayMulticastDomainId", "documentation": "The ID of the transit gateway multicast domain.
" }, "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
" }, "NetworkInterfaceIds": { "shape": "TransitGatewayNetworkInterfaceIdList", "documentation": "The group sources' network interface IDs to register with the transit gateway multicast group.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateway multicast group sources.
", "locationName": "registeredMulticastGroupSources" } } }, "RejectTransitGatewayMulticastDomainAssociationsRequest": { "type": "structure", "members": { "TransitGatewayMulticastDomainId": { "shape": "TransitGatewayMulticastDomainId", "documentation": "The ID of the transit gateway multicast domain.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway attachment.
" }, "SubnetIds": { "shape": "ValueStringList", "documentation": "The IDs of the subnets to associate with the transit gateway multicast domain.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the multicast domain associations.
", "locationName": "associations" } } }, "RejectTransitGatewayPeeringAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway peering attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The transit gateway peering attachment.
", "locationName": "transitGatewayPeeringAttachment" } } }, "RejectTransitGatewayVpcAttachmentRequest": { "type": "structure", "required": [ "TransitGatewayAttachmentId" ], "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the attachment.
", "locationName": "transitGatewayVpcAttachment" } } }, "RejectVpcEndpointConnectionsRequest": { "type": "structure", "required": [ "ServiceId", "VpcEndpointIds" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the service.
" }, "VpcEndpointIds": { "shape": "VpcEndpointIdList", "documentation": "The IDs of the VPC endpoints.
", "locationName": "VpcEndpointId" } } }, "RejectVpcEndpointConnectionsResult": { "type": "structure", "members": { "Unsuccessful": { "shape": "UnsuccessfulItemSet", "documentation": "Information about the endpoints that were not rejected, if applicable.
", "locationName": "unsuccessful" } } }, "RejectVpcPeeringConnectionRequest": { "type": "structure", "required": [ "VpcPeeringConnectionId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the VPC peering connection.
", "locationName": "vpcPeeringConnectionId" } } }, "RejectVpcPeeringConnectionResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The allocation ID. This parameter is required.
" }, "PublicIp": { "shape": "String", "documentation": "Deprecated.
" }, "NetworkBorderGroup": { "shape": "String", "documentation": "The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
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.
The IDs of the Dedicated Hosts to release.
", "locationName": "hostId" } } }, "ReleaseHostsResult": { "type": "structure", "members": { "Successful": { "shape": "ResponseHostIdList", "documentation": "The IDs of the Dedicated Hosts that were successfully released.
", "locationName": "successful" }, "Unsuccessful": { "shape": "UnsuccessfulItemList", "documentation": "The IDs of the Dedicated Hosts that could not be released, including an error message.
", "locationName": "unsuccessful" } } }, "ReleaseIpamPoolAllocationRequest": { "type": "structure", "required": [ "IpamPoolId", "Cidr", "IpamPoolAllocationId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "A check for 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.
The ID of the IPAM pool which contains the allocation you want to release.
" }, "Cidr": { "shape": "String", "documentation": "The CIDR of the allocation you want to release.
" }, "IpamPoolAllocationId": { "shape": "IpamPoolAllocationId", "documentation": "The ID of the allocation.
" } } }, "ReleaseIpamPoolAllocationResult": { "type": "structure", "members": { "Success": { "shape": "Boolean", "documentation": "Indicates if the release was successful.
", "locationName": "success" } } }, "RemoveIpamOperatingRegion": { "type": "structure", "members": { "RegionName": { "shape": "String", "documentation": "The name of the operating Region you want to remove.
" } }, "documentation": "Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide
" }, "RemoveIpamOperatingRegionSet": { "type": "list", "member": { "shape": "RemoveIpamOperatingRegion" }, "max": 50, "min": 0 }, "RemovePrefixListEntries": { "type": "list", "member": { "shape": "RemovePrefixListEntry" }, "max": 100, "min": 0 }, "RemovePrefixListEntry": { "type": "structure", "required": [ "Cidr" ], "members": { "Cidr": { "shape": "String", "documentation": "The CIDR block.
" } }, "documentation": "An entry for a prefix list.
" }, "ReplaceIamInstanceProfileAssociationRequest": { "type": "structure", "required": [ "IamInstanceProfile", "AssociationId" ], "members": { "IamInstanceProfile": { "shape": "IamInstanceProfileSpecification", "documentation": "The IAM instance profile.
" }, "AssociationId": { "shape": "IamInstanceProfileAssociationId", "documentation": "The ID of the existing IAM instance profile association.
" } } }, "ReplaceIamInstanceProfileAssociationResult": { "type": "structure", "members": { "IamInstanceProfileAssociation": { "shape": "IamInstanceProfileAssociation", "documentation": "Information about the IAM instance profile association.
", "locationName": "iamInstanceProfileAssociation" } } }, "ReplaceNetworkAclAssociationRequest": { "type": "structure", "required": [ "AssociationId", "NetworkAclId" ], "members": { "AssociationId": { "shape": "NetworkAclAssociationId", "documentation": "The ID of the current association between the original network ACL and the subnet.
", "locationName": "associationId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the new network ACL to associate with the subnet.
", "locationName": "networkAclId" } } }, "ReplaceNetworkAclAssociationResult": { "type": "structure", "members": { "NewAssociationId": { "shape": "String", "documentation": "The ID of the new association.
", "locationName": "newAssociationId" } } }, "ReplaceNetworkAclEntryRequest": { "type": "structure", "required": [ "Egress", "NetworkAclId", "Protocol", "RuleAction", "RuleNumber" ], "members": { "CidrBlock": { "shape": "String", "documentation": "The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
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.
Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
", "locationName": "egress" }, "IcmpTypeCode": { "shape": "IcmpTypeCode", "documentation": "ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
", "locationName": "Icmp" }, "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).
The ID of the ACL.
", "locationName": "networkAclId" }, "PortRange": { "shape": "PortRange", "documentation": "TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
", "locationName": "portRange" }, "Protocol": { "shape": "String", "documentation": "The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
", "locationName": "protocol" }, "RuleAction": { "shape": "RuleAction", "documentation": "Indicates whether to allow or deny the traffic that matches the rule.
", "locationName": "ruleAction" }, "RuleNumber": { "shape": "Integer", "documentation": "The rule number of the entry to replace.
", "locationName": "ruleNumber" } } }, "ReplaceRootVolumeTask": { "type": "structure", "members": { "ReplaceRootVolumeTaskId": { "shape": "ReplaceRootVolumeTaskId", "documentation": "The ID of the root volume replacement task.
", "locationName": "replaceRootVolumeTaskId" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance for which the root volume replacement task was created.
", "locationName": "instanceId" }, "TaskState": { "shape": "ReplaceRootVolumeTaskState", "documentation": "The state of the task. The task can be in one of the following states:
pending - the replacement volume is being created.
in-progress - the original volume is being detached and the replacement volume is being attached.
succeeded - the replacement volume has been successfully attached to the instance and the instance is available.
failing - the replacement task is in the process of failing.
failed - the replacement task has failed but the original root volume is still attached.
failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.
failed-detached - the replacement task has failed and the instance has no root volume attached.
The time the task was started.
", "locationName": "startTime" }, "CompleteTime": { "shape": "String", "documentation": "The time the task completed.
", "locationName": "completeTime" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the task.
", "locationName": "tagSet" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI used to create the replacement root volume.
", "locationName": "imageId" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot used to create the replacement root volume.
", "locationName": "snapshotId" }, "DeleteReplacedRootVolume": { "shape": "Boolean", "documentation": "Indicates whether the original root volume is to be deleted after the root volume replacement task completes.
", "locationName": "deleteReplacedRootVolume" } }, "documentation": "Information about a root volume replacement task.
" }, "ReplaceRootVolumeTaskId": { "type": "string" }, "ReplaceRootVolumeTaskIds": { "type": "list", "member": { "shape": "ReplaceRootVolumeTaskId", "locationName": "ReplaceRootVolumeTaskId" } }, "ReplaceRootVolumeTaskState": { "type": "string", "enum": [ "pending", "in-progress", "failing", "succeeded", "failed", "failed-detached" ] }, "ReplaceRootVolumeTasks": { "type": "list", "member": { "shape": "ReplaceRootVolumeTask", "locationName": "item" } }, "ReplaceRouteRequest": { "type": "structure", "required": [ "RouteTableId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
", "locationName": "destinationCidrBlock" }, "DestinationIpv6CidrBlock": { "shape": "String", "documentation": "The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
", "locationName": "destinationIpv6CidrBlock" }, "DestinationPrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list for the route.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
" }, "EgressOnlyInternetGatewayId": { "shape": "EgressOnlyInternetGatewayId", "documentation": "[IPv6 traffic only] The ID of an egress-only internet gateway.
", "locationName": "egressOnlyInternetGatewayId" }, "GatewayId": { "shape": "RouteGatewayId", "documentation": "The ID of an internet gateway or virtual private gateway.
", "locationName": "gatewayId" }, "InstanceId": { "shape": "InstanceId", "documentation": "The ID of a NAT instance in your VPC.
", "locationName": "instanceId" }, "LocalTarget": { "shape": "Boolean", "documentation": "Specifies whether to reset the local route to its default target (local).
[IPv4 traffic only] The ID of a NAT gateway.
", "locationName": "natGatewayId" }, "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of a transit gateway.
" }, "LocalGatewayId": { "shape": "LocalGatewayId", "documentation": "The ID of the local gateway.
" }, "CarrierGatewayId": { "shape": "CarrierGatewayId", "documentation": "[IPv4 traffic only] The ID of a carrier gateway.
" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of a network interface.
", "locationName": "networkInterfaceId" }, "RouteTableId": { "shape": "RouteTableId", "documentation": "The ID of the route table.
", "locationName": "routeTableId" }, "VpcPeeringConnectionId": { "shape": "VpcPeeringConnectionId", "documentation": "The ID of a VPC peering connection.
", "locationName": "vpcPeeringConnectionId" }, "CoreNetworkArn": { "shape": "CoreNetworkArn", "documentation": "The Amazon Resource Name (ARN) of the core network.
" } } }, "ReplaceRouteTableAssociationRequest": { "type": "structure", "required": [ "AssociationId", "RouteTableId" ], "members": { "AssociationId": { "shape": "RouteTableAssociationId", "documentation": "The association ID.
", "locationName": "associationId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the new route table to associate with the subnet.
", "locationName": "routeTableId" } } }, "ReplaceRouteTableAssociationResult": { "type": "structure", "members": { "NewAssociationId": { "shape": "String", "documentation": "The ID of the new association.
", "locationName": "newAssociationId" }, "AssociationState": { "shape": "RouteTableAssociationState", "documentation": "The state of the association.
", "locationName": "associationState" } } }, "ReplaceTransitGatewayRouteRequest": { "type": "structure", "required": [ "DestinationCidrBlock", "TransitGatewayRouteTableId" ], "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR range used for the destination match. Routing decisions are based on the most specific match.
" }, "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the route table.
" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
" }, "Blackhole": { "shape": "Boolean", "documentation": "Indicates whether traffic matching this route is to be dropped.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the modified route.
", "locationName": "route" } } }, "ReplaceVpnTunnelRequest": { "type": "structure", "required": [ "VpnConnectionId", "VpnTunnelOutsideIpAddress" ], "members": { "VpnConnectionId": { "shape": "VpnConnectionId", "documentation": "The ID of the Site-to-Site VPN connection.
" }, "VpnTunnelOutsideIpAddress": { "shape": "String", "documentation": "The external IP address of the VPN tunnel.
" }, "ApplyPendingMaintenance": { "shape": "Boolean", "documentation": "Trigger pending tunnel endpoint maintenance.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Confirmation of replace tunnel operation.
", "locationName": "return" } } }, "ReplacementStrategy": { "type": "string", "enum": [ "launch", "launch-before-terminate" ] }, "ReportInstanceReasonCodes": { "type": "string", "enum": [ "instance-stuck-in-state", "unresponsive", "not-accepting-credentials", "password-not-available", "performance-network", "performance-instance-store", "performance-ebs-volume", "performance-other", "other" ] }, "ReportInstanceStatusRequest": { "type": "structure", "required": [ "Instances", "ReasonCodes", "Status" ], "members": { "Description": { "shape": "String", "documentation": "Descriptive text about the health state of your instance.
", "locationName": "description" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The time at which the reported instance health state ended.
", "locationName": "endTime" }, "Instances": { "shape": "InstanceIdStringList", "documentation": "The instances.
", "locationName": "instanceId" }, "ReasonCodes": { "shape": "ReasonCodesList", "documentation": "The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
The time at which the reported instance health state began.
", "locationName": "startTime" }, "Status": { "shape": "ReportStatusType", "documentation": "The status of all instances listed.
", "locationName": "status" } } }, "ReportStatusType": { "type": "string", "enum": [ "ok", "impaired" ] }, "RequestFilterPortRange": { "type": "structure", "members": { "FromPort": { "shape": "Port", "documentation": "The first port in the range.
" }, "ToPort": { "shape": "Port", "documentation": "The last port in the range.
" } }, "documentation": "Describes a port range.
" }, "RequestHostIdList": { "type": "list", "member": { "shape": "DedicatedHostId", "locationName": "item" } }, "RequestHostIdSet": { "type": "list", "member": { "shape": "DedicatedHostId", "locationName": "item" } }, "RequestInstanceTypeList": { "type": "list", "member": { "shape": "InstanceType" }, "locationName": "InstanceType", "max": 100, "min": 0 }, "RequestIpamResourceTag": { "type": "structure", "members": { "Key": { "shape": "String", "documentation": "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.
" }, "Value": { "shape": "String", "documentation": "The value for the tag.
" } }, "documentation": "A tag on an IPAM resource.
" }, "RequestIpamResourceTagList": { "type": "list", "member": { "shape": "RequestIpamResourceTag", "locationName": "item" } }, "RequestLaunchTemplateData": { "type": "structure", "members": { "KernelId": { "shape": "KernelId", "documentation": "The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
" }, "IamInstanceProfile": { "shape": "LaunchTemplateIamInstanceProfileSpecificationRequest", "documentation": "The name or Amazon Resource Name (ARN) of an IAM instance profile.
" }, "BlockDeviceMappings": { "shape": "LaunchTemplateBlockDeviceMappingRequestList", "documentation": "The block device mapping.
", "locationName": "BlockDeviceMapping" }, "NetworkInterfaces": { "shape": "LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList", "documentation": "The network interfaces for the instance.
", "locationName": "NetworkInterface" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
Valid formats:
ami-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameter
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.
" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
If you specify InstanceType, you can't specify InstanceRequirements.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The monitoring for the instance.
" }, "Placement": { "shape": "LaunchTemplatePlacementRequest", "documentation": "The placement for the instance.
" }, "RamDiskId": { "shape": "RamdiskId", "documentation": "The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
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.
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.
" }, "TagSpecifications": { "shape": "LaunchTemplateTagSpecificationRequestList", "documentation": "The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.
", "locationName": "TagSpecification" }, "ElasticGpuSpecifications": { "shape": "ElasticGpuSpecificationList", "documentation": "Deprecated.
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.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
The IDs of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", "locationName": "SecurityGroupId" }, "SecurityGroups": { "shape": "SecurityGroupStringList", "documentation": "The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", "locationName": "SecurityGroup" }, "InstanceMarketOptions": { "shape": "LaunchTemplateInstanceMarketOptionsRequest", "documentation": "The market (purchasing) option for the instances.
" }, "CreditSpecification": { "shape": "CreditSpecificationRequest", "documentation": "The credit option for CPU usage of the instance. Valid only for T instances.
" }, "CpuOptions": { "shape": "LaunchTemplateCpuOptionsRequest", "documentation": "The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.
" }, "CapacityReservationSpecification": { "shape": "LaunchTemplateCapacityReservationSpecificationRequest", "documentation": "The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
The license configurations.
", "locationName": "LicenseSpecification" }, "HibernationOptions": { "shape": "LaunchTemplateHibernationOptionsRequest", "documentation": "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.
" }, "MetadataOptions": { "shape": "LaunchTemplateInstanceMetadataOptionsRequest", "documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.
" }, "EnclaveOptions": { "shape": "LaunchTemplateEnclaveOptionsRequest", "documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more 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.
" }, "InstanceRequirements": { "shape": "InstanceRequirementsRequest", "documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can't specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
" }, "PrivateDnsNameOptions": { "shape": "LaunchTemplatePrivateDnsNameOptionsRequest", "documentation": "The options for the instance hostname. The default values are inherited from the subnet.
" }, "MaintenanceOptions": { "shape": "LaunchTemplateInstanceMaintenanceOptionsRequest", "documentation": "The maintenance options for the instance.
" }, "DisableApiStop": { "shape": "Boolean", "documentation": "Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.
" } }, "documentation": "The information to include in the launch template.
You must specify at least one parameter for the launch template data.
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.
The configuration for the Spot Fleet request.
", "locationName": "spotFleetRequestConfig" } }, "documentation": "Contains the parameters for RequestSpotFleet.
" }, "RequestSpotFleetResponse": { "type": "structure", "members": { "SpotFleetRequestId": { "shape": "String", "documentation": "The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" } }, "documentation": "Contains the output of RequestSpotFleet.
" }, "RequestSpotInstancesRequest": { "type": "structure", "members": { "AvailabilityZoneGroup": { "shape": "String", "documentation": "The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
", "locationName": "availabilityZoneGroup" }, "BlockDurationMinutes": { "shape": "Integer", "documentation": "Deprecated.
", "locationName": "blockDurationMinutes" }, "ClientToken": { "shape": "String", "documentation": "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.
", "locationName": "clientToken" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The maximum number of Spot Instances to launch.
Default: 1
", "locationName": "instanceCount" }, "LaunchGroup": { "shape": "String", "documentation": "The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
", "locationName": "launchGroup" }, "LaunchSpecification": { "shape": "RequestSpotLaunchSpecification", "documentation": "The launch specification.
" }, "SpotPrice": { "shape": "String", "documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
", "locationName": "validFrom" }, "ValidUntil": { "shape": "DateTime", "documentation": "The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.
The behavior when a Spot Instance is interrupted. The default is terminate.
Contains the parameters for RequestSpotInstances.
" }, "RequestSpotInstancesResult": { "type": "structure", "members": { "SpotInstanceRequests": { "shape": "SpotInstanceRequestList", "documentation": "The Spot Instance requests.
", "locationName": "spotInstanceRequestSet" } }, "documentation": "Contains the output of RequestSpotInstances.
" }, "RequestSpotLaunchSpecification": { "type": "structure", "members": { "SecurityGroupIds": { "shape": "RequestSpotLaunchSpecificationSecurityGroupIdList", "documentation": "The IDs of the security groups.
", "locationName": "SecurityGroupId" }, "SecurityGroups": { "shape": "RequestSpotLaunchSpecificationSecurityGroupList", "documentation": "Not supported.
", "locationName": "SecurityGroup" }, "AddressingType": { "shape": "String", "documentation": "Deprecated.
", "locationName": "addressingType" }, "BlockDeviceMappings": { "shape": "BlockDeviceMappingList", "documentation": "The block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
", "locationName": "blockDeviceMapping" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
The IAM instance profile.
", "locationName": "iamInstanceProfile" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI.
", "locationName": "imageId" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type. Only one instance type can be specified.
", "locationName": "instanceType" }, "KernelId": { "shape": "KernelId", "documentation": "The ID of the kernel.
", "locationName": "kernelId" }, "KeyName": { "shape": "KeyPairName", "documentation": "The name of the key pair.
", "locationName": "keyName" }, "Monitoring": { "shape": "RunInstancesMonitoringEnabled", "documentation": "Indicates whether basic or detailed monitoring is enabled for the instance.
Default: Disabled
", "locationName": "monitoring" }, "NetworkInterfaces": { "shape": "InstanceNetworkInterfaceSpecificationList", "documentation": "The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
", "locationName": "NetworkInterface" }, "Placement": { "shape": "SpotPlacement", "documentation": "The placement information for the instance.
", "locationName": "placement" }, "RamdiskId": { "shape": "RamdiskId", "documentation": "The ID of the RAM disk.
", "locationName": "ramdiskId" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet in which to launch the instance.
", "locationName": "subnetId" }, "UserData": { "shape": "SensitiveUserData", "documentation": "The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", "locationName": "userData" } }, "documentation": "Describes the launch specification for an instance.
" }, "RequestSpotLaunchSpecificationSecurityGroupIdList": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "item" } }, "RequestSpotLaunchSpecificationSecurityGroupList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "Reservation": { "type": "structure", "members": { "Groups": { "shape": "GroupIdentifierList", "documentation": "Not supported.
", "locationName": "groupSet" }, "Instances": { "shape": "InstanceList", "documentation": "The instances.
", "locationName": "instancesSet" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the reservation.
", "locationName": "ownerId" }, "RequesterId": { "shape": "String", "documentation": "The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).
", "locationName": "requesterId" }, "ReservationId": { "shape": "String", "documentation": "The ID of the reservation.
", "locationName": "reservationId" } }, "documentation": "Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.
" }, "ReservationFleetInstanceSpecification": { "type": "structure", "members": { "InstanceType": { "shape": "InstanceType", "documentation": "The instance type for which the Capacity Reservation Fleet reserves capacity.
" }, "InstancePlatform": { "shape": "CapacityReservationInstancePlatform", "documentation": "The type of operating system for which the Capacity Reservation Fleet reserves capacity.
" }, "Weight": { "shape": "DoubleWithConstraints", "documentation": "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.
" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
" }, "AvailabilityZoneId": { "shape": "String", "documentation": "The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using EBS-optimized instance types.
" }, "Priority": { "shape": "IntegerWithConstraints", "documentation": "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.
" } }, "documentation": "Information about an instance type to use in a Capacity Reservation Fleet.
" }, "ReservationFleetInstanceSpecificationList": { "type": "list", "member": { "shape": "ReservationFleetInstanceSpecification" } }, "ReservationId": { "type": "string" }, "ReservationList": { "type": "list", "member": { "shape": "Reservation", "locationName": "item" } }, "ReservationState": { "type": "string", "enum": [ "payment-pending", "payment-failed", "active", "retired" ] }, "ReservationValue": { "type": "structure", "members": { "HourlyPrice": { "shape": "String", "documentation": "The hourly rate of the reservation.
", "locationName": "hourlyPrice" }, "RemainingTotalValue": { "shape": "String", "documentation": "The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
", "locationName": "remainingTotalValue" }, "RemainingUpfrontValue": { "shape": "String", "documentation": "The remaining upfront cost of the reservation.
", "locationName": "remainingUpfrontValue" } }, "documentation": "The cost associated with the Reserved Instance.
" }, "ReservedInstanceIdSet": { "type": "list", "member": { "shape": "ReservationId", "locationName": "ReservedInstanceId" } }, "ReservedInstanceLimitPrice": { "type": "structure", "members": { "Amount": { "shape": "Double", "documentation": "Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
", "locationName": "amount" }, "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.
Describes the limit price of a Reserved Instance offering.
" }, "ReservedInstanceReservationValue": { "type": "structure", "members": { "ReservationValue": { "shape": "ReservationValue", "documentation": "The total value of the Convertible Reserved Instance that you are exchanging.
", "locationName": "reservationValue" }, "ReservedInstanceId": { "shape": "String", "documentation": "The ID of the Convertible Reserved Instance that you are exchanging.
", "locationName": "reservedInstanceId" } }, "documentation": "The total value of the Convertible Reserved Instance.
" }, "ReservedInstanceReservationValueSet": { "type": "list", "member": { "shape": "ReservedInstanceReservationValue", "locationName": "item" } }, "ReservedInstanceState": { "type": "string", "enum": [ "payment-pending", "active", "payment-failed", "retired", "queued", "queued-deleted" ] }, "ReservedInstances": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which the Reserved Instance can be used.
", "locationName": "availabilityZone" }, "Duration": { "shape": "Long", "documentation": "The duration of the Reserved Instance, in seconds.
", "locationName": "duration" }, "End": { "shape": "DateTime", "documentation": "The time when the Reserved Instance expires.
", "locationName": "end" }, "FixedPrice": { "shape": "Float", "documentation": "The purchase price of the Reserved Instance.
", "locationName": "fixedPrice" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of reservations purchased.
", "locationName": "instanceCount" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type on which the Reserved Instance can be used.
", "locationName": "instanceType" }, "ProductDescription": { "shape": "RIProductDescription", "documentation": "The Reserved Instance product platform description.
", "locationName": "productDescription" }, "ReservedInstancesId": { "shape": "String", "documentation": "The ID of the Reserved Instance.
", "locationName": "reservedInstancesId" }, "Start": { "shape": "DateTime", "documentation": "The date and time the Reserved Instance started.
", "locationName": "start" }, "State": { "shape": "ReservedInstanceState", "documentation": "The state of the Reserved Instance purchase.
", "locationName": "state" }, "UsagePrice": { "shape": "Float", "documentation": "The usage price of the Reserved Instance, per hour.
", "locationName": "usagePrice" }, "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
The tenancy of the instance.
", "locationName": "instanceTenancy" }, "OfferingClass": { "shape": "OfferingClassType", "documentation": "The offering class of the Reserved Instance.
", "locationName": "offeringClass" }, "OfferingType": { "shape": "OfferingTypeValues", "documentation": "The Reserved Instance offering type.
", "locationName": "offeringType" }, "RecurringCharges": { "shape": "RecurringChargesList", "documentation": "The recurring charge tag assigned to the resource.
", "locationName": "recurringCharges" }, "Scope": { "shape": "scope", "documentation": "The scope of the Reserved Instance.
", "locationName": "scope" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the resource.
", "locationName": "tagSet" } }, "documentation": "Describes a Reserved Instance.
" }, "ReservedInstancesConfiguration": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone for the modified Reserved Instances.
", "locationName": "availabilityZone" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of modified Reserved Instances.
This is a required field for a request.
The instance type for the modified Reserved Instances.
", "locationName": "instanceType" }, "Platform": { "shape": "String", "documentation": "The network platform of the modified Reserved Instances.
", "locationName": "platform" }, "Scope": { "shape": "scope", "documentation": "Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
", "locationName": "scope" } }, "documentation": "Describes the configuration settings for the modified Reserved Instances.
" }, "ReservedInstancesConfigurationList": { "type": "list", "member": { "shape": "ReservedInstancesConfiguration", "locationName": "item" } }, "ReservedInstancesId": { "type": "structure", "members": { "ReservedInstancesId": { "shape": "String", "documentation": "The ID of the Reserved Instance.
", "locationName": "reservedInstancesId" } }, "documentation": "Describes the ID of a Reserved Instance.
" }, "ReservedInstancesIdStringList": { "type": "list", "member": { "shape": "ReservationId", "locationName": "ReservedInstancesId" } }, "ReservedInstancesList": { "type": "list", "member": { "shape": "ReservedInstances", "locationName": "item" } }, "ReservedInstancesListing": { "type": "structure", "members": { "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
", "locationName": "clientToken" }, "CreateDate": { "shape": "DateTime", "documentation": "The time the listing was created.
", "locationName": "createDate" }, "InstanceCounts": { "shape": "InstanceCountList", "documentation": "The number of instances in this state.
", "locationName": "instanceCounts" }, "PriceSchedules": { "shape": "PriceScheduleList", "documentation": "The price of the Reserved Instance listing.
", "locationName": "priceSchedules" }, "ReservedInstancesId": { "shape": "String", "documentation": "The ID of the Reserved Instance.
", "locationName": "reservedInstancesId" }, "ReservedInstancesListingId": { "shape": "String", "documentation": "The ID of the Reserved Instance listing.
", "locationName": "reservedInstancesListingId" }, "Status": { "shape": "ListingStatus", "documentation": "The status of the Reserved Instance listing.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "The reason for the current status of the Reserved Instance listing. The response can be blank.
", "locationName": "statusMessage" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the resource.
", "locationName": "tagSet" }, "UpdateDate": { "shape": "DateTime", "documentation": "The last modified timestamp of the listing.
", "locationName": "updateDate" } }, "documentation": "Describes a Reserved Instance listing.
" }, "ReservedInstancesListingId": { "type": "string" }, "ReservedInstancesListingList": { "type": "list", "member": { "shape": "ReservedInstancesListing", "locationName": "item" } }, "ReservedInstancesModification": { "type": "structure", "members": { "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
", "locationName": "clientToken" }, "CreateDate": { "shape": "DateTime", "documentation": "The time when the modification request was created.
", "locationName": "createDate" }, "EffectiveDate": { "shape": "DateTime", "documentation": "The time for the modification to become effective.
", "locationName": "effectiveDate" }, "ModificationResults": { "shape": "ReservedInstancesModificationResultList", "documentation": "Contains target configurations along with their corresponding new Reserved Instance IDs.
", "locationName": "modificationResultSet" }, "ReservedInstancesIds": { "shape": "ReservedIntancesIds", "documentation": "The IDs of one or more Reserved Instances.
", "locationName": "reservedInstancesSet" }, "ReservedInstancesModificationId": { "shape": "String", "documentation": "A unique ID for the Reserved Instance modification.
", "locationName": "reservedInstancesModificationId" }, "Status": { "shape": "String", "documentation": "The status of the Reserved Instances modification request.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "The reason for the status.
", "locationName": "statusMessage" }, "UpdateDate": { "shape": "DateTime", "documentation": "The time when the modification request was last updated.
", "locationName": "updateDate" } }, "documentation": "Describes a Reserved Instance modification.
" }, "ReservedInstancesModificationId": { "type": "string" }, "ReservedInstancesModificationIdStringList": { "type": "list", "member": { "shape": "ReservedInstancesModificationId", "locationName": "ReservedInstancesModificationId" } }, "ReservedInstancesModificationList": { "type": "list", "member": { "shape": "ReservedInstancesModification", "locationName": "item" } }, "ReservedInstancesModificationResult": { "type": "structure", "members": { "ReservedInstancesId": { "shape": "String", "documentation": "The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
", "locationName": "reservedInstancesId" }, "TargetConfiguration": { "shape": "ReservedInstancesConfiguration", "documentation": "The target Reserved Instances configurations supplied as part of the modification request.
", "locationName": "targetConfiguration" } }, "documentation": "Describes the modification request/s.
" }, "ReservedInstancesModificationResultList": { "type": "list", "member": { "shape": "ReservedInstancesModificationResult", "locationName": "item" } }, "ReservedInstancesOffering": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which the Reserved Instance can be used.
", "locationName": "availabilityZone" }, "Duration": { "shape": "Long", "documentation": "The duration of the Reserved Instance, in seconds.
", "locationName": "duration" }, "FixedPrice": { "shape": "Float", "documentation": "The purchase price of the Reserved Instance.
", "locationName": "fixedPrice" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type on which the Reserved Instance can be used.
", "locationName": "instanceType" }, "ProductDescription": { "shape": "RIProductDescription", "documentation": "The Reserved Instance product platform description.
", "locationName": "productDescription" }, "ReservedInstancesOfferingId": { "shape": "String", "documentation": "The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
", "locationName": "reservedInstancesOfferingId" }, "UsagePrice": { "shape": "Float", "documentation": "The usage price of the Reserved Instance, per hour.
", "locationName": "usagePrice" }, "CurrencyCode": { "shape": "CurrencyCodeValues", "documentation": "The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
The tenancy of the instance.
", "locationName": "instanceTenancy" }, "Marketplace": { "shape": "Boolean", "documentation": "Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is true.
If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.
The Reserved Instance offering type.
", "locationName": "offeringType" }, "PricingDetails": { "shape": "PricingDetailsList", "documentation": "The pricing details of the Reserved Instance offering.
", "locationName": "pricingDetailsSet" }, "RecurringCharges": { "shape": "RecurringChargesList", "documentation": "The recurring charge tag assigned to the resource.
", "locationName": "recurringCharges" }, "Scope": { "shape": "scope", "documentation": "Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
", "locationName": "scope" } }, "documentation": "Describes a Reserved Instance offering.
" }, "ReservedInstancesOfferingId": { "type": "string" }, "ReservedInstancesOfferingIdStringList": { "type": "list", "member": { "shape": "ReservedInstancesOfferingId" } }, "ReservedInstancesOfferingList": { "type": "list", "member": { "shape": "ReservedInstancesOffering", "locationName": "item" } }, "ReservedIntancesIds": { "type": "list", "member": { "shape": "ReservedInstancesId", "locationName": "item" } }, "ResetAddressAttributeRequest": { "type": "structure", "required": [ "AllocationId", "Attribute" ], "members": { "AllocationId": { "shape": "AllocationId", "documentation": "[EC2-VPC] The allocation ID.
" }, "Attribute": { "shape": "AddressAttributeName", "documentation": "The attribute of the IP address.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the IP address.
", "locationName": "address" } } }, "ResetEbsDefaultKmsKeyIdRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.
", "locationName": "kmsKeyId" } } }, "ResetFpgaImageAttributeName": { "type": "string", "enum": [ "loadPermission" ] }, "ResetFpgaImageAttributeRequest": { "type": "structure", "required": [ "FpgaImageId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the AFI.
" }, "Attribute": { "shape": "ResetFpgaImageAttributeName", "documentation": "The attribute.
" } } }, "ResetFpgaImageAttributeResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Is true if the request succeeds, and an error otherwise.
The attribute to reset (currently you can only reset the launch permission attribute).
" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Contains the parameters for ResetImageAttribute.
" }, "ResetInstanceAttributeRequest": { "type": "structure", "required": [ "Attribute", "InstanceId" ], "members": { "Attribute": { "shape": "InstanceAttributeName", "documentation": "The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
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.
The ID of the instance.
", "locationName": "instanceId" } } }, "ResetNetworkInterfaceAttributeRequest": { "type": "structure", "required": [ "NetworkInterfaceId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the network interface.
", "locationName": "networkInterfaceId" }, "SourceDestCheck": { "shape": "String", "documentation": "The source/destination checking attribute. Resets the value to true.
Contains the parameters for ResetNetworkInterfaceAttribute.
" }, "ResetSnapshotAttributeRequest": { "type": "structure", "required": [ "Attribute", "SnapshotId" ], "members": { "Attribute": { "shape": "SnapshotAttributeName", "documentation": "The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.
" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The resources.
", "locationName": "resourceSet" }, "ResourceTypes": { "shape": "ValueStringList", "documentation": "The resource types.
", "locationName": "resourceTypeSet" } }, "documentation": "Describes a resource statement.
" }, "ResourceStatementRequest": { "type": "structure", "members": { "Resources": { "shape": "ValueStringList", "documentation": "The resources.
", "locationName": "Resource" }, "ResourceTypes": { "shape": "ValueStringList", "documentation": "The resource types.
", "locationName": "ResourceType" } }, "documentation": "Describes a resource statement.
" }, "ResourceType": { "type": "string", "enum": [ "capacity-reservation", "client-vpn-endpoint", "customer-gateway", "carrier-gateway", "coip-pool", "dedicated-host", "dhcp-options", "egress-only-internet-gateway", "elastic-ip", "elastic-gpu", "export-image-task", "export-instance-task", "fleet", "fpga-image", "host-reservation", "image", "import-image-task", "import-snapshot-task", "instance", "instance-event-window", "internet-gateway", "ipam", "ipam-pool", "ipam-scope", "ipv4pool-ec2", "ipv6pool-ec2", "key-pair", "launch-template", "local-gateway", "local-gateway-route-table", "local-gateway-virtual-interface", "local-gateway-virtual-interface-group", "local-gateway-route-table-vpc-association", "local-gateway-route-table-virtual-interface-group-association", "natgateway", "network-acl", "network-interface", "network-insights-analysis", "network-insights-path", "network-insights-access-scope", "network-insights-access-scope-analysis", "placement-group", "prefix-list", "replace-root-volume-task", "reserved-instances", "route-table", "security-group", "security-group-rule", "snapshot", "spot-fleet-request", "spot-instances-request", "subnet", "subnet-cidr-reservation", "traffic-mirror-filter", "traffic-mirror-session", "traffic-mirror-target", "transit-gateway", "transit-gateway-attachment", "transit-gateway-connect-peer", "transit-gateway-multicast-domain", "transit-gateway-policy-table", "transit-gateway-route-table", "transit-gateway-route-table-announcement", "volume", "vpc", "vpc-endpoint", "vpc-endpoint-connection", "vpc-endpoint-service", "vpc-endpoint-service-permission", "vpc-peering-connection", "vpn-connection", "vpn-gateway", "vpc-flow-log", "capacity-reservation-fleet", "traffic-mirror-filter-rule", "vpc-endpoint-connection-device-type", "verified-access-instance", "verified-access-group", "verified-access-endpoint", "verified-access-policy", "verified-access-trust-provider", "vpn-connection-device-type", "vpc-block-public-access-exclusion", "ipam-resource-discovery", "ipam-resource-discovery-association", "instance-connect-endpoint" ] }, "ResponseError": { "type": "structure", "members": { "Code": { "shape": "LaunchTemplateErrorCode", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The error message, if applicable.
", "locationName": "message" } }, "documentation": "Describes the error that's returned when you cannot delete a launch template version.
" }, "ResponseHostIdList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "ResponseHostIdSet": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "ResponseLaunchTemplateData": { "type": "structure", "members": { "KernelId": { "shape": "String", "documentation": "The ID of the kernel, if applicable.
", "locationName": "kernelId" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the instance is optimized for Amazon EBS I/O.
", "locationName": "ebsOptimized" }, "IamInstanceProfile": { "shape": "LaunchTemplateIamInstanceProfileSpecification", "documentation": "The IAM instance profile.
", "locationName": "iamInstanceProfile" }, "BlockDeviceMappings": { "shape": "LaunchTemplateBlockDeviceMappingList", "documentation": "The block device mappings.
", "locationName": "blockDeviceMappingSet" }, "NetworkInterfaces": { "shape": "LaunchTemplateInstanceNetworkInterfaceSpecificationList", "documentation": "The network interfaces.
", "locationName": "networkInterfaceSet" }, "ImageId": { "shape": "String", "documentation": "The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch.
The value depends on what you specified in the request. The possible values are:
If an AMI ID was specified in the request, then this is the AMI ID.
If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as true, then this is 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 as false, then this is the parameter value.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
", "locationName": "imageId" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
", "locationName": "instanceType" }, "KeyName": { "shape": "String", "documentation": "The name of the key pair.
", "locationName": "keyName" }, "Monitoring": { "shape": "LaunchTemplatesMonitoring", "documentation": "The monitoring for the instance.
", "locationName": "monitoring" }, "Placement": { "shape": "LaunchTemplatePlacement", "documentation": "The placement of the instance.
", "locationName": "placement" }, "RamDiskId": { "shape": "String", "documentation": "The ID of the RAM disk, if applicable.
", "locationName": "ramDiskId" }, "DisableApiTermination": { "shape": "Boolean", "documentation": "If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", "locationName": "instanceInitiatedShutdownBehavior" }, "UserData": { "shape": "SensitiveUserData", "documentation": "The user data for the instance.
", "locationName": "userData" }, "TagSpecifications": { "shape": "LaunchTemplateTagSpecificationList", "documentation": "The tags that are applied to the resources that are created during instance launch.
", "locationName": "tagSpecificationSet" }, "ElasticGpuSpecifications": { "shape": "ElasticGpuSpecificationResponseList", "documentation": "Deprecated.
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.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
The security group IDs.
", "locationName": "securityGroupIdSet" }, "SecurityGroups": { "shape": "ValueStringList", "documentation": "The security group names.
", "locationName": "securityGroupSet" }, "InstanceMarketOptions": { "shape": "LaunchTemplateInstanceMarketOptions", "documentation": "The market (purchasing) option for the instances.
", "locationName": "instanceMarketOptions" }, "CreditSpecification": { "shape": "CreditSpecification", "documentation": "The credit option for CPU usage of the instance.
", "locationName": "creditSpecification" }, "CpuOptions": { "shape": "LaunchTemplateCpuOptions", "documentation": "The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.
", "locationName": "cpuOptions" }, "CapacityReservationSpecification": { "shape": "LaunchTemplateCapacityReservationSpecificationResponse", "documentation": "Information about the Capacity Reservation targeting option.
", "locationName": "capacityReservationSpecification" }, "LicenseSpecifications": { "shape": "LaunchTemplateLicenseList", "documentation": "The license configurations.
", "locationName": "licenseSet" }, "HibernationOptions": { "shape": "LaunchTemplateHibernationOptions", "documentation": "Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
", "locationName": "hibernationOptions" }, "MetadataOptions": { "shape": "LaunchTemplateInstanceMetadataOptions", "documentation": "The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.
", "locationName": "metadataOptions" }, "EnclaveOptions": { "shape": "LaunchTemplateEnclaveOptions", "documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
", "locationName": "enclaveOptions" }, "InstanceRequirements": { "shape": "InstanceRequirements", "documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
If you specify InstanceRequirements, you can't specify InstanceTypes.
The options for the instance hostname.
", "locationName": "privateDnsNameOptions" }, "MaintenanceOptions": { "shape": "LaunchTemplateInstanceMaintenanceOptions", "documentation": "The maintenance options for your instance.
", "locationName": "maintenanceOptions" }, "DisableApiStop": { "shape": "Boolean", "documentation": "Indicates whether the instance is enabled for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.
", "locationName": "disableApiStop" } }, "documentation": "The information for a launch template.
" }, "RestorableByStringList": { "type": "list", "member": { "shape": "String" } }, "RestoreAddressToClassicRequest": { "type": "structure", "required": [ "PublicIp" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The Elastic IP address.
", "locationName": "publicIp" } } }, "RestoreAddressToClassicResult": { "type": "structure", "members": { "PublicIp": { "shape": "String", "documentation": "The Elastic IP address.
", "locationName": "publicIp" }, "Status": { "shape": "Status", "documentation": "The move status for the IP address.
", "locationName": "status" } } }, "RestoreImageFromRecycleBinRequest": { "type": "structure", "required": [ "ImageId" ], "members": { "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI to restore.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Returns true if the request succeeds; otherwise, it returns an error.
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.
The ID of the prefix list.
" }, "PreviousVersion": { "shape": "Long", "documentation": "The version to restore.
" }, "CurrentVersion": { "shape": "Long", "documentation": "The current version number for the prefix list.
" } } }, "RestoreManagedPrefixListVersionResult": { "type": "structure", "members": { "PrefixList": { "shape": "ManagedPrefixList", "documentation": "Information about the prefix list.
", "locationName": "prefixList" } } }, "RestoreSnapshotFromRecycleBinRequest": { "type": "structure", "required": [ "SnapshotId" ], "members": { "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot to restore.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the snapshot.
", "locationName": "snapshotId" }, "OutpostArn": { "shape": "String", "documentation": "The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
", "locationName": "outpostArn" }, "Description": { "shape": "String", "documentation": "The description for the snapshot.
", "locationName": "description" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the snapshot is encrypted.
", "locationName": "encrypted" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the EBS snapshot.
", "locationName": "ownerId" }, "Progress": { "shape": "String", "documentation": "The progress of the snapshot, as a percentage.
", "locationName": "progress" }, "StartTime": { "shape": "MillisecondDateTime", "documentation": "The time stamp when the snapshot was initiated.
", "locationName": "startTime" }, "State": { "shape": "SnapshotState", "documentation": "The state of the snapshot.
", "locationName": "status" }, "VolumeId": { "shape": "String", "documentation": "The ID of the volume that was used to create the snapshot.
", "locationName": "volumeId" }, "VolumeSize": { "shape": "Integer", "documentation": "The size of the volume, in GiB.
", "locationName": "volumeSize" }, "SseType": { "shape": "SSEType", "documentation": "Reserved for future use.
", "locationName": "sseType" } } }, "RestoreSnapshotTierRequest": { "type": "structure", "required": [ "SnapshotId" ], "members": { "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot to restore.
" }, "TemporaryRestoreDays": { "shape": "RestoreSnapshotTierRequestTemporaryRestoreDays", "documentation": "Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.
Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
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.
The ID of the snapshot.
", "locationName": "snapshotId" }, "RestoreStartTime": { "shape": "MillisecondDateTime", "documentation": "The date and time when the snapshot restore process started.
", "locationName": "restoreStartTime" }, "RestoreDuration": { "shape": "Integer", "documentation": "For temporary restores only. The number of days for which the archived snapshot is temporarily restored.
", "locationName": "restoreDuration" }, "IsPermanentRestore": { "shape": "Boolean", "documentation": "Indicates whether the snapshot is permanently restored. true indicates a permanent restore. false indicates a temporary restore.
The ID of the Client VPN endpoint with which the authorization rule is associated.
" }, "TargetNetworkCidr": { "shape": "String", "documentation": "The IPv4 address range, in CIDR notation, of the network for which access is being removed.
" }, "AccessGroupId": { "shape": "String", "documentation": "The ID of the Active Directory group for which to revoke access.
" }, "RevokeAllGroups": { "shape": "Boolean", "documentation": "Indicates whether access should be revoked for all clients.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The current state of the authorization rule.
", "locationName": "status" } } }, "RevokeSecurityGroupEgressRequest": { "type": "structure", "required": [ "GroupId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the security group.
", "locationName": "groupId" }, "IpPermissions": { "shape": "IpPermissionList", "documentation": "The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
", "locationName": "ipPermissions" }, "SecurityGroupRuleIds": { "shape": "SecurityGroupRuleIdList", "documentation": "The IDs of the security group rules.
", "locationName": "SecurityGroupRuleId" }, "CidrIp": { "shape": "String", "documentation": "Not supported. Use a set of IP permissions to specify the CIDR.
", "locationName": "cidrIp" }, "FromPort": { "shape": "Integer", "documentation": "Not supported. Use a set of IP permissions to specify the port.
", "locationName": "fromPort" }, "IpProtocol": { "shape": "String", "documentation": "Not supported. Use a set of IP permissions to specify the protocol name or number.
", "locationName": "ipProtocol" }, "ToPort": { "shape": "Integer", "documentation": "Not supported. Use a set of IP permissions to specify the port.
", "locationName": "toPort" }, "SourceSecurityGroupName": { "shape": "String", "documentation": "Not supported. Use a set of IP permissions to specify a destination security group.
", "locationName": "sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId": { "shape": "String", "documentation": "Not supported. Use a set of IP permissions to specify a destination security group.
", "locationName": "sourceSecurityGroupOwnerId" } } }, "RevokeSecurityGroupEgressResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, returns an error.
The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
" }, "FromPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
" }, "GroupId": { "shape": "SecurityGroupId", "documentation": "The ID of the security group.
" }, "GroupName": { "shape": "SecurityGroupName", "documentation": "[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
" }, "IpPermissions": { "shape": "IpPermissionList", "documentation": "The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
" }, "IpProtocol": { "shape": "String", "documentation": "The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
[Default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. The source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
" }, "SourceSecurityGroupOwnerId": { "shape": "String", "documentation": "Not supported.
" }, "ToPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes).
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The IDs of the security group rules.
", "locationName": "SecurityGroupRuleId" } } }, "RevokeSecurityGroupIngressResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, returns an error.
The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.
The IPv4 CIDR block used for the destination match.
", "locationName": "destinationCidrBlock" }, "DestinationIpv6CidrBlock": { "shape": "String", "documentation": "The IPv6 CIDR block used for the destination match.
", "locationName": "destinationIpv6CidrBlock" }, "DestinationPrefixListId": { "shape": "String", "documentation": "The prefix of the Amazon Web Service.
", "locationName": "destinationPrefixListId" }, "EgressOnlyInternetGatewayId": { "shape": "String", "documentation": "The ID of the egress-only internet gateway.
", "locationName": "egressOnlyInternetGatewayId" }, "GatewayId": { "shape": "String", "documentation": "The ID of a gateway attached to your VPC.
", "locationName": "gatewayId" }, "InstanceId": { "shape": "String", "documentation": "The ID of a NAT instance in your VPC.
", "locationName": "instanceId" }, "InstanceOwnerId": { "shape": "String", "documentation": "The ID of Amazon Web Services account that owns the instance.
", "locationName": "instanceOwnerId" }, "NatGatewayId": { "shape": "String", "documentation": "The ID of a NAT gateway.
", "locationName": "natGatewayId" }, "TransitGatewayId": { "shape": "String", "documentation": "The ID of a transit gateway.
", "locationName": "transitGatewayId" }, "LocalGatewayId": { "shape": "String", "documentation": "The ID of the local gateway.
", "locationName": "localGatewayId" }, "CarrierGatewayId": { "shape": "CarrierGatewayId", "documentation": "The ID of the carrier gateway.
", "locationName": "carrierGatewayId" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "Origin": { "shape": "RouteOrigin", "documentation": "Describes how the route was created.
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
The ID of a VPC peering connection.
", "locationName": "vpcPeeringConnectionId" }, "CoreNetworkArn": { "shape": "CoreNetworkArn", "documentation": "The Amazon Resource Name (ARN) of the core network.
", "locationName": "coreNetworkArn" } }, "documentation": "Describes a route in a route table.
" }, "RouteGatewayId": { "type": "string" }, "RouteList": { "type": "list", "member": { "shape": "Route", "locationName": "item" } }, "RouteOrigin": { "type": "string", "enum": [ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState": { "type": "string", "enum": [ "active", "blackhole" ] }, "RouteTable": { "type": "structure", "members": { "Associations": { "shape": "RouteTableAssociationList", "documentation": "The associations between the route table and one or more subnets or a gateway.
", "locationName": "associationSet" }, "PropagatingVgws": { "shape": "PropagatingVgwList", "documentation": "Any virtual private gateway (VGW) propagating routes.
", "locationName": "propagatingVgwSet" }, "RouteTableId": { "shape": "String", "documentation": "The ID of the route table.
", "locationName": "routeTableId" }, "Routes": { "shape": "RouteList", "documentation": "The routes in the route table.
", "locationName": "routeSet" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the route table.
", "locationName": "tagSet" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the route table.
", "locationName": "ownerId" } }, "documentation": "Describes a route table.
" }, "RouteTableAssociation": { "type": "structure", "members": { "Main": { "shape": "Boolean", "documentation": "Indicates whether this is the main route table.
", "locationName": "main" }, "RouteTableAssociationId": { "shape": "String", "documentation": "The ID of the association.
", "locationName": "routeTableAssociationId" }, "RouteTableId": { "shape": "String", "documentation": "The ID of the route table.
", "locationName": "routeTableId" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet. A subnet ID is not returned for an implicit association.
", "locationName": "subnetId" }, "GatewayId": { "shape": "String", "documentation": "The ID of the internet gateway or virtual private gateway.
", "locationName": "gatewayId" }, "AssociationState": { "shape": "RouteTableAssociationState", "documentation": "The state of the association.
", "locationName": "associationState" } }, "documentation": "Describes an association between a route table and a subnet or gateway.
" }, "RouteTableAssociationId": { "type": "string" }, "RouteTableAssociationList": { "type": "list", "member": { "shape": "RouteTableAssociation", "locationName": "item" } }, "RouteTableAssociationState": { "type": "structure", "members": { "State": { "shape": "RouteTableAssociationStateCode", "documentation": "The state of the association.
", "locationName": "state" }, "StatusMessage": { "shape": "String", "documentation": "The status message, if applicable.
", "locationName": "statusMessage" } }, "documentation": "Describes the state of an association between a route table and a subnet or gateway.
" }, "RouteTableAssociationStateCode": { "type": "string", "enum": [ "associating", "associated", "disassociating", "disassociated", "failed" ] }, "RouteTableId": { "type": "string" }, "RouteTableIdStringList": { "type": "list", "member": { "shape": "RouteTableId", "locationName": "item" } }, "RouteTableList": { "type": "list", "member": { "shape": "RouteTable", "locationName": "item" } }, "RuleAction": { "type": "string", "enum": [ "allow", "deny" ] }, "RuleGroupRuleOptionsPair": { "type": "structure", "members": { "RuleGroupArn": { "shape": "ResourceArn", "documentation": "The ARN of the rule group.
", "locationName": "ruleGroupArn" }, "RuleOptions": { "shape": "RuleOptionList", "documentation": "The rule options.
", "locationName": "ruleOptionSet" } }, "documentation": "Describes the rule options for a stateful rule group.
" }, "RuleGroupRuleOptionsPairList": { "type": "list", "member": { "shape": "RuleGroupRuleOptionsPair", "locationName": "item" } }, "RuleGroupTypePair": { "type": "structure", "members": { "RuleGroupArn": { "shape": "ResourceArn", "documentation": "The ARN of the rule group.
", "locationName": "ruleGroupArn" }, "RuleGroupType": { "shape": "String", "documentation": "The rule group type. The possible values are Domain List and Suricata.
Describes the type of a stateful rule group.
" }, "RuleGroupTypePairList": { "type": "list", "member": { "shape": "RuleGroupTypePair", "locationName": "item" } }, "RuleOption": { "type": "structure", "members": { "Keyword": { "shape": "String", "documentation": "The Suricata keyword.
", "locationName": "keyword" }, "Settings": { "shape": "StringList", "documentation": "The settings for the keyword.
", "locationName": "settingSet" } }, "documentation": "Describes additional settings for a stateful rule.
" }, "RuleOptionList": { "type": "list", "member": { "shape": "RuleOption", "locationName": "item" } }, "RunInstancesMonitoringEnabled": { "type": "structure", "required": [ "Enabled" ], "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
", "locationName": "enabled" } }, "documentation": "Describes the monitoring of an instance.
" }, "RunInstancesRequest": { "type": "structure", "required": [ "MaxCount", "MinCount" ], "members": { "BlockDeviceMappings": { "shape": "BlockDeviceMappingRequestList", "documentation": "The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.
", "locationName": "BlockDeviceMapping" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
" }, "Ipv6AddressCount": { "shape": "Integer", "documentation": "The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
" }, "Ipv6Addresses": { "shape": "InstanceIpv6AddressList", "documentation": "The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
", "locationName": "Ipv6Address" }, "KernelId": { "shape": "KernelId", "documentation": "The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
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.
" }, "MinCount": { "shape": "Integer", "documentation": "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.
" }, "Monitoring": { "shape": "RunInstancesMonitoringEnabled", "documentation": "Specifies whether detailed monitoring is enabled for the instance.
" }, "Placement": { "shape": "Placement", "documentation": "The placement for the instance.
" }, "RamdiskId": { "shape": "RamdiskId", "documentation": "The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", "locationName": "SecurityGroupId" }, "SecurityGroups": { "shape": "SecurityGroupStringList", "documentation": "[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
Default: Amazon EC2 uses the default security group.
", "locationName": "SecurityGroup" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
" }, "UserData": { "shape": "RunInstancesUserData", "documentation": "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.
" }, "AdditionalInfo": { "shape": "String", "documentation": "Reserved.
", "locationName": "additionalInfo" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
", "idempotencyToken": true, "locationName": "clientToken" }, "DisableApiTermination": { "shape": "Boolean", "documentation": "If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
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.
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The name or Amazon Resource Name (ARN) of an IAM instance profile.
", "locationName": "iamInstanceProfile" }, "InstanceInitiatedShutdownBehavior": { "shape": "ShutdownBehavior", "documentation": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The network interfaces to associate with the instance.
", "locationName": "networkInterface" }, "PrivateIpAddress": { "shape": "String", "documentation": "The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
", "locationName": "privateIpAddress" }, "ElasticGpuSpecification": { "shape": "ElasticGpuSpecifications", "documentation": "An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see Amazon Elastic Inference FAQs.
The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see CreateTags.
", "locationName": "TagSpecification" }, "LaunchTemplate": { "shape": "LaunchTemplateSpecification", "documentation": "The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.
" }, "InstanceMarketOptions": { "shape": "InstanceMarketOptionsRequest", "documentation": "The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)
For T3 instances with host tenancy, only standard is supported.
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
" }, "CapacityReservationSpecification": { "shape": "CapacityReservationSpecification", "documentation": "Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
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.
You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
" }, "LicenseSpecifications": { "shape": "LicenseSpecificationListRequest", "documentation": "The license configurations.
", "locationName": "LicenseSpecification" }, "MetadataOptions": { "shape": "InstanceMetadataOptionsRequest", "documentation": "The metadata options for the instance. For more information, see Instance metadata and user data.
" }, "EnclaveOptions": { "shape": "EnclaveOptionsRequest", "documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more 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.
" }, "PrivateDnsNameOptions": { "shape": "PrivateDnsNameOptionsRequest", "documentation": "The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.
" }, "MaintenanceOptions": { "shape": "InstanceMaintenanceOptionsRequest", "documentation": "The maintenance and recovery options for the instance.
" }, "DisableApiStop": { "shape": "Boolean", "documentation": "Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.
" }, "EnablePrimaryIpv6": { "shape": "Boolean", "documentation": "If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
" } } }, "RunInstancesUserData": { "type": "string", "sensitive": true }, "RunScheduledInstancesRequest": { "type": "structure", "required": [ "LaunchSpecification", "ScheduledInstanceId" ], "members": { "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
", "idempotencyToken": true }, "DryRun": { "shape": "Boolean", "documentation": "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.
The number of instances.
Default: 1
" }, "LaunchSpecification": { "shape": "ScheduledInstancesLaunchSpecification", "documentation": "The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.
" }, "ScheduledInstanceId": { "shape": "ScheduledInstanceId", "documentation": "The Scheduled Instance ID.
" } }, "documentation": "Contains the parameters for RunScheduledInstances.
" }, "RunScheduledInstancesResult": { "type": "structure", "members": { "InstanceIdSet": { "shape": "InstanceIdSet", "documentation": "The IDs of the newly launched instances.
", "locationName": "instanceIdSet" } }, "documentation": "Contains the output of RunScheduledInstances.
" }, "S3ObjectTag": { "type": "structure", "members": { "Key": { "shape": "String", "documentation": "The key of the tag.
Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in length. May not begin with aws:.
The value of the tag.
Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in length.
" } }, "documentation": "The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more information, see Categorizing your storage using tags in the Amazon Simple Storage Service User Guide.
" }, "S3ObjectTagList": { "type": "list", "member": { "shape": "S3ObjectTag", "locationName": "item" } }, "S3Storage": { "type": "structure", "members": { "AWSAccessKeyId": { "shape": "String", "documentation": "The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Amazon Web Services accounts in the Account ManagementReference Guide.
" }, "Bucket": { "shape": "String", "documentation": "The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
", "locationName": "bucket" }, "Prefix": { "shape": "String", "documentation": "The beginning of the file name of the AMI.
", "locationName": "prefix" }, "UploadPolicy": { "shape": "Blob", "documentation": "An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
", "locationName": "uploadPolicy" }, "UploadPolicySignature": { "shape": "S3StorageUploadPolicySignature", "documentation": "The signature of the JSON document.
", "locationName": "uploadPolicySignature" } }, "documentation": "Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.
" }, "S3StorageUploadPolicySignature": { "type": "string", "sensitive": true }, "SSEType": { "type": "string", "enum": [ "sse-ebs", "sse-kms", "none" ] }, "ScheduledInstance": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "CreateDate": { "shape": "DateTime", "documentation": "The date when the Scheduled Instance was purchased.
", "locationName": "createDate" }, "HourlyPrice": { "shape": "String", "documentation": "The hourly price for a single instance.
", "locationName": "hourlyPrice" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of instances.
", "locationName": "instanceCount" }, "InstanceType": { "shape": "String", "documentation": "The instance type.
", "locationName": "instanceType" }, "NetworkPlatform": { "shape": "String", "documentation": "The network platform.
", "locationName": "networkPlatform" }, "NextSlotStartTime": { "shape": "DateTime", "documentation": "The time for the next schedule to start.
", "locationName": "nextSlotStartTime" }, "Platform": { "shape": "String", "documentation": "The platform (Linux/UNIX or Windows).
The time that the previous schedule ended or will end.
", "locationName": "previousSlotEndTime" }, "Recurrence": { "shape": "ScheduledInstanceRecurrence", "documentation": "The schedule recurrence.
", "locationName": "recurrence" }, "ScheduledInstanceId": { "shape": "String", "documentation": "The Scheduled Instance ID.
", "locationName": "scheduledInstanceId" }, "SlotDurationInHours": { "shape": "Integer", "documentation": "The number of hours in the schedule.
", "locationName": "slotDurationInHours" }, "TermEndDate": { "shape": "DateTime", "documentation": "The end date for the Scheduled Instance.
", "locationName": "termEndDate" }, "TermStartDate": { "shape": "DateTime", "documentation": "The start date for the Scheduled Instance.
", "locationName": "termStartDate" }, "TotalScheduledInstanceHours": { "shape": "Integer", "documentation": "The total number of hours for a single instance for the entire term.
", "locationName": "totalScheduledInstanceHours" } }, "documentation": "Describes a Scheduled Instance.
" }, "ScheduledInstanceAvailability": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZone" }, "AvailableInstanceCount": { "shape": "Integer", "documentation": "The number of available instances.
", "locationName": "availableInstanceCount" }, "FirstSlotStartTime": { "shape": "DateTime", "documentation": "The time period for the first schedule to start.
", "locationName": "firstSlotStartTime" }, "HourlyPrice": { "shape": "String", "documentation": "The hourly price for a single instance.
", "locationName": "hourlyPrice" }, "InstanceType": { "shape": "String", "documentation": "The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
", "locationName": "instanceType" }, "MaxTermDurationInDays": { "shape": "Integer", "documentation": "The maximum term. The only possible value is 365 days.
", "locationName": "maxTermDurationInDays" }, "MinTermDurationInDays": { "shape": "Integer", "documentation": "The minimum term. The only possible value is 365 days.
", "locationName": "minTermDurationInDays" }, "NetworkPlatform": { "shape": "String", "documentation": "The network platform.
", "locationName": "networkPlatform" }, "Platform": { "shape": "String", "documentation": "The platform (Linux/UNIX or Windows).
The purchase token. This token expires in two hours.
", "locationName": "purchaseToken" }, "Recurrence": { "shape": "ScheduledInstanceRecurrence", "documentation": "The schedule recurrence.
", "locationName": "recurrence" }, "SlotDurationInHours": { "shape": "Integer", "documentation": "The number of hours in the schedule.
", "locationName": "slotDurationInHours" }, "TotalScheduledInstanceHours": { "shape": "Integer", "documentation": "The total number of hours for a single instance for the entire term.
", "locationName": "totalScheduledInstanceHours" } }, "documentation": "Describes a schedule that is available for your Scheduled Instances.
" }, "ScheduledInstanceAvailabilitySet": { "type": "list", "member": { "shape": "ScheduledInstanceAvailability", "locationName": "item" } }, "ScheduledInstanceId": { "type": "string" }, "ScheduledInstanceIdRequestSet": { "type": "list", "member": { "shape": "ScheduledInstanceId", "locationName": "ScheduledInstanceId" } }, "ScheduledInstanceRecurrence": { "type": "structure", "members": { "Frequency": { "shape": "String", "documentation": "The frequency (Daily, Weekly, or Monthly).
The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
", "locationName": "occurrenceDaySet" }, "OccurrenceRelativeToEnd": { "shape": "Boolean", "documentation": "Indicates whether the occurrence is relative to the end of the specified week or month.
", "locationName": "occurrenceRelativeToEnd" }, "OccurrenceUnit": { "shape": "String", "documentation": "The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
Describes the recurring schedule for a Scheduled Instance.
" }, "ScheduledInstanceRecurrenceRequest": { "type": "structure", "members": { "Frequency": { "shape": "String", "documentation": "The frequency (Daily, Weekly, or Monthly).
The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
", "locationName": "OccurrenceDay" }, "OccurrenceRelativeToEnd": { "shape": "Boolean", "documentation": "Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
" }, "OccurrenceUnit": { "shape": "String", "documentation": "The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
Describes the recurring schedule for a Scheduled Instance.
" }, "ScheduledInstanceSet": { "type": "list", "member": { "shape": "ScheduledInstance", "locationName": "item" } }, "ScheduledInstancesBlockDeviceMapping": { "type": "structure", "members": { "DeviceName": { "shape": "String", "documentation": "The device name (for example, /dev/sdh or xvdh).
Parameters used to set up EBS volumes automatically when the instance is launched.
" }, "NoDevice": { "shape": "String", "documentation": "To omit the device from the block device mapping, specify an empty string.
" }, "VirtualName": { "shape": "String", "documentation": "The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
" } }, "documentation": "Describes a block device mapping for a Scheduled Instance.
" }, "ScheduledInstancesBlockDeviceMappingSet": { "type": "list", "member": { "shape": "ScheduledInstancesBlockDeviceMapping", "locationName": "BlockDeviceMapping" } }, "ScheduledInstancesEbs": { "type": "structure", "members": { "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the volume is deleted on instance termination.
" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.
" }, "Iops": { "shape": "Integer", "documentation": "The number of I/O operations per second (IOPS) to provision for a gp3, io1, or io2 volume.
The ID of the snapshot.
" }, "VolumeSize": { "shape": "Integer", "documentation": "The size of the volume, in GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
" }, "VolumeType": { "shape": "String", "documentation": "The volume type.
Default: gp2
Describes an EBS volume for a Scheduled Instance.
" }, "ScheduledInstancesIamInstanceProfile": { "type": "structure", "members": { "Arn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN).
" }, "Name": { "shape": "String", "documentation": "The name.
" } }, "documentation": "Describes an IAM instance profile for a Scheduled Instance.
" }, "ScheduledInstancesIpv6Address": { "type": "structure", "members": { "Ipv6Address": { "shape": "Ipv6Address", "documentation": "The IPv6 address.
" } }, "documentation": "Describes an IPv6 address.
" }, "ScheduledInstancesIpv6AddressList": { "type": "list", "member": { "shape": "ScheduledInstancesIpv6Address", "locationName": "Ipv6Address" } }, "ScheduledInstancesLaunchSpecification": { "type": "structure", "required": [ "ImageId" ], "members": { "BlockDeviceMappings": { "shape": "ScheduledInstancesBlockDeviceMappingSet", "documentation": "The block device mapping entries.
", "locationName": "BlockDeviceMapping" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The IAM instance profile.
" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the Amazon Machine Image (AMI).
" }, "InstanceType": { "shape": "String", "documentation": "The instance type.
" }, "KernelId": { "shape": "KernelId", "documentation": "The ID of the kernel.
" }, "KeyName": { "shape": "KeyPairName", "documentation": "The name of the key pair.
" }, "Monitoring": { "shape": "ScheduledInstancesMonitoring", "documentation": "Enable or disable monitoring for the instances.
" }, "NetworkInterfaces": { "shape": "ScheduledInstancesNetworkInterfaceSet", "documentation": "The network interfaces.
", "locationName": "NetworkInterface" }, "Placement": { "shape": "ScheduledInstancesPlacement", "documentation": "The placement information.
" }, "RamdiskId": { "shape": "RamdiskId", "documentation": "The ID of the RAM disk.
" }, "SecurityGroupIds": { "shape": "ScheduledInstancesSecurityGroupIdSet", "documentation": "The IDs of the security groups.
", "locationName": "SecurityGroupId" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet in which to launch the instances.
" }, "UserData": { "shape": "String", "documentation": "The base64-encoded MIME user data.
" } }, "documentation": "Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
Indicates whether monitoring is enabled.
" } }, "documentation": "Describes whether monitoring is enabled for a Scheduled Instance.
" }, "ScheduledInstancesNetworkInterface": { "type": "structure", "members": { "AssociatePublicIpAddress": { "shape": "Boolean", "documentation": "Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether to delete the interface when the instance is terminated.
" }, "Description": { "shape": "String", "documentation": "The description.
" }, "DeviceIndex": { "shape": "Integer", "documentation": "The index of the device for the network interface attachment.
" }, "Groups": { "shape": "ScheduledInstancesSecurityGroupIdSet", "documentation": "The IDs of the security groups.
", "locationName": "Group" }, "Ipv6AddressCount": { "shape": "Integer", "documentation": "The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.
" }, "Ipv6Addresses": { "shape": "ScheduledInstancesIpv6AddressList", "documentation": "The specific IPv6 addresses from the subnet range.
", "locationName": "Ipv6Address" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
" }, "PrivateIpAddress": { "shape": "String", "documentation": "The IPv4 address of the network interface within the subnet.
" }, "PrivateIpAddressConfigs": { "shape": "PrivateIpAddressConfigSet", "documentation": "The private IPv4 addresses.
", "locationName": "PrivateIpAddressConfig" }, "SecondaryPrivateIpAddressCount": { "shape": "Integer", "documentation": "The number of secondary private IPv4 addresses.
" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet.
" } }, "documentation": "Describes a network interface for a Scheduled Instance.
" }, "ScheduledInstancesNetworkInterfaceSet": { "type": "list", "member": { "shape": "ScheduledInstancesNetworkInterface", "locationName": "NetworkInterface" } }, "ScheduledInstancesPlacement": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
" }, "GroupName": { "shape": "PlacementGroupName", "documentation": "The name of the placement group.
" } }, "documentation": "Describes the placement for a Scheduled Instance.
" }, "ScheduledInstancesPrivateIpAddressConfig": { "type": "structure", "members": { "Primary": { "shape": "Boolean", "documentation": "Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.
" }, "PrivateIpAddress": { "shape": "String", "documentation": "The IPv4 address.
" } }, "documentation": "Describes a private IPv4 address for a Scheduled Instance.
" }, "ScheduledInstancesSecurityGroupIdSet": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "SecurityGroupId" } }, "SearchLocalGatewayRoutesRequest": { "type": "structure", "required": [ "LocalGatewayRouteTableId" ], "members": { "LocalGatewayRouteTableId": { "shape": "LocalGatewayRoutetableId", "documentation": "The ID of the local gateway route table.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route.
type - The route type.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the routes.
", "locationName": "routeSet" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway multicast domain.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the transit gateway multicast group.
", "locationName": "multicastGroups" }, "NextToken": { "shape": "String", "documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway route table.
" }, "Filters": { "shape": "FilterList", "documentation": "One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
type - The type of route (propagated | static).
The maximum number of routes to return. If a value is not provided, the default is 1000.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the routes.
", "locationName": "routeSet" }, "AdditionalRoutesAvailable": { "shape": "Boolean", "documentation": "Indicates whether there are additional routes available.
", "locationName": "additionalRoutesAvailable" } } }, "SecurityGroup": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the security group.
", "locationName": "groupDescription" }, "GroupName": { "shape": "String", "documentation": "The name of the security group.
", "locationName": "groupName" }, "IpPermissions": { "shape": "IpPermissionList", "documentation": "The inbound rules associated with the security group.
", "locationName": "ipPermissions" }, "OwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID of the owner of the security group.
", "locationName": "ownerId" }, "GroupId": { "shape": "String", "documentation": "The ID of the security group.
", "locationName": "groupId" }, "IpPermissionsEgress": { "shape": "IpPermissionList", "documentation": "The outbound rules associated with the security group.
", "locationName": "ipPermissionsEgress" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the security group.
", "locationName": "tagSet" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC for the security group.
", "locationName": "vpcId" } }, "documentation": "Describes a security group.
" }, "SecurityGroupForVpc": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "The security group's description.
", "locationName": "description" }, "GroupName": { "shape": "String", "documentation": "The security group name.
", "locationName": "groupName" }, "OwnerId": { "shape": "String", "documentation": "The security group owner ID.
", "locationName": "ownerId" }, "GroupId": { "shape": "String", "documentation": "The security group ID.
", "locationName": "groupId" }, "Tags": { "shape": "TagList", "documentation": "The security group tags.
", "locationName": "tagSet" }, "PrimaryVpcId": { "shape": "String", "documentation": "The VPC ID in which the security group was created.
", "locationName": "primaryVpcId" } }, "documentation": "A security group that can be used by interfaces in the VPC.
" }, "SecurityGroupForVpcList": { "type": "list", "member": { "shape": "SecurityGroupForVpc", "locationName": "item" } }, "SecurityGroupId": { "type": "string" }, "SecurityGroupIdList": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "item" } }, "SecurityGroupIdSet": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "item" } }, "SecurityGroupIdStringList": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "SecurityGroupId" } }, "SecurityGroupIdStringListRequest": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "SecurityGroupId" }, "max": 16, "min": 0 }, "SecurityGroupIdentifier": { "type": "structure", "members": { "GroupId": { "shape": "String", "documentation": "The ID of the security group.
", "locationName": "groupId" }, "GroupName": { "shape": "String", "documentation": "The name of the security group.
", "locationName": "groupName" } }, "documentation": "Describes a security group.
" }, "SecurityGroupList": { "type": "list", "member": { "shape": "SecurityGroup", "locationName": "item" } }, "SecurityGroupName": { "type": "string" }, "SecurityGroupReference": { "type": "structure", "members": { "GroupId": { "shape": "String", "documentation": "The ID of your security group.
", "locationName": "groupId" }, "ReferencingVpcId": { "shape": "String", "documentation": "The ID of the VPC with the referencing security group.
", "locationName": "referencingVpcId" }, "VpcPeeringConnectionId": { "shape": "String", "documentation": "The ID of the VPC peering connection (if applicable). For more information about security group referencing for peering connections, see Update your security groups to reference peer security groups in the VPC Peering Guide.
", "locationName": "vpcPeeringConnectionId" }, "TransitGatewayId": { "shape": "String", "documentation": "This parameter is in preview and may not be available for your account.
The ID of the transit gateway (if applicable).
", "locationName": "transitGatewayId" } }, "documentation": "Describes a VPC with a security group that references your security group.
" }, "SecurityGroupReferences": { "type": "list", "member": { "shape": "SecurityGroupReference", "locationName": "item" } }, "SecurityGroupReferencingSupportValue": { "type": "string", "enum": [ "enable", "disable" ] }, "SecurityGroupRule": { "type": "structure", "members": { "SecurityGroupRuleId": { "shape": "SecurityGroupRuleId", "documentation": "The ID of the security group rule.
", "locationName": "securityGroupRuleId" }, "GroupId": { "shape": "SecurityGroupId", "documentation": "The ID of the security group.
", "locationName": "groupId" }, "GroupOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the security group.
", "locationName": "groupOwnerId" }, "IsEgress": { "shape": "Boolean", "documentation": "Indicates whether the security group rule is an outbound rule.
", "locationName": "isEgress" }, "IpProtocol": { "shape": "String", "documentation": "The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
", "locationName": "fromPort" }, "ToPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
", "locationName": "toPort" }, "CidrIpv4": { "shape": "String", "documentation": "The IPv4 CIDR range.
", "locationName": "cidrIpv4" }, "CidrIpv6": { "shape": "String", "documentation": "The IPv6 CIDR range.
", "locationName": "cidrIpv6" }, "PrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list.
", "locationName": "prefixListId" }, "ReferencedGroupInfo": { "shape": "ReferencedSecurityGroup", "documentation": "Describes the security group that is referenced in the rule.
", "locationName": "referencedGroupInfo" }, "Description": { "shape": "String", "documentation": "The security group rule description.
", "locationName": "description" }, "Tags": { "shape": "TagList", "documentation": "The tags applied to the security group rule.
", "locationName": "tagSet" } }, "documentation": "Describes a security group rule.
" }, "SecurityGroupRuleDescription": { "type": "structure", "members": { "SecurityGroupRuleId": { "shape": "String", "documentation": "The ID of the security group rule.
" }, "Description": { "shape": "String", "documentation": "The description of the security group rule.
" } }, "documentation": "Describes the description of a security group rule.
You can use this when you want to update the security group rule description for either an inbound or outbound rule.
" }, "SecurityGroupRuleDescriptionList": { "type": "list", "member": { "shape": "SecurityGroupRuleDescription", "locationName": "item" } }, "SecurityGroupRuleId": { "type": "string" }, "SecurityGroupRuleIdList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "SecurityGroupRuleList": { "type": "list", "member": { "shape": "SecurityGroupRule", "locationName": "item" } }, "SecurityGroupRuleRequest": { "type": "structure", "members": { "IpProtocol": { "shape": "String", "documentation": "The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
" }, "ToPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
" }, "CidrIpv4": { "shape": "String", "documentation": "The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
" }, "CidrIpv6": { "shape": "String", "documentation": "The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
" }, "PrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list.
" }, "ReferencedGroupId": { "shape": "SecurityGroupId", "documentation": "The ID of the security group that is referenced in the security group rule.
" }, "Description": { "shape": "String", "documentation": "The description of the security group rule.
" } }, "documentation": "Describes a security group rule.
You must specify exactly one of the following parameters, based on the rule type:
CidrIpv4
CidrIpv6
PrefixListId
ReferencedGroupId
When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 address range.
The ID of the security group rule.
" }, "SecurityGroupRule": { "shape": "SecurityGroupRuleRequest", "documentation": "Information about the security group rule.
" } }, "documentation": "Describes an update to a security group rule.
" }, "SecurityGroupRuleUpdateList": { "type": "list", "member": { "shape": "SecurityGroupRuleUpdate", "locationName": "item" } }, "SecurityGroupStringList": { "type": "list", "member": { "shape": "SecurityGroupName", "locationName": "SecurityGroup" } }, "SelfServicePortal": { "type": "string", "enum": [ "enabled", "disabled" ] }, "SendDiagnosticInterruptRequest": { "type": "structure", "required": [ "InstanceId" ], "members": { "InstanceId": { "shape": "InstanceId", "documentation": "The ID of the instance.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The type of service.
", "locationName": "serviceType" }, "ServiceId": { "shape": "String", "documentation": "The ID of the service.
", "locationName": "serviceId" }, "ServiceName": { "shape": "String", "documentation": "The name of the service.
", "locationName": "serviceName" }, "ServiceState": { "shape": "ServiceState", "documentation": "The service state.
", "locationName": "serviceState" }, "AvailabilityZones": { "shape": "ValueStringList", "documentation": "The Availability Zones in which the service is available.
", "locationName": "availabilityZoneSet" }, "AcceptanceRequired": { "shape": "Boolean", "documentation": "Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
", "locationName": "acceptanceRequired" }, "ManagesVpcEndpoints": { "shape": "Boolean", "documentation": "Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
", "locationName": "managesVpcEndpoints" }, "NetworkLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
", "locationName": "networkLoadBalancerArnSet" }, "GatewayLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
", "locationName": "gatewayLoadBalancerArnSet" }, "SupportedIpAddressTypes": { "shape": "SupportedIpAddressTypes", "documentation": "The supported IP address types.
", "locationName": "supportedIpAddressTypeSet" }, "BaseEndpointDnsNames": { "shape": "ValueStringList", "documentation": "The DNS names for the service.
", "locationName": "baseEndpointDnsNameSet" }, "PrivateDnsName": { "shape": "String", "documentation": "The private DNS name for the service.
", "locationName": "privateDnsName" }, "PrivateDnsNameConfiguration": { "shape": "PrivateDnsNameConfiguration", "documentation": "Information about the endpoint service private DNS name configuration.
", "locationName": "privateDnsNameConfiguration" }, "PayerResponsibility": { "shape": "PayerResponsibility", "documentation": "The payer responsibility.
", "locationName": "payerResponsibility" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the service.
", "locationName": "tagSet" } }, "documentation": "Describes a service configuration for a VPC endpoint service.
" }, "ServiceConfigurationSet": { "type": "list", "member": { "shape": "ServiceConfiguration", "locationName": "item" } }, "ServiceConnectivityType": { "type": "string", "enum": [ "ipv4", "ipv6" ] }, "ServiceDetail": { "type": "structure", "members": { "ServiceName": { "shape": "String", "documentation": "The name of the service.
", "locationName": "serviceName" }, "ServiceId": { "shape": "String", "documentation": "The ID of the endpoint service.
", "locationName": "serviceId" }, "ServiceType": { "shape": "ServiceTypeDetailSet", "documentation": "The type of service.
", "locationName": "serviceType" }, "AvailabilityZones": { "shape": "ValueStringList", "documentation": "The Availability Zones in which the service is available.
", "locationName": "availabilityZoneSet" }, "Owner": { "shape": "String", "documentation": "The Amazon Web Services account ID of the service owner.
", "locationName": "owner" }, "BaseEndpointDnsNames": { "shape": "ValueStringList", "documentation": "The DNS names for the service.
", "locationName": "baseEndpointDnsNameSet" }, "PrivateDnsName": { "shape": "String", "documentation": "The private DNS name for the service.
", "locationName": "privateDnsName" }, "PrivateDnsNames": { "shape": "PrivateDnsDetailsSet", "documentation": "The private DNS names assigned to the VPC endpoint service.
", "locationName": "privateDnsNameSet" }, "VpcEndpointPolicySupported": { "shape": "Boolean", "documentation": "Indicates whether the service supports endpoint policies.
", "locationName": "vpcEndpointPolicySupported" }, "AcceptanceRequired": { "shape": "Boolean", "documentation": "Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
", "locationName": "acceptanceRequired" }, "ManagesVpcEndpoints": { "shape": "Boolean", "documentation": "Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
", "locationName": "managesVpcEndpoints" }, "PayerResponsibility": { "shape": "PayerResponsibility", "documentation": "The payer responsibility.
", "locationName": "payerResponsibility" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the service.
", "locationName": "tagSet" }, "PrivateDnsNameVerificationState": { "shape": "DnsNameState", "documentation": "The verification state of the VPC endpoint service.
Consumers of the endpoint service cannot use the private name when the state is not verified.
The supported IP address types.
", "locationName": "supportedIpAddressTypeSet" } }, "documentation": "Describes a VPC endpoint service.
" }, "ServiceDetailSet": { "type": "list", "member": { "shape": "ServiceDetail", "locationName": "item" } }, "ServiceState": { "type": "string", "enum": [ "Pending", "Available", "Deleting", "Deleted", "Failed" ] }, "ServiceType": { "type": "string", "enum": [ "Interface", "Gateway", "GatewayLoadBalancer" ] }, "ServiceTypeDetail": { "type": "structure", "members": { "ServiceType": { "shape": "ServiceType", "documentation": "The type of service.
", "locationName": "serviceType" } }, "documentation": "Describes the type of service for a VPC endpoint.
" }, "ServiceTypeDetailSet": { "type": "list", "member": { "shape": "ServiceTypeDetail", "locationName": "item" } }, "ShutdownBehavior": { "type": "string", "enum": [ "stop", "terminate" ] }, "SlotDateTimeRangeRequest": { "type": "structure", "required": [ "EarliestTime", "LatestTime" ], "members": { "EarliestTime": { "shape": "DateTime", "documentation": "The earliest date and time, in UTC, for the Scheduled Instance to start.
" }, "LatestTime": { "shape": "DateTime", "documentation": "The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
" } }, "documentation": "Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.
" }, "SlotStartTimeRangeRequest": { "type": "structure", "members": { "EarliestTime": { "shape": "DateTime", "documentation": "The earliest date and time, in UTC, for the Scheduled Instance to start.
" }, "LatestTime": { "shape": "DateTime", "documentation": "The latest date and time, in UTC, for the Scheduled Instance to start.
" } }, "documentation": "Describes the time period for a Scheduled Instance to start its first schedule.
" }, "Snapshot": { "type": "structure", "members": { "DataEncryptionKeyId": { "shape": "String", "documentation": "The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
", "locationName": "dataEncryptionKeyId" }, "Description": { "shape": "String", "documentation": "The description for the snapshot.
", "locationName": "description" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the snapshot is encrypted.
", "locationName": "encrypted" }, "KmsKeyId": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
", "locationName": "kmsKeyId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the EBS snapshot.
", "locationName": "ownerId" }, "Progress": { "shape": "String", "documentation": "The progress of the snapshot, as a percentage.
", "locationName": "progress" }, "SnapshotId": { "shape": "String", "documentation": "The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
", "locationName": "snapshotId" }, "StartTime": { "shape": "DateTime", "documentation": "The time stamp when the snapshot was initiated.
", "locationName": "startTime" }, "State": { "shape": "SnapshotState", "documentation": "The snapshot state.
", "locationName": "status" }, "StateMessage": { "shape": "String", "documentation": "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 state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
", "locationName": "statusMessage" }, "VolumeId": { "shape": "String", "documentation": "The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
", "locationName": "volumeId" }, "VolumeSize": { "shape": "Integer", "documentation": "The size of the volume, in GiB.
", "locationName": "volumeSize" }, "OwnerAlias": { "shape": "String", "documentation": "The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.
The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
", "locationName": "outpostArn" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the snapshot.
", "locationName": "tagSet" }, "StorageTier": { "shape": "StorageTier", "documentation": "The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
", "locationName": "restoreExpiryTime" }, "SseType": { "shape": "SSEType", "documentation": "Reserved for future use.
", "locationName": "sseType" } }, "documentation": "Describes a snapshot.
" }, "SnapshotAttributeName": { "type": "string", "enum": [ "productCodes", "createVolumePermission" ] }, "SnapshotBlockPublicAccessState": { "type": "string", "enum": [ "block-all-sharing", "block-new-sharing", "unblocked" ] }, "SnapshotDetail": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description for the snapshot.
", "locationName": "description" }, "DeviceName": { "shape": "String", "documentation": "The block device mapping for the snapshot.
", "locationName": "deviceName" }, "DiskImageSize": { "shape": "Double", "documentation": "The size of the disk in the snapshot, in GiB.
", "locationName": "diskImageSize" }, "Format": { "shape": "String", "documentation": "The format of the disk image from which the snapshot is created.
", "locationName": "format" }, "Progress": { "shape": "String", "documentation": "The percentage of progress for the task.
", "locationName": "progress" }, "SnapshotId": { "shape": "String", "documentation": "The snapshot ID of the disk being imported.
", "locationName": "snapshotId" }, "Status": { "shape": "String", "documentation": "A brief status of the snapshot creation.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "A detailed status message for the snapshot creation.
", "locationName": "statusMessage" }, "Url": { "shape": "SensitiveUrl", "documentation": "The URL used to access the disk image.
", "locationName": "url" }, "UserBucket": { "shape": "UserBucketDetails", "documentation": "The Amazon S3 bucket for the disk image.
", "locationName": "userBucket" } }, "documentation": "Describes the snapshot created from the imported disk.
" }, "SnapshotDetailList": { "type": "list", "member": { "shape": "SnapshotDetail", "locationName": "item" } }, "SnapshotDiskContainer": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "The description of the disk image being imported.
" }, "Format": { "shape": "String", "documentation": "The format of the disk image being imported.
Valid values: VHD | VMDK | RAW
The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).
" }, "UserBucket": { "shape": "UserBucket", "documentation": "The Amazon S3 bucket for the disk image.
" } }, "documentation": "The disk container object for the import snapshot request.
" }, "SnapshotId": { "type": "string" }, "SnapshotIdStringList": { "type": "list", "member": { "shape": "SnapshotId", "locationName": "SnapshotId" } }, "SnapshotInfo": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "Description specified by the CreateSnapshotRequest that has been applied to all snapshots.
", "locationName": "description" }, "Tags": { "shape": "TagList", "documentation": "Tags associated with this snapshot.
", "locationName": "tagSet" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the snapshot is encrypted.
", "locationName": "encrypted" }, "VolumeId": { "shape": "String", "documentation": "Source volume from which this snapshot was created.
", "locationName": "volumeId" }, "State": { "shape": "SnapshotState", "documentation": "Current state of the snapshot.
", "locationName": "state" }, "VolumeSize": { "shape": "Integer", "documentation": "Size of the volume from which this snapshot was created.
", "locationName": "volumeSize" }, "StartTime": { "shape": "MillisecondDateTime", "documentation": "Time this snapshot was started. This is the same for all snapshots initiated by the same request.
", "locationName": "startTime" }, "Progress": { "shape": "String", "documentation": "Progress this snapshot has made towards completing.
", "locationName": "progress" }, "OwnerId": { "shape": "String", "documentation": "Account id used when creating this snapshot.
", "locationName": "ownerId" }, "SnapshotId": { "shape": "String", "documentation": "Snapshot id that can be used to describe this snapshot.
", "locationName": "snapshotId" }, "OutpostArn": { "shape": "String", "documentation": "The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
", "locationName": "outpostArn" }, "SseType": { "shape": "SSEType", "documentation": "Reserved for future use.
", "locationName": "sseType" } }, "documentation": "Information about a snapshot.
" }, "SnapshotList": { "type": "list", "member": { "shape": "Snapshot", "locationName": "item" } }, "SnapshotRecycleBinInfo": { "type": "structure", "members": { "SnapshotId": { "shape": "String", "documentation": "The ID of the snapshot.
", "locationName": "snapshotId" }, "RecycleBinEnterTime": { "shape": "MillisecondDateTime", "documentation": "The date and time when the snaphsot entered the Recycle Bin.
", "locationName": "recycleBinEnterTime" }, "RecycleBinExitTime": { "shape": "MillisecondDateTime", "documentation": "The date and time when the snapshot is to be permanently deleted from the Recycle Bin.
", "locationName": "recycleBinExitTime" }, "Description": { "shape": "String", "documentation": "The description for the snapshot.
", "locationName": "description" }, "VolumeId": { "shape": "String", "documentation": "The ID of the volume from which the snapshot was created.
", "locationName": "volumeId" } }, "documentation": "Information about a snapshot that is currently in the Recycle Bin.
" }, "SnapshotRecycleBinInfoList": { "type": "list", "member": { "shape": "SnapshotRecycleBinInfo", "locationName": "item" } }, "SnapshotSet": { "type": "list", "member": { "shape": "SnapshotInfo", "locationName": "item" } }, "SnapshotState": { "type": "string", "enum": [ "pending", "completed", "error", "recoverable", "recovering" ] }, "SnapshotTaskDetail": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "The description of the snapshot.
", "locationName": "description" }, "DiskImageSize": { "shape": "Double", "documentation": "The size of the disk in the snapshot, in GiB.
", "locationName": "diskImageSize" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the snapshot is encrypted.
", "locationName": "encrypted" }, "Format": { "shape": "String", "documentation": "The format of the disk image from which the snapshot is created.
", "locationName": "format" }, "KmsKeyId": { "shape": "String", "documentation": "The identifier for the KMS key that was used to create the encrypted snapshot.
", "locationName": "kmsKeyId" }, "Progress": { "shape": "String", "documentation": "The percentage of completion for the import snapshot task.
", "locationName": "progress" }, "SnapshotId": { "shape": "String", "documentation": "The snapshot ID of the disk being imported.
", "locationName": "snapshotId" }, "Status": { "shape": "String", "documentation": "A brief status for the import snapshot task.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "A detailed status message for the import snapshot task.
", "locationName": "statusMessage" }, "Url": { "shape": "SensitiveUrl", "documentation": "The URL of the disk image from which the snapshot is created.
", "locationName": "url" }, "UserBucket": { "shape": "UserBucketDetails", "documentation": "The Amazon S3 bucket for the disk image.
", "locationName": "userBucket" } }, "documentation": "Details about the import snapshot task.
" }, "SnapshotTierStatus": { "type": "structure", "members": { "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot.
", "locationName": "snapshotId" }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume from which the snapshot was created.
", "locationName": "volumeId" }, "Status": { "shape": "SnapshotState", "documentation": "The state of the snapshot.
", "locationName": "status" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the snapshot.
", "locationName": "ownerId" }, "Tags": { "shape": "TagList", "documentation": "The tags that are assigned to the snapshot.
", "locationName": "tagSet" }, "StorageTier": { "shape": "StorageTier", "documentation": "The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
The date and time when the last archive or restore process was started.
", "locationName": "lastTieringStartTime" }, "LastTieringProgress": { "shape": "Integer", "documentation": "The progress of the last archive or restore process, as a percentage.
", "locationName": "lastTieringProgress" }, "LastTieringOperationStatus": { "shape": "TieringOperationStatus", "documentation": "The status of the last archive or restore process.
", "locationName": "lastTieringOperationStatus" }, "LastTieringOperationStatusDetail": { "shape": "String", "documentation": "A message describing the status of the last archive or restore process.
", "locationName": "lastTieringOperationStatusDetail" }, "ArchivalCompleteTime": { "shape": "MillisecondDateTime", "documentation": "The date and time when the last archive process was completed.
", "locationName": "archivalCompleteTime" }, "RestoreExpiryTime": { "shape": "MillisecondDateTime", "documentation": "Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
", "locationName": "restoreExpiryTime" } }, "documentation": "Provides information about a snapshot's storage tier.
" }, "SpotAllocationStrategy": { "type": "string", "enum": [ "lowest-price", "diversified", "capacity-optimized", "capacity-optimized-prioritized", "price-capacity-optimized" ] }, "SpotCapacityRebalance": { "type": "structure", "members": { "ReplacementStrategy": { "shape": "ReplacementStrategy", "documentation": "The replacement strategy to use. Only available for fleets of type maintain.
launch - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
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.
" }, "SpotDatafeedSubscription": { "type": "structure", "members": { "Bucket": { "shape": "String", "documentation": "The name of the Amazon S3 bucket where the Spot Instance data feed is located.
", "locationName": "bucket" }, "Fault": { "shape": "SpotInstanceStateFault", "documentation": "The fault codes for the Spot Instance request, if any.
", "locationName": "fault" }, "OwnerId": { "shape": "String", "documentation": "The Amazon Web Services account ID of the account.
", "locationName": "ownerId" }, "Prefix": { "shape": "String", "documentation": "The prefix for the data feed files.
", "locationName": "prefix" }, "State": { "shape": "DatafeedSubscriptionState", "documentation": "The state of the Spot Instance data feed subscription.
", "locationName": "state" } }, "documentation": "Describes the data feed for a Spot Instance.
" }, "SpotFleetLaunchSpecification": { "type": "structure", "members": { "SecurityGroups": { "shape": "GroupIdentifierList", "documentation": "The security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", "locationName": "groupSet" }, "AddressingType": { "shape": "String", "documentation": "Deprecated.
", "locationName": "addressingType" }, "BlockDeviceMappings": { "shape": "BlockDeviceMappingList", "documentation": "One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
", "locationName": "blockDeviceMapping" }, "EbsOptimized": { "shape": "Boolean", "documentation": "Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
The IAM instance profile.
", "locationName": "iamInstanceProfile" }, "ImageId": { "shape": "ImageId", "documentation": "The ID of the AMI.
", "locationName": "imageId" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
", "locationName": "instanceType" }, "KernelId": { "shape": "String", "documentation": "The ID of the kernel.
", "locationName": "kernelId" }, "KeyName": { "shape": "KeyPairName", "documentation": "The name of the key pair.
", "locationName": "keyName" }, "Monitoring": { "shape": "SpotFleetMonitoring", "documentation": "Enable or disable monitoring for the instances.
", "locationName": "monitoring" }, "NetworkInterfaces": { "shape": "InstanceNetworkInterfaceSpecificationList", "documentation": "The network interfaces.
SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead.
The placement information.
", "locationName": "placement" }, "RamdiskId": { "shape": "String", "documentation": "The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
", "locationName": "ramdiskId" }, "SpotPrice": { "shape": "String", "documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
", "locationName": "subnetId" }, "UserData": { "shape": "SensitiveUserData", "documentation": "The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", "locationName": "userData" }, "WeightedCapacity": { "shape": "Double", "documentation": "The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
", "locationName": "weightedCapacity" }, "TagSpecifications": { "shape": "SpotFleetTagSpecificationList", "documentation": "The tags to apply during creation.
", "locationName": "tagSpecificationSet" }, "InstanceRequirements": { "shape": "InstanceRequirements", "documentation": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can't specify InstanceType.
Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
Enables monitoring for the instance.
Default: false
Describes whether monitoring is enabled.
" }, "SpotFleetRequestConfig": { "type": "structure", "members": { "ActivityStatus": { "shape": "ActivityStatus", "documentation": "The progress of the Spot Fleet request. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.
The creation date and time of the request.
", "locationName": "createTime" }, "SpotFleetRequestConfig": { "shape": "SpotFleetRequestConfigData", "documentation": "The configuration of the Spot Fleet request.
", "locationName": "spotFleetRequestConfig" }, "SpotFleetRequestId": { "shape": "String", "documentation": "The ID of the Spot Fleet request.
", "locationName": "spotFleetRequestId" }, "SpotFleetRequestState": { "shape": "BatchState", "documentation": "The state of the Spot Fleet request.
", "locationName": "spotFleetRequestState" }, "Tags": { "shape": "TagList", "documentation": "The tags for a Spot Fleet resource.
", "locationName": "tagSet" } }, "documentation": "Describes a Spot Fleet request.
" }, "SpotFleetRequestConfigData": { "type": "structure", "required": [ "IamFleetRole", "TargetCapacity" ], "members": { "AllocationStrategy": { "shape": "AllocationStrategy", "documentation": "The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
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.
Default: lowestPrice
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
", "locationName": "spotMaintenanceStrategies" }, "ClientToken": { "shape": "String", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
", "locationName": "clientToken" }, "ExcessCapacityTerminationPolicy": { "shape": "ExcessCapacityTerminationPolicy", "documentation": "Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
", "locationName": "fulfilledCapacity" }, "OnDemandFulfilledCapacity": { "shape": "Double", "documentation": "The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
", "locationName": "onDemandFulfilledCapacity" }, "IamFleetRole": { "shape": "String", "documentation": "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 launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.
If an AMI specified in a launch specification is deregistered or disabled, no new instances can be launched from the AMI. For fleets of type maintain, the target capacity will not be maintained.
The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
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 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.
The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
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 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.
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
", "locationName": "terminateInstancesWithExpiration" }, "Type": { "shape": "FleetType", "documentation": "The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.
The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.
", "locationName": "validFrom" }, "ValidUntil": { "shape": "DateTime", "documentation": "The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
", "locationName": "validUntil" }, "ReplaceUnhealthyInstances": { "shape": "Boolean", "documentation": "Indicates whether Spot Fleet should replace unhealthy instances.
", "locationName": "replaceUnhealthyInstances" }, "InstanceInterruptionBehavior": { "shape": "InstanceInterruptionBehavior", "documentation": "The behavior when a Spot Instance is interrupted. The default is terminate.
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
", "locationName": "loadBalancersConfig" }, "InstancePoolsToUseCount": { "shape": "Integer", "documentation": "The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
", "locationName": "instancePoolsToUseCount" }, "Context": { "shape": "String", "documentation": "Reserved.
", "locationName": "context" }, "TargetCapacityUnitType": { "shape": "TargetCapacityUnitType", "documentation": "The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection.
Default: units (the number of instances)
The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tag your resources.
Describes the configuration of a Spot Fleet request.
" }, "SpotFleetRequestConfigSet": { "type": "list", "member": { "shape": "SpotFleetRequestConfig", "locationName": "item" } }, "SpotFleetRequestId": { "type": "string" }, "SpotFleetRequestIdList": { "type": "list", "member": { "shape": "SpotFleetRequestId", "locationName": "item" } }, "SpotFleetTagSpecification": { "type": "structure", "members": { "ResourceType": { "shape": "ResourceType", "documentation": "The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .
The tags.
", "locationName": "tag" } }, "documentation": "The tags for a Spot Fleet resource.
" }, "SpotFleetTagSpecificationList": { "type": "list", "member": { "shape": "SpotFleetTagSpecification", "locationName": "item" } }, "SpotInstanceInterruptionBehavior": { "type": "string", "enum": [ "hibernate", "stop", "terminate" ] }, "SpotInstanceRequest": { "type": "structure", "members": { "ActualBlockHourlyPrice": { "shape": "String", "documentation": "Deprecated.
", "locationName": "actualBlockHourlyPrice" }, "AvailabilityZoneGroup": { "shape": "String", "documentation": "The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
", "locationName": "availabilityZoneGroup" }, "BlockDurationMinutes": { "shape": "Integer", "documentation": "Deprecated.
", "locationName": "blockDurationMinutes" }, "CreateTime": { "shape": "DateTime", "documentation": "The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "createTime" }, "Fault": { "shape": "SpotInstanceStateFault", "documentation": "The fault codes for the Spot Instance request, if any.
", "locationName": "fault" }, "InstanceId": { "shape": "InstanceId", "documentation": "The instance ID, if an instance has been launched to fulfill the Spot Instance request.
", "locationName": "instanceId" }, "LaunchGroup": { "shape": "String", "documentation": "The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
", "locationName": "launchGroup" }, "LaunchSpecification": { "shape": "LaunchSpecification", "documentation": "Additional information for launching instances.
", "locationName": "launchSpecification" }, "LaunchedAvailabilityZone": { "shape": "String", "documentation": "The Availability Zone in which the request is launched.
", "locationName": "launchedAvailabilityZone" }, "ProductDescription": { "shape": "RIProductDescription", "documentation": "The product description associated with the Spot Instance.
", "locationName": "productDescription" }, "SpotInstanceRequestId": { "shape": "String", "documentation": "The ID of the Spot Instance request.
", "locationName": "spotInstanceRequestId" }, "SpotPrice": { "shape": "String", "documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
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.
", "locationName": "state" }, "Status": { "shape": "SpotInstanceStatus", "documentation": "The status code and status message describing the Spot Instance request.
", "locationName": "status" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the resource.
", "locationName": "tagSet" }, "Type": { "shape": "SpotInstanceType", "documentation": "The Spot Instance request type.
", "locationName": "type" }, "ValidFrom": { "shape": "DateTime", "documentation": "The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.
", "locationName": "validFrom" }, "ValidUntil": { "shape": "DateTime", "documentation": "The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the validUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the validUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
The behavior when a Spot Instance is interrupted.
", "locationName": "instanceInterruptionBehavior" } }, "documentation": "Describes a Spot Instance request.
" }, "SpotInstanceRequestId": { "type": "string" }, "SpotInstanceRequestIdList": { "type": "list", "member": { "shape": "SpotInstanceRequestId", "locationName": "SpotInstanceRequestId" } }, "SpotInstanceRequestList": { "type": "list", "member": { "shape": "SpotInstanceRequest", "locationName": "item" } }, "SpotInstanceState": { "type": "string", "enum": [ "open", "active", "closed", "cancelled", "failed", "disabled" ] }, "SpotInstanceStateFault": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The reason code for the Spot Instance state change.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The message for the Spot Instance state change.
", "locationName": "message" } }, "documentation": "Describes a Spot Instance state change.
" }, "SpotInstanceStatus": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The description for the status code.
", "locationName": "message" }, "UpdateTime": { "shape": "DateTime", "documentation": "The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "updateTime" } }, "documentation": "Describes the status of a Spot Instance request.
" }, "SpotInstanceType": { "type": "string", "enum": [ "one-time", "persistent" ] }, "SpotMaintenanceStrategies": { "type": "structure", "members": { "CapacityRebalance": { "shape": "SpotCapacityRebalance", "documentation": "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.
", "locationName": "capacityRebalance" } }, "documentation": "The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
" }, "SpotMarketOptions": { "type": "structure", "members": { "MaxPrice": { "shape": "String", "documentation": "The maximum hourly price that you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when the instance interruption behavior is either hibernate or stop.
Deprecated.
" }, "ValidUntil": { "shape": "DateTime", "documentation": "The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, ValidUntil is not supported. The request remains active until all instances launch or you cancel the request.
The behavior when a Spot Instance is interrupted.
If Configured (for HibernationOptions ) is set to true, the InstanceInterruptionBehavior parameter is automatically set to hibernate. If you set it to stop or terminate, you'll get an error.
If Configured (for HibernationOptions ) is set to false or null, the InstanceInterruptionBehavior parameter is automatically set to terminate. You can also set it to stop or hibernate.
For more information, see Interruption behavior in the Amazon EC2 User Guide.
" } }, "documentation": "The options for Spot Instances.
" }, "SpotOptions": { "type": "structure", "members": { "AllocationStrategy": { "shape": "SpotAllocationStrategy", "documentation": "The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
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.
Default: lowest-price
The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.
", "locationName": "maintenanceStrategies" }, "InstanceInterruptionBehavior": { "shape": "SpotInstanceInterruptionBehavior", "documentation": "The behavior when a Spot Instance is interrupted.
Default: terminate
The number of Spot pools across which to allocate your target Spot capacity. Supported only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
", "locationName": "instancePoolsToUseCount" }, "SingleInstanceType": { "shape": "Boolean", "documentation": "Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant.
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.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
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.
Describes the configuration of Spot Instances in an EC2 Fleet.
" }, "SpotOptionsRequest": { "type": "structure", "members": { "AllocationStrategy": { "shape": "SpotAllocationStrategy", "documentation": "The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
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.
Default: lowest-price
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
" }, "InstanceInterruptionBehavior": { "shape": "SpotInstanceInterruptionBehavior", "documentation": "The behavior when a Spot Instance is interrupted.
Default: terminate
The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
" }, "SingleInstanceType": { "shape": "Boolean", "documentation": "Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant.
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.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
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.
Describes the configuration of Spot Instances in an EC2 Fleet request.
" }, "SpotPlacement": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".
", "locationName": "availabilityZone" }, "GroupName": { "shape": "PlacementGroupName", "documentation": "The name of the placement group.
", "locationName": "groupName" }, "Tenancy": { "shape": "Tenancy", "documentation": "The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
Describes Spot Instance placement.
" }, "SpotPlacementScore": { "type": "structure", "members": { "Region": { "shape": "String", "documentation": "The Region.
", "locationName": "region" }, "AvailabilityZoneId": { "shape": "String", "documentation": "The Availability Zone.
", "locationName": "availabilityZoneId" }, "Score": { "shape": "Integer", "documentation": "The placement score, on a scale from 1 to 10. A score of 10 indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of 1 indicates that your Spot request is not likely to succeed.
The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the capacity-optimized allocation strategy is used and that all of the Availability Zones in the Region can be used.
The Availability Zone.
", "locationName": "availabilityZone" }, "InstanceType": { "shape": "InstanceType", "documentation": "The instance type.
", "locationName": "instanceType" }, "ProductDescription": { "shape": "RIProductDescription", "documentation": "A general description of the AMI.
", "locationName": "productDescription" }, "SpotPrice": { "shape": "String", "documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", "locationName": "timestamp" } }, "documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
", "locationName": "fromPort" }, "IpProtocol": { "shape": "String", "documentation": "The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
The IP ranges. Not applicable for stale security group rules.
", "locationName": "ipRanges" }, "PrefixListIds": { "shape": "PrefixListIdSet", "documentation": "The prefix list IDs. Not applicable for stale security group rules.
", "locationName": "prefixListIds" }, "ToPort": { "shape": "Integer", "documentation": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes).
", "locationName": "toPort" }, "UserIdGroupPairs": { "shape": "UserIdGroupPairSet", "documentation": "The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
", "locationName": "groups" } }, "documentation": "Describes a stale rule in a security group.
" }, "StaleIpPermissionSet": { "type": "list", "member": { "shape": "StaleIpPermission", "locationName": "item" } }, "StaleSecurityGroup": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "The description of the security group.
", "locationName": "description" }, "GroupId": { "shape": "String", "documentation": "The ID of the security group.
", "locationName": "groupId" }, "GroupName": { "shape": "String", "documentation": "The name of the security group.
", "locationName": "groupName" }, "StaleIpPermissions": { "shape": "StaleIpPermissionSet", "documentation": "Information about the stale inbound rules in the security group.
", "locationName": "staleIpPermissions" }, "StaleIpPermissionsEgress": { "shape": "StaleIpPermissionSet", "documentation": "Information about the stale outbound rules in the security group.
", "locationName": "staleIpPermissionsEgress" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC for the security group.
", "locationName": "vpcId" } }, "documentation": "Describes a stale security group (a security group that contains stale rules).
" }, "StaleSecurityGroupSet": { "type": "list", "member": { "shape": "StaleSecurityGroup", "locationName": "item" } }, "StartInstancesRequest": { "type": "structure", "required": [ "InstanceIds" ], "members": { "InstanceIds": { "shape": "InstanceIdStringList", "documentation": "The IDs of the instances.
", "locationName": "InstanceId" }, "AdditionalInfo": { "shape": "String", "documentation": "Reserved.
", "locationName": "additionalInfo" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the started instances.
", "locationName": "instancesSet" } } }, "StartNetworkInsightsAccessScopeAnalysisRequest": { "type": "structure", "required": [ "NetworkInsightsAccessScopeId", "ClientToken" ], "members": { "NetworkInsightsAccessScopeId": { "shape": "NetworkInsightsAccessScopeId", "documentation": "The ID of the Network Access Scope.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tags to apply.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true } } }, "StartNetworkInsightsAccessScopeAnalysisResult": { "type": "structure", "members": { "NetworkInsightsAccessScopeAnalysis": { "shape": "NetworkInsightsAccessScopeAnalysis", "documentation": "The Network Access Scope analysis.
", "locationName": "networkInsightsAccessScopeAnalysis" } } }, "StartNetworkInsightsAnalysisRequest": { "type": "structure", "required": [ "NetworkInsightsPathId", "ClientToken" ], "members": { "NetworkInsightsPathId": { "shape": "NetworkInsightsPathId", "documentation": "The ID of the path.
" }, "AdditionalAccounts": { "shape": "ValueStringList", "documentation": "The member accounts that contain resources that the path can traverse.
", "locationName": "AdditionalAccount" }, "FilterInArns": { "shape": "ArnList", "documentation": "The Amazon Resource Names (ARN) of the resources that the path must traverse.
", "locationName": "FilterInArn" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The tags to apply.
", "locationName": "TagSpecification" }, "ClientToken": { "shape": "String", "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "idempotencyToken": true } } }, "StartNetworkInsightsAnalysisResult": { "type": "structure", "members": { "NetworkInsightsAnalysis": { "shape": "NetworkInsightsAnalysis", "documentation": "Information about the network insights analysis.
", "locationName": "networkInsightsAnalysis" } } }, "StartVpcEndpointServicePrivateDnsVerificationRequest": { "type": "structure", "required": [ "ServiceId" ], "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the endpoint service.
" } } }, "StartVpcEndpointServicePrivateDnsVerificationResult": { "type": "structure", "members": { "ReturnValue": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The reason code for the state change.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The message for the state change.
Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.
Server.InternalError: An internal error caused the instance to terminate during launch.
Server.ScheduledStop: The instance was stopped due to a scheduled retirement.
Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
Client.InstanceInitiatedShutdown: The instance was shut down from the operating system of the instance.
Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.
Client.InternalError: A client error caused the instance to terminate during launch.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
Client.UserInitiatedHibernate: Hibernation was initiated on the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.
Describes a state change.
" }, "StaticSourcesSupportValue": { "type": "string", "enum": [ "enable", "disable" ] }, "StatisticType": { "type": "string", "enum": [ "p50" ] }, "Status": { "type": "string", "enum": [ "MoveInProgress", "InVpc", "InClassic" ] }, "StatusName": { "type": "string", "enum": [ "reachability" ] }, "StatusType": { "type": "string", "enum": [ "passed", "failed", "insufficient-data", "initializing" ] }, "StopInstancesRequest": { "type": "structure", "required": [ "InstanceIds" ], "members": { "InstanceIds": { "shape": "InstanceIdStringList", "documentation": "The IDs of the instances.
", "locationName": "InstanceId" }, "Hibernate": { "shape": "Boolean", "documentation": "Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
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.
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
Information about the stopped instances.
", "locationName": "instancesSet" } } }, "Storage": { "type": "structure", "members": { "S3": { "shape": "S3Storage", "documentation": "An Amazon S3 storage location.
" } }, "documentation": "Describes the storage location for an instance store-backed AMI.
" }, "StorageLocation": { "type": "structure", "members": { "Bucket": { "shape": "String", "documentation": "The name of the S3 bucket.
" }, "Key": { "shape": "String", "documentation": "The key.
" } }, "documentation": "Describes a storage location in Amazon S3.
" }, "StorageTier": { "type": "string", "enum": [ "archive", "standard" ] }, "StoreImageTaskResult": { "type": "structure", "members": { "AmiId": { "shape": "String", "documentation": "The ID of the AMI that is being stored.
", "locationName": "amiId" }, "TaskStartTime": { "shape": "MillisecondDateTime", "documentation": "The time the task started.
", "locationName": "taskStartTime" }, "Bucket": { "shape": "String", "documentation": "The name of the Amazon S3 bucket that contains the stored AMI object.
", "locationName": "bucket" }, "S3objectKey": { "shape": "String", "documentation": "The name of the stored AMI object in the bucket.
", "locationName": "s3objectKey" }, "ProgressPercentage": { "shape": "Integer", "documentation": "The progress of the task as a percentage.
", "locationName": "progressPercentage" }, "StoreTaskState": { "shape": "String", "documentation": "The state of the store task (InProgress, Completed, or Failed).
If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.
The information about the AMI store task, including the progress of the task.
" }, "StoreImageTaskResultSet": { "type": "list", "member": { "shape": "StoreImageTaskResult", "locationName": "item" } }, "String": { "type": "string" }, "StringList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "StringType": { "type": "string", "max": 64000, "min": 0 }, "Subnet": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone of the subnet.
", "locationName": "availabilityZone" }, "AvailabilityZoneId": { "shape": "String", "documentation": "The AZ ID of the subnet.
", "locationName": "availabilityZoneId" }, "AvailableIpAddressCount": { "shape": "Integer", "documentation": "The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
", "locationName": "availableIpAddressCount" }, "CidrBlock": { "shape": "String", "documentation": "The IPv4 CIDR block assigned to the subnet.
", "locationName": "cidrBlock" }, "DefaultForAz": { "shape": "Boolean", "documentation": "Indicates whether this is the default subnet for the Availability Zone.
", "locationName": "defaultForAz" }, "EnableLniAtDeviceIndex": { "shape": "Integer", "documentation": " Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
Indicates whether instances launched in this subnet receive a public IPv4 address.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
", "locationName": "mapPublicIpOnLaunch" }, "MapCustomerOwnedIpOnLaunch": { "shape": "Boolean", "documentation": "Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
", "locationName": "mapCustomerOwnedIpOnLaunch" }, "CustomerOwnedIpv4Pool": { "shape": "CoipPoolId", "documentation": "The customer-owned IPv4 address pool associated with the subnet.
", "locationName": "customerOwnedIpv4Pool" }, "State": { "shape": "SubnetState", "documentation": "The current state of the subnet.
", "locationName": "state" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC the subnet is in.
", "locationName": "vpcId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the subnet.
", "locationName": "ownerId" }, "AssignIpv6AddressOnCreation": { "shape": "Boolean", "documentation": "Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
", "locationName": "assignIpv6AddressOnCreation" }, "Ipv6CidrBlockAssociationSet": { "shape": "SubnetIpv6CidrBlockAssociationSet", "documentation": "Information about the IPv6 CIDR blocks associated with the subnet.
", "locationName": "ipv6CidrBlockAssociationSet" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the subnet.
", "locationName": "tagSet" }, "SubnetArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the subnet.
", "locationName": "subnetArn" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", "locationName": "outpostArn" }, "EnableDns64": { "shape": "Boolean", "documentation": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
", "locationName": "enableDns64" }, "Ipv6Native": { "shape": "Boolean", "documentation": "Indicates whether this is an IPv6 only subnet.
", "locationName": "ipv6Native" }, "PrivateDnsNameOptionsOnLaunch": { "shape": "PrivateDnsNameOptionsOnLaunch", "documentation": "The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
", "locationName": "privateDnsNameOptionsOnLaunch" } }, "documentation": "Describes a subnet.
" }, "SubnetAssociation": { "type": "structure", "members": { "SubnetId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "State": { "shape": "TransitGatewayMulitcastDomainAssociationState", "documentation": "The state of the subnet association.
", "locationName": "state" } }, "documentation": "Describes the subnet association with the transit gateway multicast domain.
" }, "SubnetAssociationList": { "type": "list", "member": { "shape": "SubnetAssociation", "locationName": "item" } }, "SubnetCidrAssociationId": { "type": "string" }, "SubnetCidrBlockState": { "type": "structure", "members": { "State": { "shape": "SubnetCidrBlockStateCode", "documentation": "The state of a CIDR block.
", "locationName": "state" }, "StatusMessage": { "shape": "String", "documentation": "A message about the status of the CIDR block, if applicable.
", "locationName": "statusMessage" } }, "documentation": "Describes the state of a CIDR block.
" }, "SubnetCidrBlockStateCode": { "type": "string", "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ] }, "SubnetCidrReservation": { "type": "structure", "members": { "SubnetCidrReservationId": { "shape": "SubnetCidrReservationId", "documentation": "The ID of the subnet CIDR reservation.
", "locationName": "subnetCidrReservationId" }, "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "Cidr": { "shape": "String", "documentation": "The CIDR that has been reserved.
", "locationName": "cidr" }, "ReservationType": { "shape": "SubnetCidrReservationType", "documentation": "The type of reservation.
", "locationName": "reservationType" }, "OwnerId": { "shape": "String", "documentation": "The ID of the account that owns the subnet CIDR reservation.
", "locationName": "ownerId" }, "Description": { "shape": "String", "documentation": "The description assigned to the subnet CIDR reservation.
", "locationName": "description" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the subnet CIDR reservation.
", "locationName": "tagSet" } }, "documentation": "Describes a subnet CIDR reservation.
" }, "SubnetCidrReservationId": { "type": "string" }, "SubnetCidrReservationList": { "type": "list", "member": { "shape": "SubnetCidrReservation", "locationName": "item" } }, "SubnetCidrReservationType": { "type": "string", "enum": [ "prefix", "explicit" ] }, "SubnetConfiguration": { "type": "structure", "members": { "SubnetId": { "shape": "SubnetId", "documentation": "The ID of the subnet.
" }, "Ipv4": { "shape": "String", "documentation": "The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4.
If you specify an IPv4 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint.
" }, "Ipv6": { "shape": "String", "documentation": "The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6.
If you specify an IPv6 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint.
" } }, "documentation": "Describes the configuration of a subnet for a VPC endpoint.
" }, "SubnetConfigurationsList": { "type": "list", "member": { "shape": "SubnetConfiguration", "locationName": "item" } }, "SubnetId": { "type": "string" }, "SubnetIdStringList": { "type": "list", "member": { "shape": "SubnetId", "locationName": "SubnetId" } }, "SubnetIpv6CidrBlockAssociation": { "type": "structure", "members": { "AssociationId": { "shape": "SubnetCidrAssociationId", "documentation": "The ID of the association.
", "locationName": "associationId" }, "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 CIDR block.
", "locationName": "ipv6CidrBlock" }, "Ipv6CidrBlockState": { "shape": "SubnetCidrBlockState", "documentation": "The state of the CIDR block.
", "locationName": "ipv6CidrBlockState" } }, "documentation": "Describes an association between a subnet and an IPv6 CIDR block.
" }, "SubnetIpv6CidrBlockAssociationSet": { "type": "list", "member": { "shape": "SubnetIpv6CidrBlockAssociation", "locationName": "item" } }, "SubnetList": { "type": "list", "member": { "shape": "Subnet", "locationName": "item" } }, "SubnetState": { "type": "string", "enum": [ "pending", "available", "unavailable" ] }, "Subscription": { "type": "structure", "members": { "Source": { "shape": "String", "documentation": "The Region or Availability Zone that's the source for the subscription. For example, us-east-1.
The Region or Availability Zone that's the target for the subscription. For example, eu-west-1.
The metric used for the subscription.
", "locationName": "metric" }, "Statistic": { "shape": "StatisticType", "documentation": "The statistic used for the subscription.
", "locationName": "statistic" }, "Period": { "shape": "PeriodType", "documentation": "The data aggregation time for the subscription.
", "locationName": "period" } }, "documentation": "Describes an Infrastructure Performance subscription.
" }, "SubscriptionList": { "type": "list", "member": { "shape": "Subscription", "locationName": "item" } }, "SuccessfulInstanceCreditSpecificationItem": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" } }, "documentation": "Describes the burstable performance instance whose credit option for CPU usage was successfully modified.
" }, "SuccessfulInstanceCreditSpecificationSet": { "type": "list", "member": { "shape": "SuccessfulInstanceCreditSpecificationItem", "locationName": "item" } }, "SuccessfulQueuedPurchaseDeletion": { "type": "structure", "members": { "ReservedInstancesId": { "shape": "String", "documentation": "The ID of the Reserved Instance.
", "locationName": "reservedInstancesId" } }, "documentation": "Describes a Reserved Instance whose queued purchase was successfully deleted.
" }, "SuccessfulQueuedPurchaseDeletionSet": { "type": "list", "member": { "shape": "SuccessfulQueuedPurchaseDeletion", "locationName": "item" } }, "SummaryStatus": { "type": "string", "enum": [ "ok", "impaired", "insufficient-data", "not-applicable", "initializing" ] }, "SupportedAdditionalProcessorFeature": { "type": "string", "enum": [ "amd-sev-snp" ] }, "SupportedAdditionalProcessorFeatureList": { "type": "list", "member": { "shape": "SupportedAdditionalProcessorFeature", "locationName": "item" } }, "SupportedIpAddressTypes": { "type": "list", "member": { "shape": "ServiceConnectivityType", "locationName": "item" }, "max": 2, "min": 0 }, "Tag": { "type": "structure", "members": { "Key": { "shape": "String", "documentation": "The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
", "locationName": "value" } }, "documentation": "Describes a tag.
" }, "TagDescription": { "type": "structure", "members": { "Key": { "shape": "String", "documentation": "The tag key.
", "locationName": "key" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "ResourceType", "documentation": "The resource type.
", "locationName": "resourceType" }, "Value": { "shape": "String", "documentation": "The tag value.
", "locationName": "value" } }, "documentation": "Describes a tag.
" }, "TagDescriptionList": { "type": "list", "member": { "shape": "TagDescription", "locationName": "item" } }, "TagList": { "type": "list", "member": { "shape": "Tag", "locationName": "item" } }, "TagSpecification": { "type": "structure", "members": { "ResourceType": { "shape": "ResourceType", "documentation": "The type of resource to tag on creation.
", "locationName": "resourceType" }, "Tags": { "shape": "TagList", "documentation": "The tags to apply to the resource.
", "locationName": "Tag" } }, "documentation": "The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
The number of units to request, filled the default target capacity type.
", "locationName": "totalTargetCapacity" }, "OnDemandTargetCapacity": { "shape": "Integer", "documentation": "The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.
", "locationName": "onDemandTargetCapacity" }, "SpotTargetCapacity": { "shape": "Integer", "documentation": "The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.
", "locationName": "spotTargetCapacity" }, "DefaultTargetCapacityType": { "shape": "DefaultTargetCapacityType", "documentation": "The default target capacity type.
", "locationName": "defaultTargetCapacityType" }, "TargetCapacityUnitType": { "shape": "TargetCapacityUnitType", "documentation": "The unit for the target capacity.
", "locationName": "targetCapacityUnitType" } }, "documentation": "The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions.
The number of units to request, filled using the default target capacity type.
" }, "OnDemandTargetCapacity": { "shape": "Integer", "documentation": "The number of On-Demand units to request.
" }, "SpotTargetCapacity": { "shape": "Integer", "documentation": "The number of Spot units to request.
" }, "DefaultTargetCapacityType": { "shape": "DefaultTargetCapacityType", "documentation": "The default target capacity type.
" }, "TargetCapacityUnitType": { "shape": "TargetCapacityUnitType", "documentation": "The unit for the target capacity. You can specify this parameter only when using attributed-based instance type selection.
Default: units (the number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn't met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
", "locationName": "instanceCount" }, "OfferingId": { "shape": "String", "documentation": "The ID of the Convertible Reserved Instance offering.
", "locationName": "offeringId" } }, "documentation": "Information about the Convertible Reserved Instance offering.
" }, "TargetConfigurationRequest": { "type": "structure", "required": [ "OfferingId" ], "members": { "InstanceCount": { "shape": "Integer", "documentation": "The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
" }, "OfferingId": { "shape": "ReservedInstancesOfferingId", "documentation": "The Convertible Reserved Instance offering ID.
" } }, "documentation": "Details about the target configuration.
" }, "TargetConfigurationRequestSet": { "type": "list", "member": { "shape": "TargetConfigurationRequest", "locationName": "TargetConfigurationRequest" } }, "TargetGroup": { "type": "structure", "members": { "Arn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the target group.
", "locationName": "arn" } }, "documentation": "Describes a load balancer target group.
" }, "TargetGroups": { "type": "list", "member": { "shape": "TargetGroup", "locationName": "item" }, "max": 5, "min": 1 }, "TargetGroupsConfig": { "type": "structure", "members": { "TargetGroups": { "shape": "TargetGroups", "documentation": "One or more target groups.
", "locationName": "targetGroups" } }, "documentation": "Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.
" }, "TargetNetwork": { "type": "structure", "members": { "AssociationId": { "shape": "String", "documentation": "The ID of the association.
", "locationName": "associationId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC in which the target network (subnet) is located.
", "locationName": "vpcId" }, "TargetNetworkId": { "shape": "String", "documentation": "The ID of the subnet specified as the target network.
", "locationName": "targetNetworkId" }, "ClientVpnEndpointId": { "shape": "String", "documentation": "The ID of the Client VPN endpoint with which the target network is associated.
", "locationName": "clientVpnEndpointId" }, "Status": { "shape": "AssociationStatus", "documentation": "The current state of the target network association.
", "locationName": "status" }, "SecurityGroups": { "shape": "ValueStringList", "documentation": "The IDs of the security groups applied to the target network association.
", "locationName": "securityGroups" } }, "documentation": "Describes a target network associated with a Client VPN endpoint.
" }, "TargetNetworkSet": { "type": "list", "member": { "shape": "TargetNetwork", "locationName": "item" } }, "TargetReservationValue": { "type": "structure", "members": { "ReservationValue": { "shape": "ReservationValue", "documentation": "The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.
", "locationName": "reservationValue" }, "TargetConfiguration": { "shape": "TargetConfiguration", "documentation": "The configuration of the Convertible Reserved Instances that make up the exchange.
", "locationName": "targetConfiguration" } }, "documentation": "The total value of the new Convertible Reserved Instances.
" }, "TargetReservationValueSet": { "type": "list", "member": { "shape": "TargetReservationValue", "locationName": "item" } }, "TargetStorageTier": { "type": "string", "enum": [ "archive" ] }, "TelemetryStatus": { "type": "string", "enum": [ "UP", "DOWN" ] }, "Tenancy": { "type": "string", "enum": [ "default", "dedicated", "host" ] }, "TerminateClientVpnConnectionsRequest": { "type": "structure", "required": [ "ClientVpnEndpointId" ], "members": { "ClientVpnEndpointId": { "shape": "ClientVpnEndpointId", "documentation": "The ID of the Client VPN endpoint to which the client is connected.
" }, "ConnectionId": { "shape": "String", "documentation": "The ID of the client connection to be terminated.
" }, "Username": { "shape": "String", "documentation": "The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the Client VPN endpoint.
", "locationName": "clientVpnEndpointId" }, "Username": { "shape": "String", "documentation": "The user who established the terminated client connections.
", "locationName": "username" }, "ConnectionStatuses": { "shape": "TerminateConnectionStatusSet", "documentation": "The current state of the client connections.
", "locationName": "connectionStatuses" } } }, "TerminateConnectionStatus": { "type": "structure", "members": { "ConnectionId": { "shape": "String", "documentation": "The ID of the client connection.
", "locationName": "connectionId" }, "PreviousStatus": { "shape": "ClientVpnConnectionStatus", "documentation": "The state of the client connection.
", "locationName": "previousStatus" }, "CurrentStatus": { "shape": "ClientVpnConnectionStatus", "documentation": "A message about the status of the client connection, if applicable.
", "locationName": "currentStatus" } }, "documentation": "Information about a terminated Client VPN endpoint client connection.
" }, "TerminateConnectionStatusSet": { "type": "list", "member": { "shape": "TerminateConnectionStatus", "locationName": "item" } }, "TerminateInstancesRequest": { "type": "structure", "required": [ "InstanceIds" ], "members": { "InstanceIds": { "shape": "InstanceIdStringList", "documentation": "The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
", "locationName": "InstanceId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the terminated instances.
", "locationName": "instancesSet" } } }, "ThreadsPerCore": { "type": "integer" }, "ThreadsPerCoreList": { "type": "list", "member": { "shape": "ThreadsPerCore", "locationName": "item" } }, "ThroughResourcesStatement": { "type": "structure", "members": { "ResourceStatement": { "shape": "ResourceStatement", "documentation": "The resource statement.
", "locationName": "resourceStatement" } }, "documentation": "Describes a through resource statement.
" }, "ThroughResourcesStatementList": { "type": "list", "member": { "shape": "ThroughResourcesStatement", "locationName": "item" } }, "ThroughResourcesStatementRequest": { "type": "structure", "members": { "ResourceStatement": { "shape": "ResourceStatementRequest", "documentation": "The resource statement.
" } }, "documentation": "Describes a through resource statement.
" }, "ThroughResourcesStatementRequestList": { "type": "list", "member": { "shape": "ThroughResourcesStatementRequest", "locationName": "item" } }, "TieringOperationStatus": { "type": "string", "enum": [ "archival-in-progress", "archival-completed", "archival-failed", "temporary-restore-in-progress", "temporary-restore-completed", "temporary-restore-failed", "permanent-restore-in-progress", "permanent-restore-completed", "permanent-restore-failed" ] }, "TotalLocalStorageGB": { "type": "structure", "members": { "Min": { "shape": "Double", "documentation": "The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.
", "locationName": "min" }, "Max": { "shape": "Double", "documentation": "The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum amount of total local storage, in GB.
" }, "TotalLocalStorageGBRequest": { "type": "structure", "members": { "Min": { "shape": "Double", "documentation": "The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
" }, "Max": { "shape": "Double", "documentation": "The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
" } }, "documentation": "The minimum and maximum amount of total local storage, in GB.
" }, "TotalMediaMemory": { "type": "integer" }, "TotalNeuronMemory": { "type": "integer" }, "TpmSupportValues": { "type": "string", "enum": [ "v2.0" ] }, "TrafficDirection": { "type": "string", "enum": [ "ingress", "egress" ] }, "TrafficMirrorFilter": { "type": "structure", "members": { "TrafficMirrorFilterId": { "shape": "String", "documentation": "The ID of the Traffic Mirror filter.
", "locationName": "trafficMirrorFilterId" }, "IngressFilterRules": { "shape": "TrafficMirrorFilterRuleList", "documentation": "Information about the ingress rules that are associated with the Traffic Mirror filter.
", "locationName": "ingressFilterRuleSet" }, "EgressFilterRules": { "shape": "TrafficMirrorFilterRuleList", "documentation": "Information about the egress rules that are associated with the Traffic Mirror filter.
", "locationName": "egressFilterRuleSet" }, "NetworkServices": { "shape": "TrafficMirrorNetworkServiceList", "documentation": "The network service traffic that is associated with the Traffic Mirror filter.
", "locationName": "networkServiceSet" }, "Description": { "shape": "String", "documentation": "The description of the Traffic Mirror filter.
", "locationName": "description" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the Traffic Mirror filter.
", "locationName": "tagSet" } }, "documentation": "Describes the Traffic Mirror filter.
" }, "TrafficMirrorFilterId": { "type": "string" }, "TrafficMirrorFilterIdList": { "type": "list", "member": { "shape": "TrafficMirrorFilterId", "locationName": "item" } }, "TrafficMirrorFilterRule": { "type": "structure", "members": { "TrafficMirrorFilterRuleId": { "shape": "String", "documentation": "The ID of the Traffic Mirror rule.
", "locationName": "trafficMirrorFilterRuleId" }, "TrafficMirrorFilterId": { "shape": "String", "documentation": "The ID of the Traffic Mirror filter that the rule is associated with.
", "locationName": "trafficMirrorFilterId" }, "TrafficDirection": { "shape": "TrafficDirection", "documentation": "The traffic direction assigned to the Traffic Mirror rule.
", "locationName": "trafficDirection" }, "RuleNumber": { "shape": "Integer", "documentation": "The rule number of the Traffic Mirror rule.
", "locationName": "ruleNumber" }, "RuleAction": { "shape": "TrafficMirrorRuleAction", "documentation": "The action assigned to the Traffic Mirror rule.
", "locationName": "ruleAction" }, "Protocol": { "shape": "Integer", "documentation": "The protocol assigned to the Traffic Mirror rule.
", "locationName": "protocol" }, "DestinationPortRange": { "shape": "TrafficMirrorPortRange", "documentation": "The destination port range assigned to the Traffic Mirror rule.
", "locationName": "destinationPortRange" }, "SourcePortRange": { "shape": "TrafficMirrorPortRange", "documentation": "The source port range assigned to the Traffic Mirror rule.
", "locationName": "sourcePortRange" }, "DestinationCidrBlock": { "shape": "String", "documentation": "The destination CIDR block assigned to the Traffic Mirror rule.
", "locationName": "destinationCidrBlock" }, "SourceCidrBlock": { "shape": "String", "documentation": "The source CIDR block assigned to the Traffic Mirror rule.
", "locationName": "sourceCidrBlock" }, "Description": { "shape": "String", "documentation": "The description of the Traffic Mirror rule.
", "locationName": "description" } }, "documentation": "Describes the Traffic Mirror rule.
" }, "TrafficMirrorFilterRuleField": { "type": "string", "enum": [ "destination-port-range", "source-port-range", "protocol", "description" ] }, "TrafficMirrorFilterRuleFieldList": { "type": "list", "member": { "shape": "TrafficMirrorFilterRuleField" } }, "TrafficMirrorFilterRuleIdWithResolver": { "type": "string" }, "TrafficMirrorFilterRuleList": { "type": "list", "member": { "shape": "TrafficMirrorFilterRule", "locationName": "item" } }, "TrafficMirrorFilterSet": { "type": "list", "member": { "shape": "TrafficMirrorFilter", "locationName": "item" } }, "TrafficMirrorNetworkService": { "type": "string", "enum": [ "amazon-dns" ] }, "TrafficMirrorNetworkServiceList": { "type": "list", "member": { "shape": "TrafficMirrorNetworkService", "locationName": "item" } }, "TrafficMirrorPortRange": { "type": "structure", "members": { "FromPort": { "shape": "Integer", "documentation": "The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
", "locationName": "fromPort" }, "ToPort": { "shape": "Integer", "documentation": "The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
", "locationName": "toPort" } }, "documentation": "Describes the Traffic Mirror port range.
" }, "TrafficMirrorPortRangeRequest": { "type": "structure", "members": { "FromPort": { "shape": "Integer", "documentation": "The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
" }, "ToPort": { "shape": "Integer", "documentation": "The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
" } }, "documentation": "Information about the Traffic Mirror filter rule port range.
" }, "TrafficMirrorRuleAction": { "type": "string", "enum": [ "accept", "reject" ] }, "TrafficMirrorSession": { "type": "structure", "members": { "TrafficMirrorSessionId": { "shape": "String", "documentation": "The ID for the Traffic Mirror session.
", "locationName": "trafficMirrorSessionId" }, "TrafficMirrorTargetId": { "shape": "String", "documentation": "The ID of the Traffic Mirror target.
", "locationName": "trafficMirrorTargetId" }, "TrafficMirrorFilterId": { "shape": "String", "documentation": "The ID of the Traffic Mirror filter.
", "locationName": "trafficMirrorFilterId" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the Traffic Mirror session's network interface.
", "locationName": "networkInterfaceId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the account that owns the Traffic Mirror session.
", "locationName": "ownerId" }, "PacketLength": { "shape": "Integer", "documentation": "The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet
", "locationName": "packetLength" }, "SessionNumber": { "shape": "Integer", "documentation": "The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
", "locationName": "sessionNumber" }, "VirtualNetworkId": { "shape": "Integer", "documentation": "The virtual network ID associated with the Traffic Mirror session.
", "locationName": "virtualNetworkId" }, "Description": { "shape": "String", "documentation": "The description of the Traffic Mirror session.
", "locationName": "description" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the Traffic Mirror session.
", "locationName": "tagSet" } }, "documentation": "Describes a Traffic Mirror session.
" }, "TrafficMirrorSessionField": { "type": "string", "enum": [ "packet-length", "description", "virtual-network-id" ] }, "TrafficMirrorSessionFieldList": { "type": "list", "member": { "shape": "TrafficMirrorSessionField" } }, "TrafficMirrorSessionId": { "type": "string" }, "TrafficMirrorSessionIdList": { "type": "list", "member": { "shape": "TrafficMirrorSessionId", "locationName": "item" } }, "TrafficMirrorSessionSet": { "type": "list", "member": { "shape": "TrafficMirrorSession", "locationName": "item" } }, "TrafficMirrorTarget": { "type": "structure", "members": { "TrafficMirrorTargetId": { "shape": "String", "documentation": "The ID of the Traffic Mirror target.
", "locationName": "trafficMirrorTargetId" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The network interface ID that is attached to the target.
", "locationName": "networkInterfaceId" }, "NetworkLoadBalancerArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Network Load Balancer.
", "locationName": "networkLoadBalancerArn" }, "Type": { "shape": "TrafficMirrorTargetType", "documentation": "The type of Traffic Mirror target.
", "locationName": "type" }, "Description": { "shape": "String", "documentation": "Information about the Traffic Mirror target.
", "locationName": "description" }, "OwnerId": { "shape": "String", "documentation": "The ID of the account that owns the Traffic Mirror target.
", "locationName": "ownerId" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the Traffic Mirror target.
", "locationName": "tagSet" }, "GatewayLoadBalancerEndpointId": { "shape": "String", "documentation": "The ID of the Gateway Load Balancer endpoint.
", "locationName": "gatewayLoadBalancerEndpointId" } }, "documentation": "Describes a Traffic Mirror target.
" }, "TrafficMirrorTargetId": { "type": "string" }, "TrafficMirrorTargetIdList": { "type": "list", "member": { "shape": "TrafficMirrorTargetId", "locationName": "item" } }, "TrafficMirrorTargetSet": { "type": "list", "member": { "shape": "TrafficMirrorTarget", "locationName": "item" } }, "TrafficMirrorTargetType": { "type": "string", "enum": [ "network-interface", "network-load-balancer", "gateway-load-balancer-endpoint" ] }, "TrafficMirroringMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "TrafficType": { "type": "string", "enum": [ "ACCEPT", "REJECT", "ALL" ] }, "TransitAssociationGatewayId": { "type": "string" }, "TransitGateway": { "type": "structure", "members": { "TransitGatewayId": { "shape": "String", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "TransitGatewayArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the transit gateway.
", "locationName": "transitGatewayArn" }, "State": { "shape": "TransitGatewayState", "documentation": "The state of the transit gateway.
", "locationName": "state" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the transit gateway.
", "locationName": "ownerId" }, "Description": { "shape": "String", "documentation": "The description of the transit gateway.
", "locationName": "description" }, "CreationTime": { "shape": "DateTime", "documentation": "The creation time.
", "locationName": "creationTime" }, "Options": { "shape": "TransitGatewayOptions", "documentation": "The transit gateway options.
", "locationName": "options" }, "Tags": { "shape": "TagList", "documentation": "The tags for the transit gateway.
", "locationName": "tagSet" } }, "documentation": "Describes a transit gateway.
" }, "TransitGatewayAssociation": { "type": "structure", "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
", "locationName": "transitGatewayRouteTableId" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The resource type. Note that the tgw-peering resource type has been deprecated.
The state of the association.
", "locationName": "state" } }, "documentation": "Describes an association between a resource attachment and a transit gateway route table.
" }, "TransitGatewayAssociationState": { "type": "string", "enum": [ "associating", "associated", "disassociating", "disassociated" ] }, "TransitGatewayAttachment": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the attachment.
", "locationName": "transitGatewayAttachmentId" }, "TransitGatewayId": { "shape": "String", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "TransitGatewayOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the transit gateway.
", "locationName": "transitGatewayOwnerId" }, "ResourceOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the resource.
", "locationName": "resourceOwnerId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The resource type. Note that the tgw-peering resource type has been deprecated.
The ID of the resource.
", "locationName": "resourceId" }, "State": { "shape": "TransitGatewayAttachmentState", "documentation": "The attachment state. Note that the initiating state has been deprecated.
The association.
", "locationName": "association" }, "CreationTime": { "shape": "DateTime", "documentation": "The creation time.
", "locationName": "creationTime" }, "Tags": { "shape": "TagList", "documentation": "The tags for the attachment.
", "locationName": "tagSet" } }, "documentation": "Describes an attachment between a resource and a transit gateway.
" }, "TransitGatewayAttachmentAssociation": { "type": "structure", "members": { "TransitGatewayRouteTableId": { "shape": "String", "documentation": "The ID of the route table for the transit gateway.
", "locationName": "transitGatewayRouteTableId" }, "State": { "shape": "TransitGatewayAssociationState", "documentation": "The state of the association.
", "locationName": "state" } }, "documentation": "Describes an association.
" }, "TransitGatewayAttachmentBgpConfiguration": { "type": "structure", "members": { "TransitGatewayAsn": { "shape": "Long", "documentation": "The transit gateway Autonomous System Number (ASN).
", "locationName": "transitGatewayAsn" }, "PeerAsn": { "shape": "Long", "documentation": "The peer Autonomous System Number (ASN).
", "locationName": "peerAsn" }, "TransitGatewayAddress": { "shape": "String", "documentation": "The interior BGP peer IP address for the transit gateway.
", "locationName": "transitGatewayAddress" }, "PeerAddress": { "shape": "String", "documentation": "The interior BGP peer IP address for the appliance.
", "locationName": "peerAddress" }, "BgpStatus": { "shape": "BgpStatus", "documentation": "The BGP status.
", "locationName": "bgpStatus" } }, "documentation": "The BGP configuration information.
" }, "TransitGatewayAttachmentBgpConfigurationList": { "type": "list", "member": { "shape": "TransitGatewayAttachmentBgpConfiguration", "locationName": "item" } }, "TransitGatewayAttachmentId": { "type": "string" }, "TransitGatewayAttachmentIdStringList": { "type": "list", "member": { "shape": "TransitGatewayAttachmentId" } }, "TransitGatewayAttachmentList": { "type": "list", "member": { "shape": "TransitGatewayAttachment", "locationName": "item" } }, "TransitGatewayAttachmentPropagation": { "type": "structure", "members": { "TransitGatewayRouteTableId": { "shape": "String", "documentation": "The ID of the propagation route table.
", "locationName": "transitGatewayRouteTableId" }, "State": { "shape": "TransitGatewayPropagationState", "documentation": "The state of the propagation route table.
", "locationName": "state" } }, "documentation": "Describes a propagation route table.
" }, "TransitGatewayAttachmentPropagationList": { "type": "list", "member": { "shape": "TransitGatewayAttachmentPropagation", "locationName": "item" } }, "TransitGatewayAttachmentResourceType": { "type": "string", "enum": [ "vpc", "vpn", "direct-connect-gateway", "connect", "peering", "tgw-peering" ] }, "TransitGatewayAttachmentState": { "type": "string", "enum": [ "initiating", "initiatingRequest", "pendingAcceptance", "rollingBack", "pending", "available", "modifying", "deleting", "deleted", "failed", "rejected", "rejecting", "failing" ] }, "TransitGatewayCidrBlockStringList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "TransitGatewayConnect": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the Connect attachment.
", "locationName": "transitGatewayAttachmentId" }, "TransportTransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment from which the Connect attachment was created.
", "locationName": "transportTransitGatewayAttachmentId" }, "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "State": { "shape": "TransitGatewayAttachmentState", "documentation": "The state of the attachment.
", "locationName": "state" }, "CreationTime": { "shape": "DateTime", "documentation": "The creation time.
", "locationName": "creationTime" }, "Options": { "shape": "TransitGatewayConnectOptions", "documentation": "The Connect attachment options.
", "locationName": "options" }, "Tags": { "shape": "TagList", "documentation": "The tags for the attachment.
", "locationName": "tagSet" } }, "documentation": "Describes a transit gateway Connect attachment.
" }, "TransitGatewayConnectList": { "type": "list", "member": { "shape": "TransitGatewayConnect", "locationName": "item" } }, "TransitGatewayConnectOptions": { "type": "structure", "members": { "Protocol": { "shape": "ProtocolValue", "documentation": "The tunnel protocol.
", "locationName": "protocol" } }, "documentation": "Describes the Connect attachment options.
" }, "TransitGatewayConnectPeer": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the Connect attachment.
", "locationName": "transitGatewayAttachmentId" }, "TransitGatewayConnectPeerId": { "shape": "TransitGatewayConnectPeerId", "documentation": "The ID of the Connect peer.
", "locationName": "transitGatewayConnectPeerId" }, "State": { "shape": "TransitGatewayConnectPeerState", "documentation": "The state of the Connect peer.
", "locationName": "state" }, "CreationTime": { "shape": "DateTime", "documentation": "The creation time.
", "locationName": "creationTime" }, "ConnectPeerConfiguration": { "shape": "TransitGatewayConnectPeerConfiguration", "documentation": "The Connect peer details.
", "locationName": "connectPeerConfiguration" }, "Tags": { "shape": "TagList", "documentation": "The tags for the Connect peer.
", "locationName": "tagSet" } }, "documentation": "Describes a transit gateway Connect peer.
" }, "TransitGatewayConnectPeerConfiguration": { "type": "structure", "members": { "TransitGatewayAddress": { "shape": "String", "documentation": "The Connect peer IP address on the transit gateway side of the tunnel.
", "locationName": "transitGatewayAddress" }, "PeerAddress": { "shape": "String", "documentation": "The Connect peer IP address on the appliance side of the tunnel.
", "locationName": "peerAddress" }, "InsideCidrBlocks": { "shape": "InsideCidrBlocksStringList", "documentation": "The range of interior BGP peer IP addresses.
", "locationName": "insideCidrBlocks" }, "Protocol": { "shape": "ProtocolValue", "documentation": "The tunnel protocol.
", "locationName": "protocol" }, "BgpConfigurations": { "shape": "TransitGatewayAttachmentBgpConfigurationList", "documentation": "The BGP configuration details.
", "locationName": "bgpConfigurations" } }, "documentation": "Describes the Connect peer details.
" }, "TransitGatewayConnectPeerId": { "type": "string" }, "TransitGatewayConnectPeerIdStringList": { "type": "list", "member": { "shape": "TransitGatewayConnectPeerId", "locationName": "item" } }, "TransitGatewayConnectPeerList": { "type": "list", "member": { "shape": "TransitGatewayConnectPeer", "locationName": "item" } }, "TransitGatewayConnectPeerState": { "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ] }, "TransitGatewayConnectRequestBgpOptions": { "type": "structure", "members": { "PeerAsn": { "shape": "Long", "documentation": "The peer Autonomous System Number (ASN).
" } }, "documentation": "The BGP options for the Connect attachment.
" }, "TransitGatewayId": { "type": "string" }, "TransitGatewayIdStringList": { "type": "list", "member": { "shape": "TransitGatewayId", "locationName": "item" } }, "TransitGatewayList": { "type": "list", "member": { "shape": "TransitGateway", "locationName": "item" } }, "TransitGatewayMaxResults": { "type": "integer", "max": 1000, "min": 5 }, "TransitGatewayMulitcastDomainAssociationState": { "type": "string", "enum": [ "pendingAcceptance", "associating", "associated", "disassociating", "disassociated", "rejected", "failed" ] }, "TransitGatewayMulticastDeregisteredGroupMembers": { "type": "structure", "members": { "TransitGatewayMulticastDomainId": { "shape": "String", "documentation": "The ID of the transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomainId" }, "DeregisteredNetworkInterfaceIds": { "shape": "ValueStringList", "documentation": "The network interface IDs of the deregistered members.
", "locationName": "deregisteredNetworkInterfaceIds" }, "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
", "locationName": "groupIpAddress" } }, "documentation": "Describes the deregistered transit gateway multicast group members.
" }, "TransitGatewayMulticastDeregisteredGroupSources": { "type": "structure", "members": { "TransitGatewayMulticastDomainId": { "shape": "String", "documentation": "The ID of the transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomainId" }, "DeregisteredNetworkInterfaceIds": { "shape": "ValueStringList", "documentation": "The network interface IDs of the non-registered members.
", "locationName": "deregisteredNetworkInterfaceIds" }, "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
", "locationName": "groupIpAddress" } }, "documentation": "Describes the deregistered transit gateway multicast group sources.
" }, "TransitGatewayMulticastDomain": { "type": "structure", "members": { "TransitGatewayMulticastDomainId": { "shape": "String", "documentation": "The ID of the transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomainId" }, "TransitGatewayId": { "shape": "String", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "TransitGatewayMulticastDomainArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomainArn" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the transit gateway multicast domain.
", "locationName": "ownerId" }, "Options": { "shape": "TransitGatewayMulticastDomainOptions", "documentation": "The options for the transit gateway multicast domain.
", "locationName": "options" }, "State": { "shape": "TransitGatewayMulticastDomainState", "documentation": "The state of the transit gateway multicast domain.
", "locationName": "state" }, "CreationTime": { "shape": "DateTime", "documentation": "The time the transit gateway multicast domain was created.
", "locationName": "creationTime" }, "Tags": { "shape": "TagList", "documentation": "The tags for the transit gateway multicast domain.
", "locationName": "tagSet" } }, "documentation": "Describes the transit gateway multicast domain.
" }, "TransitGatewayMulticastDomainAssociation": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the transit gateway attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The type of resource, for example a VPC attachment.
", "locationName": "resourceType" }, "ResourceOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.
", "locationName": "resourceOwnerId" }, "Subnet": { "shape": "SubnetAssociation", "documentation": "The subnet associated with the transit gateway multicast domain.
", "locationName": "subnet" } }, "documentation": "Describes the resources associated with the transit gateway multicast domain.
" }, "TransitGatewayMulticastDomainAssociationList": { "type": "list", "member": { "shape": "TransitGatewayMulticastDomainAssociation", "locationName": "item" } }, "TransitGatewayMulticastDomainAssociations": { "type": "structure", "members": { "TransitGatewayMulticastDomainId": { "shape": "String", "documentation": "The ID of the transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomainId" }, "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the transit gateway attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The type of resource, for example a VPC attachment.
", "locationName": "resourceType" }, "ResourceOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the resource.
", "locationName": "resourceOwnerId" }, "Subnets": { "shape": "SubnetAssociationList", "documentation": "The subnets associated with the multicast domain.
", "locationName": "subnets" } }, "documentation": "Describes the multicast domain associations.
" }, "TransitGatewayMulticastDomainId": { "type": "string" }, "TransitGatewayMulticastDomainIdStringList": { "type": "list", "member": { "shape": "TransitGatewayMulticastDomainId", "locationName": "item" } }, "TransitGatewayMulticastDomainList": { "type": "list", "member": { "shape": "TransitGatewayMulticastDomain", "locationName": "item" } }, "TransitGatewayMulticastDomainOptions": { "type": "structure", "members": { "Igmpv2Support": { "shape": "Igmpv2SupportValue", "documentation": "Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
", "locationName": "igmpv2Support" }, "StaticSourcesSupport": { "shape": "StaticSourcesSupportValue", "documentation": "Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
", "locationName": "staticSourcesSupport" }, "AutoAcceptSharedAssociations": { "shape": "AutoAcceptSharedAssociationsValue", "documentation": "Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
", "locationName": "autoAcceptSharedAssociations" } }, "documentation": "Describes the options for a transit gateway multicast domain.
" }, "TransitGatewayMulticastDomainState": { "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ] }, "TransitGatewayMulticastGroup": { "type": "structure", "members": { "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
", "locationName": "groupIpAddress" }, "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the transit gateway attachment.
", "locationName": "transitGatewayAttachmentId" }, "SubnetId": { "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The type of resource, for example a VPC attachment.
", "locationName": "resourceType" }, "ResourceOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.
", "locationName": "resourceOwnerId" }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the transit gateway attachment.
", "locationName": "networkInterfaceId" }, "GroupMember": { "shape": "Boolean", "documentation": "Indicates that the resource is a transit gateway multicast group member.
", "locationName": "groupMember" }, "GroupSource": { "shape": "Boolean", "documentation": "Indicates that the resource is a transit gateway multicast group member.
", "locationName": "groupSource" }, "MemberType": { "shape": "MembershipType", "documentation": "The member type (for example, static).
The source type.
", "locationName": "sourceType" } }, "documentation": "Describes the transit gateway multicast group resources.
" }, "TransitGatewayMulticastGroupList": { "type": "list", "member": { "shape": "TransitGatewayMulticastGroup", "locationName": "item" } }, "TransitGatewayMulticastRegisteredGroupMembers": { "type": "structure", "members": { "TransitGatewayMulticastDomainId": { "shape": "String", "documentation": "The ID of the transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomainId" }, "RegisteredNetworkInterfaceIds": { "shape": "ValueStringList", "documentation": "The ID of the registered network interfaces.
", "locationName": "registeredNetworkInterfaceIds" }, "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
", "locationName": "groupIpAddress" } }, "documentation": "Describes the registered transit gateway multicast group members.
" }, "TransitGatewayMulticastRegisteredGroupSources": { "type": "structure", "members": { "TransitGatewayMulticastDomainId": { "shape": "String", "documentation": "The ID of the transit gateway multicast domain.
", "locationName": "transitGatewayMulticastDomainId" }, "RegisteredNetworkInterfaceIds": { "shape": "ValueStringList", "documentation": "The IDs of the network interfaces members registered with the transit gateway multicast group.
", "locationName": "registeredNetworkInterfaceIds" }, "GroupIpAddress": { "shape": "String", "documentation": "The IP address assigned to the transit gateway multicast group.
", "locationName": "groupIpAddress" } }, "documentation": "Describes the members registered with the transit gateway multicast group.
" }, "TransitGatewayNetworkInterfaceIdList": { "type": "list", "member": { "shape": "NetworkInterfaceId", "locationName": "item" } }, "TransitGatewayOptions": { "type": "structure", "members": { "AmazonSideAsn": { "shape": "Long", "documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
", "locationName": "amazonSideAsn" }, "TransitGatewayCidrBlocks": { "shape": "ValueStringList", "documentation": "The transit gateway CIDR blocks.
", "locationName": "transitGatewayCidrBlocks" }, "AutoAcceptSharedAttachments": { "shape": "AutoAcceptSharedAttachmentsValue", "documentation": "Indicates whether attachment requests are automatically accepted.
", "locationName": "autoAcceptSharedAttachments" }, "DefaultRouteTableAssociation": { "shape": "DefaultRouteTableAssociationValue", "documentation": "Indicates whether resource attachments are automatically associated with the default association route table.
", "locationName": "defaultRouteTableAssociation" }, "AssociationDefaultRouteTableId": { "shape": "String", "documentation": "The ID of the default association route table.
", "locationName": "associationDefaultRouteTableId" }, "DefaultRouteTablePropagation": { "shape": "DefaultRouteTablePropagationValue", "documentation": "Indicates whether resource attachments automatically propagate routes to the default propagation route table.
", "locationName": "defaultRouteTablePropagation" }, "PropagationDefaultRouteTableId": { "shape": "String", "documentation": "The ID of the default propagation route table.
", "locationName": "propagationDefaultRouteTableId" }, "VpnEcmpSupport": { "shape": "VpnEcmpSupportValue", "documentation": "Indicates whether Equal Cost Multipath Protocol support is enabled.
", "locationName": "vpnEcmpSupport" }, "DnsSupport": { "shape": "DnsSupportValue", "documentation": "Indicates whether DNS support is enabled.
", "locationName": "dnsSupport" }, "SecurityGroupReferencingSupport": { "shape": "SecurityGroupReferencingSupportValue", "documentation": "This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
", "locationName": "securityGroupReferencingSupport" }, "MulticastSupport": { "shape": "MulticastSupportValue", "documentation": "Indicates whether multicast is enabled on the transit gateway
", "locationName": "multicastSupport" } }, "documentation": "Describes the options for a transit gateway.
" }, "TransitGatewayPeeringAttachment": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the transit gateway peering attachment.
", "locationName": "transitGatewayAttachmentId" }, "AccepterTransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the accepter transit gateway attachment.
", "locationName": "accepterTransitGatewayAttachmentId" }, "RequesterTgwInfo": { "shape": "PeeringTgwInfo", "documentation": "Information about the requester transit gateway.
", "locationName": "requesterTgwInfo" }, "AccepterTgwInfo": { "shape": "PeeringTgwInfo", "documentation": "Information about the accepter transit gateway.
", "locationName": "accepterTgwInfo" }, "Options": { "shape": "TransitGatewayPeeringAttachmentOptions", "documentation": "Details about the transit gateway peering attachment.
", "locationName": "options" }, "Status": { "shape": "PeeringAttachmentStatus", "documentation": "The status of the transit gateway peering attachment.
", "locationName": "status" }, "State": { "shape": "TransitGatewayAttachmentState", "documentation": "The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
The time the transit gateway peering attachment was created.
", "locationName": "creationTime" }, "Tags": { "shape": "TagList", "documentation": "The tags for the transit gateway peering attachment.
", "locationName": "tagSet" } }, "documentation": "Describes the transit gateway peering attachment.
" }, "TransitGatewayPeeringAttachmentList": { "type": "list", "member": { "shape": "TransitGatewayPeeringAttachment", "locationName": "item" } }, "TransitGatewayPeeringAttachmentOptions": { "type": "structure", "members": { "DynamicRouting": { "shape": "DynamicRoutingValue", "documentation": "Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
", "locationName": "dynamicRouting" } }, "documentation": "Describes dynamic routing for the transit gateway peering attachment.
" }, "TransitGatewayPolicyRule": { "type": "structure", "members": { "SourceCidrBlock": { "shape": "String", "documentation": "The source CIDR block for the transit gateway policy rule.
", "locationName": "sourceCidrBlock" }, "SourcePortRange": { "shape": "String", "documentation": "The port range for the transit gateway policy rule. Currently this is set to * (all).
", "locationName": "sourcePortRange" }, "DestinationCidrBlock": { "shape": "String", "documentation": "The destination CIDR block for the transit gateway policy rule.
", "locationName": "destinationCidrBlock" }, "DestinationPortRange": { "shape": "String", "documentation": "The port range for the transit gateway policy rule. Currently this is set to * (all).
", "locationName": "destinationPortRange" }, "Protocol": { "shape": "String", "documentation": "The protocol used by the transit gateway policy rule.
", "locationName": "protocol" }, "MetaData": { "shape": "TransitGatewayPolicyRuleMetaData", "documentation": "The meta data tags used for the transit gateway policy rule.
", "locationName": "metaData" } }, "documentation": "Describes a rule associated with a transit gateway policy.
" }, "TransitGatewayPolicyRuleMetaData": { "type": "structure", "members": { "MetaDataKey": { "shape": "String", "documentation": "The key name for the transit gateway policy rule meta data tag.
", "locationName": "metaDataKey" }, "MetaDataValue": { "shape": "String", "documentation": "The value of the key for the transit gateway policy rule meta data tag.
", "locationName": "metaDataValue" } }, "documentation": "Describes the meta data tags associated with a transit gateway policy rule.
" }, "TransitGatewayPolicyTable": { "type": "structure", "members": { "TransitGatewayPolicyTableId": { "shape": "TransitGatewayPolicyTableId", "documentation": "The ID of the transit gateway policy table.
", "locationName": "transitGatewayPolicyTableId" }, "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "State": { "shape": "TransitGatewayPolicyTableState", "documentation": "The state of the transit gateway policy table
", "locationName": "state" }, "CreationTime": { "shape": "DateTime", "documentation": "The timestamp when the transit gateway policy table was created.
", "locationName": "creationTime" }, "Tags": { "shape": "TagList", "documentation": "he key-value pairs associated with the transit gateway policy table.
", "locationName": "tagSet" } }, "documentation": "Describes a transit gateway policy table.
" }, "TransitGatewayPolicyTableAssociation": { "type": "structure", "members": { "TransitGatewayPolicyTableId": { "shape": "TransitGatewayPolicyTableId", "documentation": "The ID of the transit gateway policy table.
", "locationName": "transitGatewayPolicyTableId" }, "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the transit gateway attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceId": { "shape": "String", "documentation": "The resource ID of the transit gateway attachment.
", "locationName": "resourceId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The resource type for the transit gateway policy table association.
", "locationName": "resourceType" }, "State": { "shape": "TransitGatewayAssociationState", "documentation": "The state of the transit gateway policy table association.
", "locationName": "state" } }, "documentation": "Describes a transit gateway policy table association.
" }, "TransitGatewayPolicyTableAssociationList": { "type": "list", "member": { "shape": "TransitGatewayPolicyTableAssociation", "locationName": "item" } }, "TransitGatewayPolicyTableEntry": { "type": "structure", "members": { "PolicyRuleNumber": { "shape": "String", "documentation": "The rule number for the transit gateway policy table entry.
", "locationName": "policyRuleNumber" }, "PolicyRule": { "shape": "TransitGatewayPolicyRule", "documentation": "The policy rule associated with the transit gateway policy table.
", "locationName": "policyRule" }, "TargetRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the target route table.
", "locationName": "targetRouteTableId" } }, "documentation": "Describes a transit gateway policy table entry
" }, "TransitGatewayPolicyTableEntryList": { "type": "list", "member": { "shape": "TransitGatewayPolicyTableEntry", "locationName": "item" } }, "TransitGatewayPolicyTableId": { "type": "string" }, "TransitGatewayPolicyTableIdStringList": { "type": "list", "member": { "shape": "TransitGatewayPolicyTableId", "locationName": "item" } }, "TransitGatewayPolicyTableList": { "type": "list", "member": { "shape": "TransitGatewayPolicyTable", "locationName": "item" } }, "TransitGatewayPolicyTableState": { "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ] }, "TransitGatewayPrefixListAttachment": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The resource type. Note that the tgw-peering resource type has been deprecated.
The ID of the resource.
", "locationName": "resourceId" } }, "documentation": "Describes a transit gateway prefix list attachment.
" }, "TransitGatewayPrefixListReference": { "type": "structure", "members": { "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
", "locationName": "transitGatewayRouteTableId" }, "PrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list.
", "locationName": "prefixListId" }, "PrefixListOwnerId": { "shape": "String", "documentation": "The ID of the prefix list owner.
", "locationName": "prefixListOwnerId" }, "State": { "shape": "TransitGatewayPrefixListReferenceState", "documentation": "The state of the prefix list reference.
", "locationName": "state" }, "Blackhole": { "shape": "Boolean", "documentation": "Indicates whether traffic that matches this route is dropped.
", "locationName": "blackhole" }, "TransitGatewayAttachment": { "shape": "TransitGatewayPrefixListAttachment", "documentation": "Information about the transit gateway attachment.
", "locationName": "transitGatewayAttachment" } }, "documentation": "Describes a prefix list reference.
" }, "TransitGatewayPrefixListReferenceSet": { "type": "list", "member": { "shape": "TransitGatewayPrefixListReference", "locationName": "item" } }, "TransitGatewayPrefixListReferenceState": { "type": "string", "enum": [ "pending", "available", "modifying", "deleting" ] }, "TransitGatewayPropagation": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The resource type. Note that the tgw-peering resource type has been deprecated.
The ID of the transit gateway route table.
", "locationName": "transitGatewayRouteTableId" }, "State": { "shape": "TransitGatewayPropagationState", "documentation": "The state.
", "locationName": "state" }, "TransitGatewayRouteTableAnnouncementId": { "shape": "TransitGatewayRouteTableAnnouncementId", "documentation": "The ID of the transit gateway route table announcement.
", "locationName": "transitGatewayRouteTableAnnouncementId" } }, "documentation": "Describes route propagation.
" }, "TransitGatewayPropagationState": { "type": "string", "enum": [ "enabling", "enabled", "disabling", "disabled" ] }, "TransitGatewayRequestOptions": { "type": "structure", "members": { "AmazonSideAsn": { "shape": "Long", "documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.
Enable or disable automatic acceptance of attachment requests. Disabled by default.
" }, "DefaultRouteTableAssociation": { "shape": "DefaultRouteTableAssociationValue", "documentation": "Enable or disable automatic association with the default association route table. Enabled by default.
" }, "DefaultRouteTablePropagation": { "shape": "DefaultRouteTablePropagationValue", "documentation": "Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
" }, "VpnEcmpSupport": { "shape": "VpnEcmpSupportValue", "documentation": "Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
" }, "DnsSupport": { "shape": "DnsSupportValue", "documentation": "Enable or disable DNS support. Enabled by default.
" }, "SecurityGroupReferencingSupport": { "shape": "SecurityGroupReferencingSupportValue", "documentation": "This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
" }, "MulticastSupport": { "shape": "MulticastSupportValue", "documentation": "Indicates whether multicast is enabled on the transit gateway
" }, "TransitGatewayCidrBlocks": { "shape": "TransitGatewayCidrBlockStringList", "documentation": "One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
" } }, "documentation": "Describes the options for a transit gateway.
" }, "TransitGatewayRoute": { "type": "structure", "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR block used for destination matches.
", "locationName": "destinationCidrBlock" }, "PrefixListId": { "shape": "PrefixListResourceId", "documentation": "The ID of the prefix list used for destination matches.
", "locationName": "prefixListId" }, "TransitGatewayRouteTableAnnouncementId": { "shape": "TransitGatewayRouteTableAnnouncementId", "documentation": "The ID of the transit gateway route table announcement.
", "locationName": "transitGatewayRouteTableAnnouncementId" }, "TransitGatewayAttachments": { "shape": "TransitGatewayRouteAttachmentList", "documentation": "The attachments.
", "locationName": "transitGatewayAttachments" }, "Type": { "shape": "TransitGatewayRouteType", "documentation": "The route type.
", "locationName": "type" }, "State": { "shape": "TransitGatewayRouteState", "documentation": "The state of the route.
", "locationName": "state" } }, "documentation": "Describes a route for a transit gateway route table.
" }, "TransitGatewayRouteAttachment": { "type": "structure", "members": { "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The resource type. Note that the tgw-peering resource type has been deprecated.
Describes a route attachment.
" }, "TransitGatewayRouteAttachmentList": { "type": "list", "member": { "shape": "TransitGatewayRouteAttachment", "locationName": "item" } }, "TransitGatewayRouteList": { "type": "list", "member": { "shape": "TransitGatewayRoute", "locationName": "item" } }, "TransitGatewayRouteState": { "type": "string", "enum": [ "pending", "active", "blackhole", "deleting", "deleted" ] }, "TransitGatewayRouteTable": { "type": "structure", "members": { "TransitGatewayRouteTableId": { "shape": "String", "documentation": "The ID of the transit gateway route table.
", "locationName": "transitGatewayRouteTableId" }, "TransitGatewayId": { "shape": "String", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "State": { "shape": "TransitGatewayRouteTableState", "documentation": "The state of the transit gateway route table.
", "locationName": "state" }, "DefaultAssociationRouteTable": { "shape": "Boolean", "documentation": "Indicates whether this is the default association route table for the transit gateway.
", "locationName": "defaultAssociationRouteTable" }, "DefaultPropagationRouteTable": { "shape": "Boolean", "documentation": "Indicates whether this is the default propagation route table for the transit gateway.
", "locationName": "defaultPropagationRouteTable" }, "CreationTime": { "shape": "DateTime", "documentation": "The creation time.
", "locationName": "creationTime" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the route table.
", "locationName": "tagSet" } }, "documentation": "Describes a transit gateway route table.
" }, "TransitGatewayRouteTableAnnouncement": { "type": "structure", "members": { "TransitGatewayRouteTableAnnouncementId": { "shape": "TransitGatewayRouteTableAnnouncementId", "documentation": "The ID of the transit gateway route table announcement.
", "locationName": "transitGatewayRouteTableAnnouncementId" }, "TransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "CoreNetworkId": { "shape": "String", "documentation": "The ID of the core network for the transit gateway route table announcement.
", "locationName": "coreNetworkId" }, "PeerTransitGatewayId": { "shape": "TransitGatewayId", "documentation": "The ID of the peer transit gateway.
", "locationName": "peerTransitGatewayId" }, "PeerCoreNetworkId": { "shape": "String", "documentation": "The ID of the core network ID for the peer.
", "locationName": "peerCoreNetworkId" }, "PeeringAttachmentId": { "shape": "TransitGatewayAttachmentId", "documentation": "The ID of the peering attachment.
", "locationName": "peeringAttachmentId" }, "AnnouncementDirection": { "shape": "TransitGatewayRouteTableAnnouncementDirection", "documentation": "The direction for the route table announcement.
", "locationName": "announcementDirection" }, "TransitGatewayRouteTableId": { "shape": "TransitGatewayRouteTableId", "documentation": "The ID of the transit gateway route table.
", "locationName": "transitGatewayRouteTableId" }, "State": { "shape": "TransitGatewayRouteTableAnnouncementState", "documentation": "The state of the transit gateway announcement.
", "locationName": "state" }, "CreationTime": { "shape": "DateTime", "documentation": "The timestamp when the transit gateway route table announcement was created.
", "locationName": "creationTime" }, "Tags": { "shape": "TagList", "documentation": "The key-value pairs associated with the route table announcement.
", "locationName": "tagSet" } }, "documentation": "Describes a transit gateway route table announcement.
" }, "TransitGatewayRouteTableAnnouncementDirection": { "type": "string", "enum": [ "outgoing", "incoming" ] }, "TransitGatewayRouteTableAnnouncementId": { "type": "string" }, "TransitGatewayRouteTableAnnouncementIdStringList": { "type": "list", "member": { "shape": "TransitGatewayRouteTableAnnouncementId", "locationName": "item" } }, "TransitGatewayRouteTableAnnouncementList": { "type": "list", "member": { "shape": "TransitGatewayRouteTableAnnouncement", "locationName": "item" } }, "TransitGatewayRouteTableAnnouncementState": { "type": "string", "enum": [ "available", "pending", "failing", "failed", "deleting", "deleted" ] }, "TransitGatewayRouteTableAssociation": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The resource type. Note that the tgw-peering resource type has been deprecated.
The state of the association.
", "locationName": "state" } }, "documentation": "Describes an association between a route table and a resource attachment.
" }, "TransitGatewayRouteTableAssociationList": { "type": "list", "member": { "shape": "TransitGatewayRouteTableAssociation", "locationName": "item" } }, "TransitGatewayRouteTableId": { "type": "string" }, "TransitGatewayRouteTableIdStringList": { "type": "list", "member": { "shape": "TransitGatewayRouteTableId", "locationName": "item" } }, "TransitGatewayRouteTableList": { "type": "list", "member": { "shape": "TransitGatewayRouteTable", "locationName": "item" } }, "TransitGatewayRouteTablePropagation": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the attachment.
", "locationName": "transitGatewayAttachmentId" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" }, "ResourceType": { "shape": "TransitGatewayAttachmentResourceType", "documentation": "The type of resource. Note that the tgw-peering resource type has been deprecated.
The state of the resource.
", "locationName": "state" }, "TransitGatewayRouteTableAnnouncementId": { "shape": "TransitGatewayRouteTableAnnouncementId", "documentation": "The ID of the transit gateway route table announcement.
", "locationName": "transitGatewayRouteTableAnnouncementId" } }, "documentation": "Describes a route table propagation.
" }, "TransitGatewayRouteTablePropagationList": { "type": "list", "member": { "shape": "TransitGatewayRouteTablePropagation", "locationName": "item" } }, "TransitGatewayRouteTableRoute": { "type": "structure", "members": { "DestinationCidr": { "shape": "String", "documentation": "The CIDR block used for destination matches.
", "locationName": "destinationCidr" }, "State": { "shape": "String", "documentation": "The state of the route.
", "locationName": "state" }, "RouteOrigin": { "shape": "String", "documentation": "The route origin. The following are the possible values:
static
propagated
The ID of the prefix list.
", "locationName": "prefixListId" }, "AttachmentId": { "shape": "String", "documentation": "The ID of the route attachment.
", "locationName": "attachmentId" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource for the route attachment.
", "locationName": "resourceId" }, "ResourceType": { "shape": "String", "documentation": "The resource type for the route attachment.
", "locationName": "resourceType" } }, "documentation": "Describes a route in a transit gateway route table.
" }, "TransitGatewayRouteTableState": { "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ] }, "TransitGatewayRouteType": { "type": "string", "enum": [ "static", "propagated" ] }, "TransitGatewayState": { "type": "string", "enum": [ "pending", "available", "modifying", "deleting", "deleted" ] }, "TransitGatewaySubnetIdList": { "type": "list", "member": { "shape": "SubnetId", "locationName": "item" } }, "TransitGatewayVpcAttachment": { "type": "structure", "members": { "TransitGatewayAttachmentId": { "shape": "String", "documentation": "The ID of the attachment.
", "locationName": "transitGatewayAttachmentId" }, "TransitGatewayId": { "shape": "String", "documentation": "The ID of the transit gateway.
", "locationName": "transitGatewayId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "VpcOwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the VPC.
", "locationName": "vpcOwnerId" }, "State": { "shape": "TransitGatewayAttachmentState", "documentation": "The state of the VPC attachment. Note that the initiating state has been deprecated.
The IDs of the subnets.
", "locationName": "subnetIds" }, "CreationTime": { "shape": "DateTime", "documentation": "The creation time.
", "locationName": "creationTime" }, "Options": { "shape": "TransitGatewayVpcAttachmentOptions", "documentation": "The VPC attachment options.
", "locationName": "options" }, "Tags": { "shape": "TagList", "documentation": "The tags for the VPC attachment.
", "locationName": "tagSet" } }, "documentation": "Describes a VPC attachment.
" }, "TransitGatewayVpcAttachmentList": { "type": "list", "member": { "shape": "TransitGatewayVpcAttachment", "locationName": "item" } }, "TransitGatewayVpcAttachmentOptions": { "type": "structure", "members": { "DnsSupport": { "shape": "DnsSupportValue", "documentation": "Indicates whether DNS support is enabled.
", "locationName": "dnsSupport" }, "SecurityGroupReferencingSupport": { "shape": "SecurityGroupReferencingSupportValue", "documentation": "This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
", "locationName": "securityGroupReferencingSupport" }, "Ipv6Support": { "shape": "Ipv6SupportValue", "documentation": "Indicates whether IPv6 support is disabled.
", "locationName": "ipv6Support" }, "ApplianceModeSupport": { "shape": "ApplianceModeSupportValue", "documentation": "Indicates whether appliance mode support is enabled.
", "locationName": "applianceModeSupport" } }, "documentation": "Describes the VPC attachment options.
" }, "TransportProtocol": { "type": "string", "enum": [ "tcp", "udp" ] }, "TrunkInterfaceAssociation": { "type": "structure", "members": { "AssociationId": { "shape": "TrunkInterfaceAssociationId", "documentation": "The ID of the association.
", "locationName": "associationId" }, "BranchInterfaceId": { "shape": "String", "documentation": "The ID of the branch network interface.
", "locationName": "branchInterfaceId" }, "TrunkInterfaceId": { "shape": "String", "documentation": "The ID of the trunk network interface.
", "locationName": "trunkInterfaceId" }, "InterfaceProtocol": { "shape": "InterfaceProtocolType", "documentation": "The interface protocol. Valid values are VLAN and GRE.
The ID of the VLAN when you use the VLAN protocol.
", "locationName": "vlanId" }, "GreKey": { "shape": "Integer", "documentation": "The application key when you use the GRE protocol.
", "locationName": "greKey" }, "Tags": { "shape": "TagList", "documentation": "The tags for the trunk interface association.
", "locationName": "tagSet" } }, "documentation": "Information about an association between a branch network interface with a trunk network interface.
" }, "TrunkInterfaceAssociationId": { "type": "string" }, "TrunkInterfaceAssociationIdList": { "type": "list", "member": { "shape": "TrunkInterfaceAssociationId", "locationName": "item" } }, "TrunkInterfaceAssociationList": { "type": "list", "member": { "shape": "TrunkInterfaceAssociation", "locationName": "item" } }, "TrustProviderType": { "type": "string", "enum": [ "user", "device" ] }, "TunnelInsideIpVersion": { "type": "string", "enum": [ "ipv4", "ipv6" ] }, "TunnelOption": { "type": "structure", "members": { "OutsideIpAddress": { "shape": "String", "documentation": "The external IP address of the VPN tunnel.
", "locationName": "outsideIpAddress" }, "TunnelInsideCidr": { "shape": "String", "documentation": "The range of inside IPv4 addresses for the tunnel.
", "locationName": "tunnelInsideCidr" }, "TunnelInsideIpv6Cidr": { "shape": "String", "documentation": "The range of inside IPv6 addresses for the tunnel.
", "locationName": "tunnelInsideIpv6Cidr" }, "PreSharedKey": { "shape": "preSharedKey", "documentation": "The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
", "locationName": "preSharedKey" }, "Phase1LifetimeSeconds": { "shape": "Integer", "documentation": "The lifetime for phase 1 of the IKE negotiation, in seconds.
", "locationName": "phase1LifetimeSeconds" }, "Phase2LifetimeSeconds": { "shape": "Integer", "documentation": "The lifetime for phase 2 of the IKE negotiation, in seconds.
", "locationName": "phase2LifetimeSeconds" }, "RekeyMarginTimeSeconds": { "shape": "Integer", "documentation": "The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
", "locationName": "rekeyMarginTimeSeconds" }, "RekeyFuzzPercentage": { "shape": "Integer", "documentation": "The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
The number of packets in an IKE replay window.
", "locationName": "replayWindowSize" }, "DpdTimeoutSeconds": { "shape": "Integer", "documentation": "The number of seconds after which a DPD timeout occurs.
", "locationName": "dpdTimeoutSeconds" }, "DpdTimeoutAction": { "shape": "String", "documentation": "The action to take after a DPD timeout occurs.
", "locationName": "dpdTimeoutAction" }, "Phase1EncryptionAlgorithms": { "shape": "Phase1EncryptionAlgorithmsList", "documentation": "The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
", "locationName": "phase1EncryptionAlgorithmSet" }, "Phase2EncryptionAlgorithms": { "shape": "Phase2EncryptionAlgorithmsList", "documentation": "The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
", "locationName": "phase2EncryptionAlgorithmSet" }, "Phase1IntegrityAlgorithms": { "shape": "Phase1IntegrityAlgorithmsList", "documentation": "The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
", "locationName": "phase1IntegrityAlgorithmSet" }, "Phase2IntegrityAlgorithms": { "shape": "Phase2IntegrityAlgorithmsList", "documentation": "The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
", "locationName": "phase2IntegrityAlgorithmSet" }, "Phase1DHGroupNumbers": { "shape": "Phase1DHGroupNumbersList", "documentation": "The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
", "locationName": "phase1DHGroupNumberSet" }, "Phase2DHGroupNumbers": { "shape": "Phase2DHGroupNumbersList", "documentation": "The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
", "locationName": "phase2DHGroupNumberSet" }, "IkeVersions": { "shape": "IKEVersionsList", "documentation": "The IKE versions that are permitted for the VPN tunnel.
", "locationName": "ikeVersionSet" }, "StartupAction": { "shape": "String", "documentation": "The action to take when the establishing the VPN tunnels for a VPN connection.
", "locationName": "startupAction" }, "LogOptions": { "shape": "VpnTunnelLogOptions", "documentation": "Options for logging VPN tunnel activity.
", "locationName": "logOptions" }, "EnableTunnelLifecycleControl": { "shape": "Boolean", "documentation": "Status of tunnel endpoint lifecycle control feature.
", "locationName": "enableTunnelLifecycleControl" } }, "documentation": "The VPN tunnel options.
" }, "TunnelOptionsList": { "type": "list", "member": { "shape": "TunnelOption", "locationName": "item" } }, "UnassignIpv6AddressesRequest": { "type": "structure", "required": [ "NetworkInterfaceId" ], "members": { "Ipv6Addresses": { "shape": "Ipv6AddressList", "documentation": "The IPv6 addresses to unassign from the network interface.
", "locationName": "ipv6Addresses" }, "Ipv6Prefixes": { "shape": "IpPrefixList", "documentation": "The IPv6 prefixes to unassign from the network interface.
", "locationName": "Ipv6Prefix" }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" } } }, "UnassignIpv6AddressesResult": { "type": "structure", "members": { "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "UnassignedIpv6Addresses": { "shape": "Ipv6AddressList", "documentation": "The IPv6 addresses that have been unassigned from the network interface.
", "locationName": "unassignedIpv6Addresses" }, "UnassignedIpv6Prefixes": { "shape": "IpPrefixList", "documentation": "The IPv4 prefixes that have been unassigned from the network interface.
", "locationName": "unassignedIpv6PrefixSet" } } }, "UnassignPrivateIpAddressesRequest": { "type": "structure", "required": [ "NetworkInterfaceId" ], "members": { "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "PrivateIpAddresses": { "shape": "PrivateIpAddressStringList", "documentation": "The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
", "locationName": "privateIpAddress" }, "Ipv4Prefixes": { "shape": "IpPrefixList", "documentation": "The IPv4 prefixes to unassign from the network interface.
", "locationName": "Ipv4Prefix" } }, "documentation": "Contains the parameters for UnassignPrivateIpAddresses.
" }, "UnassignPrivateNatGatewayAddressRequest": { "type": "structure", "required": [ "NatGatewayId", "PrivateIpAddresses" ], "members": { "NatGatewayId": { "shape": "NatGatewayId", "documentation": "The ID of the NAT gateway.
" }, "PrivateIpAddresses": { "shape": "IpList", "documentation": "The private IPv4 addresses you want to unassign.
", "locationName": "PrivateIpAddress" }, "MaxDrainDurationSeconds": { "shape": "DrainSeconds", "documentation": "The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the NAT gateway.
", "locationName": "natGatewayId" }, "NatGatewayAddresses": { "shape": "NatGatewayAddressList", "documentation": "Information about the NAT gateway IP addresses.
", "locationName": "natGatewayAddressSet" } } }, "UnlimitedSupportedInstanceFamily": { "type": "string", "enum": [ "t2", "t3", "t3a", "t4g" ] }, "UnlockSnapshotRequest": { "type": "structure", "required": [ "SnapshotId" ], "members": { "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot to unlock.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the snapshot.
", "locationName": "snapshotId" } } }, "UnmonitorInstancesRequest": { "type": "structure", "required": [ "InstanceIds" ], "members": { "InstanceIds": { "shape": "InstanceIdStringList", "documentation": "The IDs of the instances.
", "locationName": "InstanceId" }, "DryRun": { "shape": "Boolean", "documentation": "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.
The monitoring information.
", "locationName": "instancesSet" } } }, "UnsuccessfulInstanceCreditSpecificationErrorCode": { "type": "string", "enum": [ "InvalidInstanceID.Malformed", "InvalidInstanceID.NotFound", "IncorrectInstanceState", "InstanceCreditSpecification.NotSupported" ] }, "UnsuccessfulInstanceCreditSpecificationItem": { "type": "structure", "members": { "InstanceId": { "shape": "String", "documentation": "The ID of the instance.
", "locationName": "instanceId" }, "Error": { "shape": "UnsuccessfulInstanceCreditSpecificationItemError", "documentation": "The applicable error for the burstable performance instance whose credit option for CPU usage was not modified.
", "locationName": "error" } }, "documentation": "Describes the burstable performance instance whose credit option for CPU usage was not modified.
" }, "UnsuccessfulInstanceCreditSpecificationItemError": { "type": "structure", "members": { "Code": { "shape": "UnsuccessfulInstanceCreditSpecificationErrorCode", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The applicable error message.
", "locationName": "message" } }, "documentation": "Information about the error for the burstable performance instance whose credit option for CPU usage was not modified.
" }, "UnsuccessfulInstanceCreditSpecificationSet": { "type": "list", "member": { "shape": "UnsuccessfulInstanceCreditSpecificationItem", "locationName": "item" } }, "UnsuccessfulItem": { "type": "structure", "members": { "Error": { "shape": "UnsuccessfulItemError", "documentation": "Information about the error.
", "locationName": "error" }, "ResourceId": { "shape": "String", "documentation": "The ID of the resource.
", "locationName": "resourceId" } }, "documentation": "Information about items that were not successfully processed in a batch call.
" }, "UnsuccessfulItemError": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The error code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The error message accompanying the error code.
", "locationName": "message" } }, "documentation": "Information about the error that occurred. For more information about errors, see Error codes.
" }, "UnsuccessfulItemList": { "type": "list", "member": { "shape": "UnsuccessfulItem", "locationName": "item" } }, "UnsuccessfulItemSet": { "type": "list", "member": { "shape": "UnsuccessfulItem", "locationName": "item" } }, "UpdateSecurityGroupRuleDescriptionsEgressRequest": { "type": "structure", "members": { "DryRun": { "shape": "Boolean", "documentation": "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.
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
" }, "GroupName": { "shape": "SecurityGroupName", "documentation": "[Default VPC] The name of the security group. You must specify either the security group ID or the security group name.
" }, "IpPermissions": { "shape": "IpPermissionList", "documentation": "The IP permissions for the security group rule. You must specify either the IP permissions or the description.
" }, "SecurityGroupRuleDescriptions": { "shape": "SecurityGroupRuleDescriptionList", "documentation": "The description for the egress security group rules. You must specify either the description or the IP permissions.
", "locationName": "SecurityGroupRuleDescription" } } }, "UpdateSecurityGroupRuleDescriptionsEgressResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, returns an error.
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.
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
" }, "GroupName": { "shape": "SecurityGroupName", "documentation": "[Default VPC] The name of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
" }, "IpPermissions": { "shape": "IpPermissionList", "documentation": "The IP permissions for the security group rule. You must specify either IP permissions or a description.
" }, "SecurityGroupRuleDescriptions": { "shape": "SecurityGroupRuleDescriptionList", "documentation": "The description for the ingress security group rules. You must specify either a description or IP permissions.
", "locationName": "SecurityGroupRuleDescription" } } }, "UpdateSecurityGroupRuleDescriptionsIngressResult": { "type": "structure", "members": { "Return": { "shape": "Boolean", "documentation": "Returns true if the request succeeds; otherwise, returns an error.
The name of the Amazon S3 bucket where the disk image is located.
" }, "S3Key": { "shape": "String", "documentation": "The file name of the disk image.
" } }, "documentation": "Describes the Amazon S3 bucket for the disk image.
" }, "UserBucketDetails": { "type": "structure", "members": { "S3Bucket": { "shape": "String", "documentation": "The Amazon S3 bucket from which the disk image was created.
", "locationName": "s3Bucket" }, "S3Key": { "shape": "String", "documentation": "The file name of the disk image.
", "locationName": "s3Key" } }, "documentation": "Describes the Amazon S3 bucket for the disk image.
" }, "UserData": { "type": "structure", "members": { "Data": { "shape": "String", "documentation": "The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
", "locationName": "data" } }, "documentation": "Describes the user data for an instance.
", "sensitive": true }, "UserGroupStringList": { "type": "list", "member": { "shape": "String", "locationName": "UserGroup" } }, "UserIdGroupPair": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
", "locationName": "description" }, "GroupId": { "shape": "String", "documentation": "The ID of the security group.
", "locationName": "groupId" }, "GroupName": { "shape": "String", "documentation": "[Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
", "locationName": "groupName" }, "PeeringStatus": { "shape": "String", "documentation": "The status of a VPC peering connection, if applicable.
", "locationName": "peeringStatus" }, "UserId": { "shape": "String", "documentation": "The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
", "locationName": "userId" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC for the referenced security group, if applicable.
", "locationName": "vpcId" }, "VpcPeeringConnectionId": { "shape": "String", "documentation": "The ID of the VPC peering connection, if applicable.
", "locationName": "vpcPeeringConnectionId" } }, "documentation": "Describes a security group and Amazon Web Services account ID pair.
" }, "UserIdGroupPairList": { "type": "list", "member": { "shape": "UserIdGroupPair", "locationName": "item" } }, "UserIdGroupPairSet": { "type": "list", "member": { "shape": "UserIdGroupPair", "locationName": "item" } }, "UserIdStringList": { "type": "list", "member": { "shape": "String", "locationName": "UserId" } }, "UserTrustProviderType": { "type": "string", "enum": [ "iam-identity-center", "oidc" ] }, "VCpuCount": { "type": "integer" }, "VCpuCountRange": { "type": "structure", "members": { "Min": { "shape": "Integer", "documentation": "The minimum number of vCPUs. If the value is 0, there is no minimum limit.
The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.
", "locationName": "max" } }, "documentation": "The minimum and maximum number of vCPUs.
" }, "VCpuCountRangeRequest": { "type": "structure", "required": [ "Min" ], "members": { "Min": { "shape": "Integer", "documentation": "The minimum number of vCPUs. To specify no minimum limit, specify 0.
The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
" } }, "documentation": "The minimum and maximum number of vCPUs.
" }, "VCpuInfo": { "type": "structure", "members": { "DefaultVCpus": { "shape": "VCpuCount", "documentation": "The default number of vCPUs for the instance type.
", "locationName": "defaultVCpus" }, "DefaultCores": { "shape": "CoreCount", "documentation": "The default number of cores for the instance type.
", "locationName": "defaultCores" }, "DefaultThreadsPerCore": { "shape": "ThreadsPerCore", "documentation": "The default number of threads per core for the instance type.
", "locationName": "defaultThreadsPerCore" }, "ValidCores": { "shape": "CoreCountList", "documentation": "The valid number of cores that can be configured for the instance type.
", "locationName": "validCores" }, "ValidThreadsPerCore": { "shape": "ThreadsPerCoreList", "documentation": "The valid number of threads per core that can be configured for the instance type.
", "locationName": "validThreadsPerCore" } }, "documentation": "Describes the vCPU configurations for the instance type.
" }, "ValidationError": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error codes.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error codes.
", "locationName": "message" } }, "documentation": "The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
" }, "ValidationWarning": { "type": "structure", "members": { "Errors": { "shape": "ErrorSet", "documentation": "The error codes and error messages.
", "locationName": "errorSet" } }, "documentation": "The error codes and error messages that are returned for the parameters or parameter combinations that are not valid when a new launch template or new version of a launch template is created.
" }, "ValueStringList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "VerifiedAccessEndpoint": { "type": "structure", "members": { "VerifiedAccessInstanceId": { "shape": "String", "documentation": "The ID of the Amazon Web Services Verified Access instance.
", "locationName": "verifiedAccessInstanceId" }, "VerifiedAccessGroupId": { "shape": "String", "documentation": "The ID of the Amazon Web Services Verified Access group.
", "locationName": "verifiedAccessGroupId" }, "VerifiedAccessEndpointId": { "shape": "String", "documentation": "The ID of the Amazon Web Services Verified Access endpoint.
", "locationName": "verifiedAccessEndpointId" }, "ApplicationDomain": { "shape": "String", "documentation": "The DNS name for users to reach your application.
", "locationName": "applicationDomain" }, "EndpointType": { "shape": "VerifiedAccessEndpointType", "documentation": "The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
", "locationName": "endpointType" }, "AttachmentType": { "shape": "VerifiedAccessEndpointAttachmentType", "documentation": "The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application.
", "locationName": "attachmentType" }, "DomainCertificateArn": { "shape": "String", "documentation": "The ARN of a public TLS/SSL certificate imported into or created with ACM.
", "locationName": "domainCertificateArn" }, "EndpointDomain": { "shape": "String", "documentation": "A DNS name that is generated for the endpoint.
", "locationName": "endpointDomain" }, "DeviceValidationDomain": { "shape": "String", "documentation": "Returned if endpoint has a device trust provider attached.
", "locationName": "deviceValidationDomain" }, "SecurityGroupIds": { "shape": "SecurityGroupIdList", "documentation": "The IDs of the security groups for the endpoint.
", "locationName": "securityGroupIdSet" }, "LoadBalancerOptions": { "shape": "VerifiedAccessEndpointLoadBalancerOptions", "documentation": "The load balancer details if creating the Amazon Web Services Verified Access endpoint as load-balancertype.
The options for network-interface type endpoint.
", "locationName": "networkInterfaceOptions" }, "Status": { "shape": "VerifiedAccessEndpointStatus", "documentation": "The endpoint status.
", "locationName": "status" }, "Description": { "shape": "String", "documentation": "A description for the Amazon Web Services Verified Access endpoint.
", "locationName": "description" }, "CreationTime": { "shape": "String", "documentation": "The creation time.
", "locationName": "creationTime" }, "LastUpdatedTime": { "shape": "String", "documentation": "The last updated time.
", "locationName": "lastUpdatedTime" }, "DeletionTime": { "shape": "String", "documentation": "The deletion time.
", "locationName": "deletionTime" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" }, "SseSpecification": { "shape": "VerifiedAccessSseSpecificationResponse", "documentation": "The options in use for server side encryption.
", "locationName": "sseSpecification" } }, "documentation": "An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy before you attached it to a group.
" }, "VerifiedAccessEndpointAttachmentType": { "type": "string", "enum": [ "vpc" ] }, "VerifiedAccessEndpointEniOptions": { "type": "structure", "members": { "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, "Protocol": { "shape": "VerifiedAccessEndpointProtocol", "documentation": "The IP protocol.
", "locationName": "protocol" }, "Port": { "shape": "VerifiedAccessEndpointPortNumber", "documentation": "The IP port number.
", "locationName": "port" } }, "documentation": "Options for a network-interface type endpoint.
" }, "VerifiedAccessEndpointId": { "type": "string" }, "VerifiedAccessEndpointIdList": { "type": "list", "member": { "shape": "VerifiedAccessEndpointId", "locationName": "item" } }, "VerifiedAccessEndpointList": { "type": "list", "member": { "shape": "VerifiedAccessEndpoint", "locationName": "item" } }, "VerifiedAccessEndpointLoadBalancerOptions": { "type": "structure", "members": { "Protocol": { "shape": "VerifiedAccessEndpointProtocol", "documentation": "The IP protocol.
", "locationName": "protocol" }, "Port": { "shape": "VerifiedAccessEndpointPortNumber", "documentation": "The IP port number.
", "locationName": "port" }, "LoadBalancerArn": { "shape": "String", "documentation": "The ARN of the load balancer.
", "locationName": "loadBalancerArn" }, "SubnetIds": { "shape": "VerifiedAccessEndpointSubnetIdList", "documentation": "The IDs of the subnets.
", "locationName": "subnetIdSet" } }, "documentation": "Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the load-balancer type.
The status code of the Verified Access endpoint.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The status message of the Verified Access endpoint.
", "locationName": "message" } }, "documentation": "Describes the status of a Verified Access endpoint.
" }, "VerifiedAccessEndpointStatusCode": { "type": "string", "enum": [ "pending", "active", "updating", "deleting", "deleted" ] }, "VerifiedAccessEndpointSubnetIdList": { "type": "list", "member": { "shape": "SubnetId", "locationName": "item" } }, "VerifiedAccessEndpointType": { "type": "string", "enum": [ "load-balancer", "network-interface" ] }, "VerifiedAccessGroup": { "type": "structure", "members": { "VerifiedAccessGroupId": { "shape": "String", "documentation": "The ID of the Verified Access group.
", "locationName": "verifiedAccessGroupId" }, "VerifiedAccessInstanceId": { "shape": "String", "documentation": "The ID of the Amazon Web Services Verified Access instance.
", "locationName": "verifiedAccessInstanceId" }, "Description": { "shape": "String", "documentation": "A description for the Amazon Web Services Verified Access group.
", "locationName": "description" }, "Owner": { "shape": "String", "documentation": "The Amazon Web Services account number that owns the group.
", "locationName": "owner" }, "VerifiedAccessGroupArn": { "shape": "String", "documentation": "The ARN of the Verified Access group.
", "locationName": "verifiedAccessGroupArn" }, "CreationTime": { "shape": "String", "documentation": "The creation time.
", "locationName": "creationTime" }, "LastUpdatedTime": { "shape": "String", "documentation": "The last updated time.
", "locationName": "lastUpdatedTime" }, "DeletionTime": { "shape": "String", "documentation": "The deletion time.
", "locationName": "deletionTime" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" }, "SseSpecification": { "shape": "VerifiedAccessSseSpecificationResponse", "documentation": "The options in use for server side encryption.
", "locationName": "sseSpecification" } }, "documentation": "Describes a Verified Access group.
" }, "VerifiedAccessGroupId": { "type": "string" }, "VerifiedAccessGroupIdList": { "type": "list", "member": { "shape": "VerifiedAccessGroupId", "locationName": "item" } }, "VerifiedAccessGroupList": { "type": "list", "member": { "shape": "VerifiedAccessGroup", "locationName": "item" } }, "VerifiedAccessInstance": { "type": "structure", "members": { "VerifiedAccessInstanceId": { "shape": "String", "documentation": "The ID of the Amazon Web Services Verified Access instance.
", "locationName": "verifiedAccessInstanceId" }, "Description": { "shape": "String", "documentation": "A description for the Amazon Web Services Verified Access instance.
", "locationName": "description" }, "VerifiedAccessTrustProviders": { "shape": "VerifiedAccessTrustProviderCondensedList", "documentation": "The IDs of the Amazon Web Services Verified Access trust providers.
", "locationName": "verifiedAccessTrustProviderSet" }, "CreationTime": { "shape": "String", "documentation": "The creation time.
", "locationName": "creationTime" }, "LastUpdatedTime": { "shape": "String", "documentation": "The last updated time.
", "locationName": "lastUpdatedTime" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" }, "FipsEnabled": { "shape": "Boolean", "documentation": "Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.
", "locationName": "fipsEnabled" } }, "documentation": "Describes a Verified Access instance.
" }, "VerifiedAccessInstanceId": { "type": "string" }, "VerifiedAccessInstanceIdList": { "type": "list", "member": { "shape": "VerifiedAccessInstanceId", "locationName": "item" } }, "VerifiedAccessInstanceList": { "type": "list", "member": { "shape": "VerifiedAccessInstance", "locationName": "item" } }, "VerifiedAccessInstanceLoggingConfiguration": { "type": "structure", "members": { "VerifiedAccessInstanceId": { "shape": "String", "documentation": "The ID of the Amazon Web Services Verified Access instance.
", "locationName": "verifiedAccessInstanceId" }, "AccessLogs": { "shape": "VerifiedAccessLogs", "documentation": "Details about the logging options.
", "locationName": "accessLogs" } }, "documentation": "Describes logging options for an Amazon Web Services Verified Access instance.
" }, "VerifiedAccessInstanceLoggingConfigurationList": { "type": "list", "member": { "shape": "VerifiedAccessInstanceLoggingConfiguration", "locationName": "item" } }, "VerifiedAccessLogCloudWatchLogsDestination": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether logging is enabled.
", "locationName": "enabled" }, "DeliveryStatus": { "shape": "VerifiedAccessLogDeliveryStatus", "documentation": "The delivery status for access logs.
", "locationName": "deliveryStatus" }, "LogGroup": { "shape": "String", "documentation": "The ID of the CloudWatch Logs log group.
", "locationName": "logGroup" } }, "documentation": "Options for CloudWatch Logs as a logging destination.
" }, "VerifiedAccessLogCloudWatchLogsDestinationOptions": { "type": "structure", "required": [ "Enabled" ], "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether logging is enabled.
" }, "LogGroup": { "shape": "String", "documentation": "The ID of the CloudWatch Logs log group.
" } }, "documentation": "Options for CloudWatch Logs as a logging destination.
" }, "VerifiedAccessLogDeliveryStatus": { "type": "structure", "members": { "Code": { "shape": "VerifiedAccessLogDeliveryStatusCode", "documentation": "The status code.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "The status message.
", "locationName": "message" } }, "documentation": "Describes a log delivery status.
" }, "VerifiedAccessLogDeliveryStatusCode": { "type": "string", "enum": [ "success", "failed" ] }, "VerifiedAccessLogKinesisDataFirehoseDestination": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether logging is enabled.
", "locationName": "enabled" }, "DeliveryStatus": { "shape": "VerifiedAccessLogDeliveryStatus", "documentation": "The delivery status.
", "locationName": "deliveryStatus" }, "DeliveryStream": { "shape": "String", "documentation": "The ID of the delivery stream.
", "locationName": "deliveryStream" } }, "documentation": "Options for Kinesis as a logging destination.
" }, "VerifiedAccessLogKinesisDataFirehoseDestinationOptions": { "type": "structure", "required": [ "Enabled" ], "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether logging is enabled.
" }, "DeliveryStream": { "shape": "String", "documentation": "The ID of the delivery stream.
" } }, "documentation": "Describes Amazon Kinesis Data Firehose logging options.
" }, "VerifiedAccessLogOptions": { "type": "structure", "members": { "S3": { "shape": "VerifiedAccessLogS3DestinationOptions", "documentation": "Sends Verified Access logs to Amazon S3.
" }, "CloudWatchLogs": { "shape": "VerifiedAccessLogCloudWatchLogsDestinationOptions", "documentation": "Sends Verified Access logs to CloudWatch Logs.
" }, "KinesisDataFirehose": { "shape": "VerifiedAccessLogKinesisDataFirehoseDestinationOptions", "documentation": "Sends Verified Access logs to Kinesis.
" }, "LogVersion": { "shape": "String", "documentation": "The logging version.
Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2
Indicates whether to include trust data sent by trust providers in the logs.
" } }, "documentation": "Options for Verified Access logs.
" }, "VerifiedAccessLogS3Destination": { "type": "structure", "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether logging is enabled.
", "locationName": "enabled" }, "DeliveryStatus": { "shape": "VerifiedAccessLogDeliveryStatus", "documentation": "The delivery status.
", "locationName": "deliveryStatus" }, "BucketName": { "shape": "String", "documentation": "The bucket name.
", "locationName": "bucketName" }, "Prefix": { "shape": "String", "documentation": "The bucket prefix.
", "locationName": "prefix" }, "BucketOwner": { "shape": "String", "documentation": "The Amazon Web Services account number that owns the bucket.
", "locationName": "bucketOwner" } }, "documentation": "Options for Amazon S3 as a logging destination.
" }, "VerifiedAccessLogS3DestinationOptions": { "type": "structure", "required": [ "Enabled" ], "members": { "Enabled": { "shape": "Boolean", "documentation": "Indicates whether logging is enabled.
" }, "BucketName": { "shape": "String", "documentation": "The bucket name.
" }, "Prefix": { "shape": "String", "documentation": "The bucket prefix.
" }, "BucketOwner": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the Amazon S3 bucket.
" } }, "documentation": "Options for Amazon S3 as a logging destination.
" }, "VerifiedAccessLogs": { "type": "structure", "members": { "S3": { "shape": "VerifiedAccessLogS3Destination", "documentation": "Amazon S3 logging options.
", "locationName": "s3" }, "CloudWatchLogs": { "shape": "VerifiedAccessLogCloudWatchLogsDestination", "documentation": "CloudWatch Logs logging destination.
", "locationName": "cloudWatchLogs" }, "KinesisDataFirehose": { "shape": "VerifiedAccessLogKinesisDataFirehoseDestination", "documentation": "Kinesis logging destination.
", "locationName": "kinesisDataFirehose" }, "LogVersion": { "shape": "String", "documentation": "The log version.
", "locationName": "logVersion" }, "IncludeTrustContext": { "shape": "Boolean", "documentation": "Indicates whether trust data is included in the logs.
", "locationName": "includeTrustContext" } }, "documentation": "Describes the options for Verified Access logs.
" }, "VerifiedAccessSseSpecificationRequest": { "type": "structure", "members": { "CustomerManagedKeyEnabled": { "shape": "Boolean", "documentation": "Enable or disable the use of customer managed KMS keys for server side encryption.
Valid values: True | False
The ARN of the KMS key.
" } }, "documentation": "Verified Access provides server side encryption by default to data at rest using Amazon Web Services-owned KMS keys. You also have the option of using customer managed KMS keys, which can be specified using the options below.
" }, "VerifiedAccessSseSpecificationResponse": { "type": "structure", "members": { "CustomerManagedKeyEnabled": { "shape": "Boolean", "documentation": "Indicates whether customer managed KMS keys are in use for server side encryption.
Valid values: True | False
The ARN of the KMS key.
", "locationName": "kmsKeyArn" } }, "documentation": "The options in use for server side encryption.
" }, "VerifiedAccessTrustProvider": { "type": "structure", "members": { "VerifiedAccessTrustProviderId": { "shape": "String", "documentation": "The ID of the Amazon Web Services Verified Access trust provider.
", "locationName": "verifiedAccessTrustProviderId" }, "Description": { "shape": "String", "documentation": "A description for the Amazon Web Services Verified Access trust provider.
", "locationName": "description" }, "TrustProviderType": { "shape": "TrustProviderType", "documentation": "The type of Verified Access trust provider.
", "locationName": "trustProviderType" }, "UserTrustProviderType": { "shape": "UserTrustProviderType", "documentation": "The type of user-based trust provider.
", "locationName": "userTrustProviderType" }, "DeviceTrustProviderType": { "shape": "DeviceTrustProviderType", "documentation": "The type of device-based trust provider.
", "locationName": "deviceTrustProviderType" }, "OidcOptions": { "shape": "OidcOptions", "documentation": "The options for an OpenID Connect-compatible user-identity trust provider.
", "locationName": "oidcOptions" }, "DeviceOptions": { "shape": "DeviceOptions", "documentation": "The options for device-identity trust provider.
", "locationName": "deviceOptions" }, "PolicyReferenceName": { "shape": "String", "documentation": "The identifier to be used when working with policy rules.
", "locationName": "policyReferenceName" }, "CreationTime": { "shape": "String", "documentation": "The creation time.
", "locationName": "creationTime" }, "LastUpdatedTime": { "shape": "String", "documentation": "The last updated time.
", "locationName": "lastUpdatedTime" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" }, "SseSpecification": { "shape": "VerifiedAccessSseSpecificationResponse", "documentation": "The options in use for server side encryption.
", "locationName": "sseSpecification" } }, "documentation": "Describes a Verified Access trust provider.
" }, "VerifiedAccessTrustProviderCondensed": { "type": "structure", "members": { "VerifiedAccessTrustProviderId": { "shape": "String", "documentation": "The ID of the trust provider.
", "locationName": "verifiedAccessTrustProviderId" }, "Description": { "shape": "String", "documentation": "The description of trust provider.
", "locationName": "description" }, "TrustProviderType": { "shape": "TrustProviderType", "documentation": "The type of trust provider (user- or device-based).
", "locationName": "trustProviderType" }, "UserTrustProviderType": { "shape": "UserTrustProviderType", "documentation": "The type of user-based trust provider.
", "locationName": "userTrustProviderType" }, "DeviceTrustProviderType": { "shape": "DeviceTrustProviderType", "documentation": "The type of device-based trust provider.
", "locationName": "deviceTrustProviderType" } }, "documentation": "Condensed information about a trust provider.
" }, "VerifiedAccessTrustProviderCondensedList": { "type": "list", "member": { "shape": "VerifiedAccessTrustProviderCondensed", "locationName": "item" } }, "VerifiedAccessTrustProviderId": { "type": "string" }, "VerifiedAccessTrustProviderIdList": { "type": "list", "member": { "shape": "VerifiedAccessTrustProviderId", "locationName": "item" } }, "VerifiedAccessTrustProviderList": { "type": "list", "member": { "shape": "VerifiedAccessTrustProvider", "locationName": "item" } }, "VersionDescription": { "type": "string", "max": 255, "min": 0 }, "VersionStringList": { "type": "list", "member": { "shape": "String", "locationName": "item" } }, "VgwTelemetry": { "type": "structure", "members": { "AcceptedRouteCount": { "shape": "Integer", "documentation": "The number of accepted routes.
", "locationName": "acceptedRouteCount" }, "LastStatusChange": { "shape": "DateTime", "documentation": "The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.
", "locationName": "lastStatusChange" }, "OutsideIpAddress": { "shape": "String", "documentation": "The Internet-routable IP address of the virtual private gateway's outside interface.
", "locationName": "outsideIpAddress" }, "Status": { "shape": "TelemetryStatus", "documentation": "The status of the VPN tunnel.
", "locationName": "status" }, "StatusMessage": { "shape": "String", "documentation": "If an error occurs, a description of the error.
", "locationName": "statusMessage" }, "CertificateArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
", "locationName": "certificateArn" } }, "documentation": "Describes telemetry for a VPN tunnel.
" }, "VgwTelemetryList": { "type": "list", "member": { "shape": "VgwTelemetry", "locationName": "item" } }, "VirtualizationType": { "type": "string", "enum": [ "hvm", "paravirtual" ] }, "VirtualizationTypeList": { "type": "list", "member": { "shape": "VirtualizationType", "locationName": "item" } }, "VirtualizationTypeSet": { "type": "list", "member": { "shape": "VirtualizationType", "locationName": "item" }, "max": 2, "min": 0 }, "Volume": { "type": "structure", "members": { "Attachments": { "shape": "VolumeAttachmentList", "documentation": "Information about the volume attachments.
", "locationName": "attachmentSet" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone for the volume.
", "locationName": "availabilityZone" }, "CreateTime": { "shape": "DateTime", "documentation": "The time stamp when volume creation was initiated.
", "locationName": "createTime" }, "Encrypted": { "shape": "Boolean", "documentation": "Indicates whether the volume is encrypted.
", "locationName": "encrypted" }, "KmsKeyId": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
", "locationName": "kmsKeyId" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", "locationName": "outpostArn" }, "Size": { "shape": "Integer", "documentation": "The size of the volume, in GiBs.
", "locationName": "size" }, "SnapshotId": { "shape": "String", "documentation": "The snapshot from which the volume was created, if applicable.
", "locationName": "snapshotId" }, "State": { "shape": "VolumeState", "documentation": "The volume state.
", "locationName": "status" }, "VolumeId": { "shape": "String", "documentation": "The ID of the volume.
", "locationName": "volumeId" }, "Iops": { "shape": "Integer", "documentation": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
Any tags assigned to the volume.
", "locationName": "tagSet" }, "VolumeType": { "shape": "VolumeType", "documentation": "The volume type.
", "locationName": "volumeType" }, "FastRestored": { "shape": "Boolean", "documentation": "Indicates whether the volume was created using fast snapshot restore.
", "locationName": "fastRestored" }, "MultiAttachEnabled": { "shape": "Boolean", "documentation": "Indicates whether Amazon EBS Multi-Attach is enabled.
", "locationName": "multiAttachEnabled" }, "Throughput": { "shape": "Integer", "documentation": "The throughput that the volume supports, in MiB/s.
", "locationName": "throughput" }, "SseType": { "shape": "SSEType", "documentation": "Reserved for future use.
", "locationName": "sseType" } }, "documentation": "Describes a volume.
" }, "VolumeAttachment": { "type": "structure", "members": { "AttachTime": { "shape": "DateTime", "documentation": "The time stamp when the attachment initiated.
", "locationName": "attachTime" }, "Device": { "shape": "String", "documentation": "The device name.
If the volume is attached to a Fargate task, this parameter returns null.
The ID of the instance.
If the volume is attached to a Fargate task, this parameter returns null.
The attachment state of the volume.
", "locationName": "status" }, "VolumeId": { "shape": "String", "documentation": "The ID of the volume.
", "locationName": "volumeId" }, "DeleteOnTermination": { "shape": "Boolean", "documentation": "Indicates whether the EBS volume is deleted on instance termination.
", "locationName": "deleteOnTermination" }, "AssociatedResource": { "shape": "String", "documentation": "The ARN of the Amazon ECS or Fargate task to which the volume is attached.
", "locationName": "associatedResource" }, "InstanceOwningService": { "shape": "String", "documentation": "The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.
This parameter is returned only for volumes that are attached to Fargate tasks.
", "locationName": "instanceOwningService" } }, "documentation": "Describes volume attachment details.
" }, "VolumeAttachmentList": { "type": "list", "member": { "shape": "VolumeAttachment", "locationName": "item" } }, "VolumeAttachmentState": { "type": "string", "enum": [ "attaching", "attached", "detaching", "detached", "busy" ] }, "VolumeAttributeName": { "type": "string", "enum": [ "autoEnableIO", "productCodes" ] }, "VolumeDetail": { "type": "structure", "required": [ "Size" ], "members": { "Size": { "shape": "Long", "documentation": "The size of the volume, in GiB.
", "locationName": "size" } }, "documentation": "Describes an EBS volume.
" }, "VolumeId": { "type": "string" }, "VolumeIdStringList": { "type": "list", "member": { "shape": "VolumeId", "locationName": "VolumeId" } }, "VolumeIdWithResolver": { "type": "string" }, "VolumeList": { "type": "list", "member": { "shape": "Volume", "locationName": "item" } }, "VolumeModification": { "type": "structure", "members": { "VolumeId": { "shape": "String", "documentation": "The ID of the volume.
", "locationName": "volumeId" }, "ModificationState": { "shape": "VolumeModificationState", "documentation": "The current modification state. The modification state is null for unmodified volumes.
", "locationName": "modificationState" }, "StatusMessage": { "shape": "String", "documentation": "A status message about the modification progress or failure.
", "locationName": "statusMessage" }, "TargetSize": { "shape": "Integer", "documentation": "The target size of the volume, in GiB.
", "locationName": "targetSize" }, "TargetIops": { "shape": "Integer", "documentation": "The target IOPS rate of the volume.
", "locationName": "targetIops" }, "TargetVolumeType": { "shape": "VolumeType", "documentation": "The target EBS volume type of the volume.
", "locationName": "targetVolumeType" }, "TargetThroughput": { "shape": "Integer", "documentation": "The target throughput of the volume, in MiB/s.
", "locationName": "targetThroughput" }, "TargetMultiAttachEnabled": { "shape": "Boolean", "documentation": "The target setting for Amazon EBS Multi-Attach.
", "locationName": "targetMultiAttachEnabled" }, "OriginalSize": { "shape": "Integer", "documentation": "The original size of the volume, in GiB.
", "locationName": "originalSize" }, "OriginalIops": { "shape": "Integer", "documentation": "The original IOPS rate of the volume.
", "locationName": "originalIops" }, "OriginalVolumeType": { "shape": "VolumeType", "documentation": "The original EBS volume type of the volume.
", "locationName": "originalVolumeType" }, "OriginalThroughput": { "shape": "Integer", "documentation": "The original throughput of the volume, in MiB/s.
", "locationName": "originalThroughput" }, "OriginalMultiAttachEnabled": { "shape": "Boolean", "documentation": "The original setting for Amazon EBS Multi-Attach.
", "locationName": "originalMultiAttachEnabled" }, "Progress": { "shape": "Long", "documentation": "The modification progress, from 0 to 100 percent complete.
", "locationName": "progress" }, "StartTime": { "shape": "DateTime", "documentation": "The modification start time.
", "locationName": "startTime" }, "EndTime": { "shape": "DateTime", "documentation": "The modification completion or failure time.
", "locationName": "endTime" } }, "documentation": "Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
" }, "VolumeModificationList": { "type": "list", "member": { "shape": "VolumeModification", "locationName": "item" } }, "VolumeModificationState": { "type": "string", "enum": [ "modifying", "optimizing", "completed", "failed" ] }, "VolumeState": { "type": "string", "enum": [ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction": { "type": "structure", "members": { "Code": { "shape": "String", "documentation": "The code identifying the operation, for example, enable-volume-io.
A description of the operation.
", "locationName": "description" }, "EventId": { "shape": "String", "documentation": "The ID of the event associated with this operation.
", "locationName": "eventId" }, "EventType": { "shape": "String", "documentation": "The event type associated with this operation.
", "locationName": "eventType" } }, "documentation": "Describes a volume status operation code.
" }, "VolumeStatusActionsList": { "type": "list", "member": { "shape": "VolumeStatusAction", "locationName": "item" } }, "VolumeStatusAttachmentStatus": { "type": "structure", "members": { "IoPerformance": { "shape": "String", "documentation": "The maximum IOPS supported by the attached instance.
", "locationName": "ioPerformance" }, "InstanceId": { "shape": "String", "documentation": "The ID of the attached instance.
", "locationName": "instanceId" } }, "documentation": "Information about the instances to which the volume is attached.
" }, "VolumeStatusAttachmentStatusList": { "type": "list", "member": { "shape": "VolumeStatusAttachmentStatus", "locationName": "item" } }, "VolumeStatusDetails": { "type": "structure", "members": { "Name": { "shape": "VolumeStatusName", "documentation": "The name of the volume status.
", "locationName": "name" }, "Status": { "shape": "String", "documentation": "The intended status of the volume status.
", "locationName": "status" } }, "documentation": "Describes a volume status.
" }, "VolumeStatusDetailsList": { "type": "list", "member": { "shape": "VolumeStatusDetails", "locationName": "item" } }, "VolumeStatusEvent": { "type": "structure", "members": { "Description": { "shape": "String", "documentation": "A description of the event.
", "locationName": "description" }, "EventId": { "shape": "String", "documentation": "The ID of this event.
", "locationName": "eventId" }, "EventType": { "shape": "String", "documentation": "The type of this event.
", "locationName": "eventType" }, "NotAfter": { "shape": "MillisecondDateTime", "documentation": "The latest end time of the event.
", "locationName": "notAfter" }, "NotBefore": { "shape": "MillisecondDateTime", "documentation": "The earliest start time of the event.
", "locationName": "notBefore" }, "InstanceId": { "shape": "String", "documentation": "The ID of the instance associated with the event.
", "locationName": "instanceId" } }, "documentation": "Describes a volume status event.
" }, "VolumeStatusEventsList": { "type": "list", "member": { "shape": "VolumeStatusEvent", "locationName": "item" } }, "VolumeStatusInfo": { "type": "structure", "members": { "Details": { "shape": "VolumeStatusDetailsList", "documentation": "The details of the volume status.
", "locationName": "details" }, "Status": { "shape": "VolumeStatusInfoStatus", "documentation": "The status of the volume.
", "locationName": "status" } }, "documentation": "Describes the status of a volume.
" }, "VolumeStatusInfoStatus": { "type": "string", "enum": [ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem": { "type": "structure", "members": { "Actions": { "shape": "VolumeStatusActionsList", "documentation": "The details of the operation.
", "locationName": "actionsSet" }, "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone of the volume.
", "locationName": "availabilityZone" }, "OutpostArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", "locationName": "outpostArn" }, "Events": { "shape": "VolumeStatusEventsList", "documentation": "A list of events associated with the volume.
", "locationName": "eventsSet" }, "VolumeId": { "shape": "String", "documentation": "The volume ID.
", "locationName": "volumeId" }, "VolumeStatus": { "shape": "VolumeStatusInfo", "documentation": "The volume status.
", "locationName": "volumeStatus" }, "AttachmentStatuses": { "shape": "VolumeStatusAttachmentStatusList", "documentation": "Information about the instances to which the volume is attached.
", "locationName": "attachmentStatuses" } }, "documentation": "Describes the volume status.
" }, "VolumeStatusList": { "type": "list", "member": { "shape": "VolumeStatusItem", "locationName": "item" } }, "VolumeStatusName": { "type": "string", "enum": [ "io-enabled", "io-performance" ] }, "VolumeType": { "type": "string", "enum": [ "standard", "io1", "io2", "gp2", "sc1", "st1", "gp3" ] }, "Vpc": { "type": "structure", "members": { "CidrBlock": { "shape": "String", "documentation": "The primary IPv4 CIDR block for the VPC.
", "locationName": "cidrBlock" }, "DhcpOptionsId": { "shape": "String", "documentation": "The ID of the set of DHCP options you've associated with the VPC.
", "locationName": "dhcpOptionsId" }, "State": { "shape": "VpcState", "documentation": "The current state of the VPC.
", "locationName": "state" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the VPC.
", "locationName": "ownerId" }, "InstanceTenancy": { "shape": "Tenancy", "documentation": "The allowed tenancy of instances launched into the VPC.
", "locationName": "instanceTenancy" }, "Ipv6CidrBlockAssociationSet": { "shape": "VpcIpv6CidrBlockAssociationSet", "documentation": "Information about the IPv6 CIDR blocks associated with the VPC.
", "locationName": "ipv6CidrBlockAssociationSet" }, "CidrBlockAssociationSet": { "shape": "VpcCidrBlockAssociationSet", "documentation": "Information about the IPv4 CIDR blocks associated with the VPC.
", "locationName": "cidrBlockAssociationSet" }, "IsDefault": { "shape": "Boolean", "documentation": "Indicates whether the VPC is the default VPC.
", "locationName": "isDefault" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the VPC.
", "locationName": "tagSet" } }, "documentation": "Describes a VPC.
" }, "VpcAttachment": { "type": "structure", "members": { "State": { "shape": "AttachmentStatus", "documentation": "The current state of the attachment.
", "locationName": "state" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" } }, "documentation": "Describes an attachment between a virtual private gateway and a VPC.
" }, "VpcAttachmentList": { "type": "list", "member": { "shape": "VpcAttachment", "locationName": "item" } }, "VpcAttributeName": { "type": "string", "enum": [ "enableDnsSupport", "enableDnsHostnames", "enableNetworkAddressUsageMetrics" ] }, "VpcCidrAssociationId": { "type": "string" }, "VpcCidrBlockAssociation": { "type": "structure", "members": { "AssociationId": { "shape": "String", "documentation": "The association ID for the IPv4 CIDR block.
", "locationName": "associationId" }, "CidrBlock": { "shape": "String", "documentation": "The IPv4 CIDR block.
", "locationName": "cidrBlock" }, "CidrBlockState": { "shape": "VpcCidrBlockState", "documentation": "Information about the state of the CIDR block.
", "locationName": "cidrBlockState" } }, "documentation": "Describes an IPv4 CIDR block associated with a VPC.
" }, "VpcCidrBlockAssociationSet": { "type": "list", "member": { "shape": "VpcCidrBlockAssociation", "locationName": "item" } }, "VpcCidrBlockState": { "type": "structure", "members": { "State": { "shape": "VpcCidrBlockStateCode", "documentation": "The state of the CIDR block.
", "locationName": "state" }, "StatusMessage": { "shape": "String", "documentation": "A message about the status of the CIDR block, if applicable.
", "locationName": "statusMessage" } }, "documentation": "Describes the state of a CIDR block.
" }, "VpcCidrBlockStateCode": { "type": "string", "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ] }, "VpcClassicLink": { "type": "structure", "members": { "ClassicLinkEnabled": { "shape": "Boolean", "documentation": "Indicates whether the VPC is enabled for ClassicLink.
", "locationName": "classicLinkEnabled" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the VPC.
", "locationName": "tagSet" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" } }, "documentation": "Deprecated.
Describes whether a VPC is enabled for ClassicLink.
" }, "VpcClassicLinkIdList": { "type": "list", "member": { "shape": "VpcId", "locationName": "VpcId" } }, "VpcClassicLinkList": { "type": "list", "member": { "shape": "VpcClassicLink", "locationName": "item" } }, "VpcEndpoint": { "type": "structure", "members": { "VpcEndpointId": { "shape": "String", "documentation": "The ID of the endpoint.
", "locationName": "vpcEndpointId" }, "VpcEndpointType": { "shape": "VpcEndpointType", "documentation": "The type of endpoint.
", "locationName": "vpcEndpointType" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC to which the endpoint is associated.
", "locationName": "vpcId" }, "ServiceName": { "shape": "String", "documentation": "The name of the service to which the endpoint is associated.
", "locationName": "serviceName" }, "State": { "shape": "State", "documentation": "The state of the endpoint.
", "locationName": "state" }, "PolicyDocument": { "shape": "String", "documentation": "The policy document associated with the endpoint, if applicable.
", "locationName": "policyDocument" }, "RouteTableIds": { "shape": "ValueStringList", "documentation": "(Gateway endpoint) The IDs of the route tables associated with the endpoint.
", "locationName": "routeTableIdSet" }, "SubnetIds": { "shape": "ValueStringList", "documentation": "(Interface endpoint) The subnets for the endpoint.
", "locationName": "subnetIdSet" }, "Groups": { "shape": "GroupIdentifierSet", "documentation": "(Interface endpoint) Information about the security groups that are associated with the network interface.
", "locationName": "groupSet" }, "IpAddressType": { "shape": "IpAddressType", "documentation": "The IP address type for the endpoint.
", "locationName": "ipAddressType" }, "DnsOptions": { "shape": "DnsOptions", "documentation": "The DNS options for the endpoint.
", "locationName": "dnsOptions" }, "PrivateDnsEnabled": { "shape": "Boolean", "documentation": "(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
", "locationName": "privateDnsEnabled" }, "RequesterManaged": { "shape": "Boolean", "documentation": "Indicates whether the endpoint is being managed by its service.
", "locationName": "requesterManaged" }, "NetworkInterfaceIds": { "shape": "ValueStringList", "documentation": "(Interface endpoint) The network interfaces for the endpoint.
", "locationName": "networkInterfaceIdSet" }, "DnsEntries": { "shape": "DnsEntrySet", "documentation": "(Interface endpoint) The DNS entries for the endpoint.
", "locationName": "dnsEntrySet" }, "CreationTimestamp": { "shape": "MillisecondDateTime", "documentation": "The date and time that the endpoint was created.
", "locationName": "creationTimestamp" }, "Tags": { "shape": "TagList", "documentation": "The tags assigned to the endpoint.
", "locationName": "tagSet" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the endpoint.
", "locationName": "ownerId" }, "LastError": { "shape": "LastError", "documentation": "The last error that occurred for endpoint.
", "locationName": "lastError" } }, "documentation": "Describes a VPC endpoint.
" }, "VpcEndpointConnection": { "type": "structure", "members": { "ServiceId": { "shape": "String", "documentation": "The ID of the service to which the endpoint is connected.
", "locationName": "serviceId" }, "VpcEndpointId": { "shape": "String", "documentation": "The ID of the VPC endpoint.
", "locationName": "vpcEndpointId" }, "VpcEndpointOwner": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the VPC endpoint.
", "locationName": "vpcEndpointOwner" }, "VpcEndpointState": { "shape": "State", "documentation": "The state of the VPC endpoint.
", "locationName": "vpcEndpointState" }, "CreationTimestamp": { "shape": "MillisecondDateTime", "documentation": "The date and time that the VPC endpoint was created.
", "locationName": "creationTimestamp" }, "DnsEntries": { "shape": "DnsEntrySet", "documentation": "The DNS entries for the VPC endpoint.
", "locationName": "dnsEntrySet" }, "NetworkLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of the network load balancers for the service.
", "locationName": "networkLoadBalancerArnSet" }, "GatewayLoadBalancerArns": { "shape": "ValueStringList", "documentation": "The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
", "locationName": "gatewayLoadBalancerArnSet" }, "IpAddressType": { "shape": "IpAddressType", "documentation": "The IP address type for the endpoint.
", "locationName": "ipAddressType" }, "VpcEndpointConnectionId": { "shape": "String", "documentation": "The ID of the VPC endpoint connection.
", "locationName": "vpcEndpointConnectionId" }, "Tags": { "shape": "TagList", "documentation": "The tags.
", "locationName": "tagSet" } }, "documentation": "Describes a VPC endpoint connection to a service.
" }, "VpcEndpointConnectionSet": { "type": "list", "member": { "shape": "VpcEndpointConnection", "locationName": "item" } }, "VpcEndpointId": { "type": "string" }, "VpcEndpointIdList": { "type": "list", "member": { "shape": "VpcEndpointId", "locationName": "item" } }, "VpcEndpointRouteTableIdList": { "type": "list", "member": { "shape": "RouteTableId", "locationName": "item" } }, "VpcEndpointSecurityGroupIdList": { "type": "list", "member": { "shape": "SecurityGroupId", "locationName": "item" } }, "VpcEndpointServiceId": { "type": "string" }, "VpcEndpointServiceIdList": { "type": "list", "member": { "shape": "VpcEndpointServiceId", "locationName": "item" } }, "VpcEndpointSet": { "type": "list", "member": { "shape": "VpcEndpoint", "locationName": "item" } }, "VpcEndpointSubnetIdList": { "type": "list", "member": { "shape": "SubnetId", "locationName": "item" } }, "VpcEndpointType": { "type": "string", "enum": [ "Interface", "Gateway", "GatewayLoadBalancer" ] }, "VpcFlowLogId": { "type": "string" }, "VpcId": { "type": "string" }, "VpcIdStringList": { "type": "list", "member": { "shape": "VpcId", "locationName": "VpcId" } }, "VpcIpv6CidrBlockAssociation": { "type": "structure", "members": { "AssociationId": { "shape": "String", "documentation": "The association ID for the IPv6 CIDR block.
", "locationName": "associationId" }, "Ipv6CidrBlock": { "shape": "String", "documentation": "The IPv6 CIDR block.
", "locationName": "ipv6CidrBlock" }, "Ipv6CidrBlockState": { "shape": "VpcCidrBlockState", "documentation": "Information about the state of the CIDR block.
", "locationName": "ipv6CidrBlockState" }, "NetworkBorderGroup": { "shape": "String", "documentation": "The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
", "locationName": "ipv6Pool" } }, "documentation": "Describes an IPv6 CIDR block associated with a VPC.
" }, "VpcIpv6CidrBlockAssociationSet": { "type": "list", "member": { "shape": "VpcIpv6CidrBlockAssociation", "locationName": "item" } }, "VpcList": { "type": "list", "member": { "shape": "Vpc", "locationName": "item" } }, "VpcPeeringConnection": { "type": "structure", "members": { "AccepterVpcInfo": { "shape": "VpcPeeringConnectionVpcInfo", "documentation": "Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
", "locationName": "accepterVpcInfo" }, "ExpirationTime": { "shape": "DateTime", "documentation": "The time that an unaccepted VPC peering connection will expire.
", "locationName": "expirationTime" }, "RequesterVpcInfo": { "shape": "VpcPeeringConnectionVpcInfo", "documentation": "Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
", "locationName": "requesterVpcInfo" }, "Status": { "shape": "VpcPeeringConnectionStateReason", "documentation": "The status of the VPC peering connection.
", "locationName": "status" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the resource.
", "locationName": "tagSet" }, "VpcPeeringConnectionId": { "shape": "String", "documentation": "The ID of the VPC peering connection.
", "locationName": "vpcPeeringConnectionId" } }, "documentation": "Describes a VPC peering connection.
" }, "VpcPeeringConnectionId": { "type": "string" }, "VpcPeeringConnectionIdList": { "type": "list", "member": { "shape": "VpcPeeringConnectionId", "locationName": "item" } }, "VpcPeeringConnectionIdWithResolver": { "type": "string" }, "VpcPeeringConnectionList": { "type": "list", "member": { "shape": "VpcPeeringConnection", "locationName": "item" } }, "VpcPeeringConnectionOptionsDescription": { "type": "structure", "members": { "AllowDnsResolutionFromRemoteVpc": { "shape": "Boolean", "documentation": "Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
", "locationName": "allowDnsResolutionFromRemoteVpc" }, "AllowEgressFromLocalClassicLinkToRemoteVpc": { "shape": "Boolean", "documentation": "Deprecated.
", "locationName": "allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink": { "shape": "Boolean", "documentation": "Deprecated.
", "locationName": "allowEgressFromLocalVpcToRemoteClassicLink" } }, "documentation": "Describes the VPC peering connection options.
" }, "VpcPeeringConnectionStateReason": { "type": "structure", "members": { "Code": { "shape": "VpcPeeringConnectionStateReasonCode", "documentation": "The status of the VPC peering connection.
", "locationName": "code" }, "Message": { "shape": "String", "documentation": "A message that provides more information about the status, if applicable.
", "locationName": "message" } }, "documentation": "Describes the status of a VPC peering connection.
" }, "VpcPeeringConnectionStateReasonCode": { "type": "string", "enum": [ "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting" ] }, "VpcPeeringConnectionVpcInfo": { "type": "structure", "members": { "CidrBlock": { "shape": "String", "documentation": "The IPv4 CIDR block for the VPC.
", "locationName": "cidrBlock" }, "Ipv6CidrBlockSet": { "shape": "Ipv6CidrBlockSet", "documentation": "The IPv6 CIDR block for the VPC.
", "locationName": "ipv6CidrBlockSet" }, "CidrBlockSet": { "shape": "CidrBlockSet", "documentation": "Information about the IPv4 CIDR blocks for the VPC.
", "locationName": "cidrBlockSet" }, "OwnerId": { "shape": "String", "documentation": "The ID of the Amazon Web Services account that owns the VPC.
", "locationName": "ownerId" }, "PeeringOptions": { "shape": "VpcPeeringConnectionOptionsDescription", "documentation": "Information about the VPC peering connection options for the accepter or requester VPC.
", "locationName": "peeringOptions" }, "VpcId": { "shape": "String", "documentation": "The ID of the VPC.
", "locationName": "vpcId" }, "Region": { "shape": "String", "documentation": "The Region in which the VPC is located.
", "locationName": "region" } }, "documentation": "Describes a VPC in a VPC peering connection.
" }, "VpcState": { "type": "string", "enum": [ "pending", "available" ] }, "VpcTenancy": { "type": "string", "enum": [ "default" ] }, "VpnConnection": { "type": "structure", "members": { "CustomerGatewayConfiguration": { "shape": "customerGatewayConfiguration", "documentation": "The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
The ID of the customer gateway at your end of the VPN connection.
", "locationName": "customerGatewayId" }, "Category": { "shape": "String", "documentation": "The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
The current state of the VPN connection.
", "locationName": "state" }, "Type": { "shape": "GatewayType", "documentation": "The type of VPN connection.
", "locationName": "type" }, "VpnConnectionId": { "shape": "String", "documentation": "The ID of the VPN connection.
", "locationName": "vpnConnectionId" }, "VpnGatewayId": { "shape": "String", "documentation": "The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
", "locationName": "vpnGatewayId" }, "TransitGatewayId": { "shape": "String", "documentation": "The ID of the transit gateway associated with the VPN connection.
", "locationName": "transitGatewayId" }, "CoreNetworkArn": { "shape": "String", "documentation": "The ARN of the core network.
", "locationName": "coreNetworkArn" }, "CoreNetworkAttachmentArn": { "shape": "String", "documentation": "The ARN of the core network attachment.
", "locationName": "coreNetworkAttachmentArn" }, "GatewayAssociationState": { "shape": "GatewayAssociationState", "documentation": "The current state of the gateway association.
", "locationName": "gatewayAssociationState" }, "Options": { "shape": "VpnConnectionOptions", "documentation": "The VPN connection options.
", "locationName": "options" }, "Routes": { "shape": "VpnStaticRouteList", "documentation": "The static routes associated with the VPN connection.
", "locationName": "routes" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the VPN connection.
", "locationName": "tagSet" }, "VgwTelemetry": { "shape": "VgwTelemetryList", "documentation": "Information about the VPN tunnel.
", "locationName": "vgwTelemetry" } }, "documentation": "Describes a VPN connection.
" }, "VpnConnectionDeviceSampleConfiguration": { "type": "string", "sensitive": true }, "VpnConnectionDeviceType": { "type": "structure", "members": { "VpnConnectionDeviceTypeId": { "shape": "String", "documentation": "Customer gateway device identifier.
", "locationName": "vpnConnectionDeviceTypeId" }, "Vendor": { "shape": "String", "documentation": "Customer gateway device vendor.
", "locationName": "vendor" }, "Platform": { "shape": "String", "documentation": "Customer gateway device platform.
", "locationName": "platform" }, "Software": { "shape": "String", "documentation": "Customer gateway device software version.
", "locationName": "software" } }, "documentation": "List of customer gateway devices that have a sample configuration file available for use. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "VpnConnectionDeviceTypeId": { "type": "string" }, "VpnConnectionDeviceTypeList": { "type": "list", "member": { "shape": "VpnConnectionDeviceType", "locationName": "item" } }, "VpnConnectionId": { "type": "string" }, "VpnConnectionIdStringList": { "type": "list", "member": { "shape": "VpnConnectionId", "locationName": "VpnConnectionId" } }, "VpnConnectionList": { "type": "list", "member": { "shape": "VpnConnection", "locationName": "item" } }, "VpnConnectionOptions": { "type": "structure", "members": { "EnableAcceleration": { "shape": "Boolean", "documentation": "Indicates whether acceleration is enabled for the VPN connection.
", "locationName": "enableAcceleration" }, "StaticRoutesOnly": { "shape": "Boolean", "documentation": "Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
", "locationName": "staticRoutesOnly" }, "LocalIpv4NetworkCidr": { "shape": "String", "documentation": "The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
", "locationName": "localIpv4NetworkCidr" }, "RemoteIpv4NetworkCidr": { "shape": "String", "documentation": "The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
", "locationName": "remoteIpv4NetworkCidr" }, "LocalIpv6NetworkCidr": { "shape": "String", "documentation": "The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
", "locationName": "localIpv6NetworkCidr" }, "RemoteIpv6NetworkCidr": { "shape": "String", "documentation": "The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
", "locationName": "remoteIpv6NetworkCidr" }, "OutsideIpAddressType": { "shape": "String", "documentation": "The type of IPv4 address assigned to the outside interface of the customer gateway.
Valid values: PrivateIpv4 | PublicIpv4
Default: PublicIpv4
The transit gateway attachment ID in use for the VPN tunnel.
", "locationName": "transportTransitGatewayAttachmentId" }, "TunnelInsideIpVersion": { "shape": "TunnelInsideIpVersion", "documentation": "Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
", "locationName": "tunnelInsideIpVersion" }, "TunnelOptions": { "shape": "TunnelOptionsList", "documentation": "Indicates the VPN tunnel options.
", "locationName": "tunnelOptionSet" } }, "documentation": "Describes VPN connection options.
" }, "VpnConnectionOptionsSpecification": { "type": "structure", "members": { "EnableAcceleration": { "shape": "Boolean", "documentation": "Indicate whether to enable acceleration for the VPN connection.
Default: false
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.
Default: false
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
The tunnel options for the VPN connection.
" }, "LocalIpv4NetworkCidr": { "shape": "String", "documentation": "The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
The type of IPv4 address assigned to the outside interface of the customer gateway device.
Valid values: PrivateIpv4 | PublicIpv4
Default: PublicIpv4
The transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType is set to PrivateIpv4.
Describes VPN connection options.
" }, "VpnEcmpSupportValue": { "type": "string", "enum": [ "enable", "disable" ] }, "VpnGateway": { "type": "structure", "members": { "AvailabilityZone": { "shape": "String", "documentation": "The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
", "locationName": "availabilityZone" }, "State": { "shape": "VpnState", "documentation": "The current state of the virtual private gateway.
", "locationName": "state" }, "Type": { "shape": "GatewayType", "documentation": "The type of VPN connection the virtual private gateway supports.
", "locationName": "type" }, "VpcAttachments": { "shape": "VpcAttachmentList", "documentation": "Any VPCs attached to the virtual private gateway.
", "locationName": "attachments" }, "VpnGatewayId": { "shape": "String", "documentation": "The ID of the virtual private gateway.
", "locationName": "vpnGatewayId" }, "AmazonSideAsn": { "shape": "Long", "documentation": "The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
", "locationName": "amazonSideAsn" }, "Tags": { "shape": "TagList", "documentation": "Any tags assigned to the virtual private gateway.
", "locationName": "tagSet" } }, "documentation": "Describes a virtual private gateway.
" }, "VpnGatewayId": { "type": "string" }, "VpnGatewayIdStringList": { "type": "list", "member": { "shape": "VpnGatewayId", "locationName": "VpnGatewayId" } }, "VpnGatewayList": { "type": "list", "member": { "shape": "VpnGateway", "locationName": "item" } }, "VpnProtocol": { "type": "string", "enum": [ "openvpn" ] }, "VpnState": { "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute": { "type": "structure", "members": { "DestinationCidrBlock": { "shape": "String", "documentation": "The CIDR block associated with the local subnet of the customer data center.
", "locationName": "destinationCidrBlock" }, "Source": { "shape": "VpnStaticRouteSource", "documentation": "Indicates how the routes were provided.
", "locationName": "source" }, "State": { "shape": "VpnState", "documentation": "The current state of the static route.
", "locationName": "state" } }, "documentation": "Describes a static route for a VPN connection.
" }, "VpnStaticRouteList": { "type": "list", "member": { "shape": "VpnStaticRoute", "locationName": "item" } }, "VpnStaticRouteSource": { "type": "string", "enum": [ "Static" ] }, "VpnTunnelLogOptions": { "type": "structure", "members": { "CloudWatchLogOptions": { "shape": "CloudWatchLogOptions", "documentation": "Options for sending VPN tunnel logs to CloudWatch.
", "locationName": "cloudWatchLogOptions" } }, "documentation": "Options for logging VPN tunnel activity.
" }, "VpnTunnelLogOptionsSpecification": { "type": "structure", "members": { "CloudWatchLogOptions": { "shape": "CloudWatchLogOptionsSpecification", "documentation": "Options for sending VPN tunnel logs to CloudWatch.
" } }, "documentation": "Options for logging VPN tunnel activity.
" }, "VpnTunnelOptionsSpecification": { "type": "structure", "members": { "TunnelInsideCidr": { "shape": "String", "documentation": "The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
" }, "Phase1LifetimeSeconds": { "shape": "Integer", "documentation": "The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 270
The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
The number of seconds after which a DPD timeout occurs.
Constraints: A value greater than or equal to 30.
Default: 30
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
Options for logging VPN tunnel activity.
" }, "EnableTunnelLifecycleControl": { "shape": "Boolean", "documentation": "Turn on or off tunnel endpoint lifecycle control feature.
" } }, "documentation": "The tunnel options for a single VPN tunnel.
" }, "VpnTunnelOptionsSpecificationsList": { "type": "list", "member": { "shape": "VpnTunnelOptionsSpecification" } }, "WeekDay": { "type": "string", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ] }, "WithdrawByoipCidrRequest": { "type": "structure", "required": [ "Cidr" ], "members": { "Cidr": { "shape": "String", "documentation": "The address range, in CIDR notation.
" }, "DryRun": { "shape": "Boolean", "documentation": "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.
Information about the address pool.
", "locationName": "byoipCidr" } } }, "ZoneIdStringList": { "type": "list", "member": { "shape": "String", "locationName": "ZoneId" } }, "ZoneNameStringList": { "type": "list", "member": { "shape": "String", "locationName": "ZoneName" } }, "customerGatewayConfiguration": { "type": "string", "sensitive": true }, "preSharedKey": { "type": "string", "sensitive": true }, "scope": { "type": "string", "enum": [ "Availability Zone", "Region" ] }, "snapshotTierStatusSet": { "type": "list", "member": { "shape": "SnapshotTierStatus", "locationName": "item" } }, "totalFpgaMemory": { "type": "integer" }, "totalGpuMemory": { "type": "integer" }, "totalInferenceMemory": { "type": "integer" } }, "documentation": "You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information, see the Amazon EC2 Developer Guide.
" }