{ "version": "2.0", "metadata": { "apiVersion": "2016-11-15", "endpointPrefix": "ec2", "protocol": "ec2", "protocols": [ "ec2" ], "serviceAbbreviation": "Amazon EC2", "serviceFullName": "Amazon Elastic Compute Cloud", "serviceId": "EC2", "signatureVersion": "v4", "uid": "ec2-2016-11-15", "xmlNamespace": "http://ec2.amazonaws.com/doc/2016-11-15", "auth": [ "aws.auth#sigv4" ] }, "operations": { "AcceptAddressTransfer": { "name": "AcceptAddressTransfer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AcceptAddressTransferRequest" }, "output": { "shape": "AcceptAddressTransferResult" }, "documentation": "
Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC 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 EC2 User Guide.
If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify it in this operation.
For more information, see Elastic IP Addresses in the Amazon EC2 User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
" }, "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.
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 network interfaces in the Amazon EC2 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 more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network 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 network interfaces in the Amazon EC2 User Guide.
" }, "AssignPrivateNatGatewayAddress": { "name": "AssignPrivateNatGatewayAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AssignPrivateNatGatewayAddressRequest" }, "output": { "shape": "AssignPrivateNatGatewayAddressResult" }, "documentation": "Assigns 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 option 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, use CreateNetworkInterface command and set the interface type to trunk
. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
You 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 Sell in the 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 an AMI copy operation. 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.
When you copy an AMI from one Region to another, the destination Region is the current Region.
When you copy an AMI from a Region to an Outpost, specify the ARN of the Outpost as the destination. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region or the key that you specify. Outposts do not support unencrypted snapshots.
For information about the prerequisites 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 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.
" }, "CreateCapacityReservationBySplitting": { "name": "CreateCapacityReservationBySplitting", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateCapacityReservationBySplittingRequest" }, "output": { "shape": "CreateCapacityReservationBySplittingResult" }, "documentation": " Create a new Capacity Reservation by splitting the available capacity of the source Capacity Reservation. The new Capacity Reservation will have the same attributes as the source Capacity Reservation except for tags. The source Capacity Reservation must be active
and owned by your Amazon Web Services account.
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 option 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 VPC User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon VPC 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.
" }, "CreateIpamExternalResourceVerificationToken": { "name": "CreateIpamExternalResourceVerificationToken", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateIpamExternalResourceVerificationTokenRequest" }, "output": { "shape": "CreateIpamExternalResourceVerificationTokenResult" }, "documentation": "Create a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
" }, "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 EC2 User Guide.
To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon EC2 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 EC2 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 about network interfaces, see Elastic network interfaces in the Amazon EC2 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 EC2 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 Sell in the 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 EC2 User Guide.
For more information, see Amazon EBS 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.
" }, "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 VPC User Guide and Assign prefixes to network interfaces in the Amazon EC2 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 Amazon Web Services 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 EC2 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 Creating an Amazon SNS topic in the Amazon SNS 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 VPC peering limitations in the VPC Peering Guide.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it 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.
" }, "DeleteIpamExternalResourceVerificationToken": { "name": "DeleteIpamExternalResourceVerificationToken", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteIpamExternalResourceVerificationTokenRequest" }, "output": { "shape": "DeleteIpamExternalResourceVerificationTokenResult" }, "documentation": "Delete a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
" }, "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 Amazon 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 in the same VPC, 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. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.
" }, "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 VPC User Guide.
When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address 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 14 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 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 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 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 your DHCP option sets. The default is to describe all your DHCP option sets. Alternatively, you can specify specific DHCP option set IDs or filter the results to include only the DHCP option sets that match specific criteria.
For more information, see DHCP option sets in the Amazon VPC User Guide.
" }, "DescribeEgressOnlyInternetGateways": { "name": "DescribeEgressOnlyInternetGateways", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEgressOnlyInternetGatewaysRequest" }, "output": { "shape": "DescribeEgressOnlyInternetGatewaysResult" }, "documentation": "Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.
" }, "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 G4, G5, or G6 instances.
Describes the Elastic Graphics accelerator associated with your instances.
" }, "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 your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.
" }, "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.
" }, "DescribeIpamExternalResourceVerificationTokens": { "name": "DescribeIpamExternalResourceVerificationTokens", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeIpamExternalResourceVerificationTokensRequest" }, "output": { "shape": "DescribeIpamExternalResourceVerificationTokensResult" }, "documentation": "Describe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
" }, "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 your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.
" }, "DescribeNetworkAcls": { "name": "DescribeNetworkAcls", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNetworkAclsRequest" }, "output": { "shape": "DescribeNetworkAclsResult" }, "documentation": "Describes your network ACLs. The default is to describe all your network ACLs. Alternatively, you can specify specific network ACL IDs or filter the results to include only the network ACLs that match specific criteria.
For more information, see Network ACLs in the Amazon VPC User Guide.
" }, "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.
To describe a specific placement group that is shared with your account, you must specify the ID of the placement group using the GroupId
parameter. Specifying the name of a shared placement group using the GroupNames
parameter will result in an error.
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 EC2 service endpoints.
For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions your account can use in the Amazon Web Services Account Management Reference Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon EC2 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 Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a 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 Modify Reserved Instances in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a 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 Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes your route tables. The default is to describe all your route tables. Alternatively, you can specify specific route table IDs or filter the results to include only the route tables that match specific criteria.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon VPC User Guide.
" }, "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.
" }, "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.
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 a 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 your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria.
For more information, see Subnets in the Amazon VPC User Guide.
" }, "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.
Describe traffic mirror filters that determine the traffic that is mirrored.
" }, "DescribeTrafficMirrorFilters": { "name": "DescribeTrafficMirrorFilters", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTrafficMirrorFiltersRequest" }, "output": { "shape": "DescribeTrafficMirrorFiltersResult" }, "documentation": "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.
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. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.
" }, "DescribeVpcPeeringConnections": { "name": "DescribeVpcPeeringConnections", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcPeeringConnectionsRequest" }, "output": { "shape": "DescribeVpcPeeringConnectionsResult" }, "documentation": "Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.
" }, "DescribeVpcs": { "name": "DescribeVpcs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVpcsRequest" }, "output": { "shape": "DescribeVpcsResult" }, "documentation": "Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.
" }, "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 VPC 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.
Enabling block public access for snapshots in block-all-sharing mode 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.
If you disable block public access , these snapshots will become publicly available 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 VPC 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.
Enabling block public access for snapshots in block all sharing mode 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.
If you later disable block public access or change the mode to block new sharing, these snapshots will become publicly available 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 the Amazon Web Services Transit Gateways Guide.
" }, "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.
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.
" }, "GetInstanceTpmEkPub": { "name": "GetInstanceTpmEkPub", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetInstanceTpmEkPubRequest" }, "output": { "shape": "GetInstanceTpmEkPubResult" }, "documentation": "Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
" }, "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 specified zone group for your account.
" }, "ModifyCapacityReservation": { "name": "ModifyCapacityReservation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ModifyCapacityReservationRequest" }, "output": { "shape": "ModifyCapacityReservationResult" }, "documentation": "Modifies a Capacity Reservation's capacity, instance eligibility, and the conditions under which it is to be released. You can't modify a Capacity Reservation's instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. 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. For more information, see Modify an active Capacity Reservation.
" }, "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 Modify 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.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure that the volume 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.
" }, "MoveCapacityReservationInstances": { "name": "MoveCapacityReservationInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "MoveCapacityReservationInstancesRequest" }, "output": { "shape": "MoveCapacityReservationInstancesResult" }, "documentation": "Move available capacity from a source Capacity Reservation to a destination Capacity Reservation. The source Capacity Reservation and the destination Capacity Reservation must be active
, owned by your Amazon Web Services account, and share the following:
Instance type
Platform
Availability Zone
Tenancy
Placement group
Capacity Reservation end time - At specific time
or Manually
.
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 EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision
to provisioned
. To monitor the status of an address range, use DescribeByoipCidrs. 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 Sell in the 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 an AMI from a snapshot and Create an instance-store backed AMI in the Amazon EC2 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 an AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon EC2 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.
In most cases, AMIs for Windows, RedHat, SUSE, and SQL Server require correct licensing information to be present on the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide. When creating an AMI from a snapshot, the RegisterImage
operation derives the correct billing information from the snapshot's metadata, but this requires the appropriate metadata to be present. To verify if the correct billing information was applied, check the PlatformDetails
field on the new AMI. If the field is empty or doesn't match the expected operating system code (for example, Windows, RedHat, SUSE, or SQL), the AMI creation was unsuccessful, and you should discard the AMI and instead create the AMI from an instance using CreateImage. For more information, see Create an AMI from an instance in the Amazon EC2 User Guide.
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 more information, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
" }, "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 more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
" }, "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 Work with Spot Instance in the Amazon EC2 User Guide.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide.
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 the VPC. 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.
RunInstances
is subject to both request rate limiting and resource rate limiting. For more information, see Request throttling.
An instance is ready for you to use when it's in the running
state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more 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.
" }, "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) in the Amazon EC2 User Guide.
" }, "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 Amazon EC2 instances 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 Amazon EC2 instances in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 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 VPC 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.
" }, "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" }, "IpamPoolId": { "shape": "IpamPoolId", "documentation": "The ID of an IPAM pool.
" } } }, "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: off
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 Services 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 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 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 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
.
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 Ensuring 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 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 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 (ephemeral
N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0
and ephemeral1
. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
", "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 range.
advertised
: The address range is being advertised to the internet by Amazon Web Services.
deprovisioned
: The address range is deprovisioned.
failed-deprovision
: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
failed-provision
: The request to provision the address range was unsuccessful.
pending-deprovision
: You’ve submitted a request to deprovision an address range and it's pending.
pending-provision
: You’ve submitted a request to provision an address range and it's pending.
provisioned
: The address range is provisioned and can be advertised. The range is not currently advertised.
provisioned-not-publicly-advertisable
: The address range is provisioned and cannot be advertised.
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 EC2 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 EC2 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 EC2 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 EC2 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 EC2 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 Use encryption with EBS-backed AMIs in the Amazon EC2 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 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 S3 API Reference. An invalid or improperly signed PresignedUrl
will cause the copy operation to fail asynchronously, and the snapshot will move to an error
state.
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.
" }, "CreateCapacityReservationBySplittingRequest": { "type": "structure", "required": [ "SourceCapacityReservationId", "InstanceCount" ], "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 Ensure Idempotency.
", "idempotencyToken": true }, "SourceCapacityReservationId": { "shape": "CapacityReservationId", "documentation": "The ID of the Capacity Reservation from which you want to split the available capacity.
" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of instances to split from the source Capacity Reservation.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "The tags to apply to the new Capacity Reservation.
", "locationName": "TagSpecification" } } }, "CreateCapacityReservationBySplittingResult": { "type": "structure", "members": { "SourceCapacityReservation": { "shape": "CapacityReservation", "documentation": "Information about the source Capacity Reservation.
", "locationName": "sourceCapacityReservation" }, "DestinationCapacityReservation": { "shape": "CapacityReservation", "documentation": "Information about the destination Capacity Reservation.
", "locationName": "destinationCapacityReservation" }, "InstanceCount": { "shape": "Integer", "documentation": "The number of instances in the new Capacity Reservation. The number of instances in the source Capacity Reservation was reduced by this amount.
", "locationName": "instanceCount" } } }, "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 Ensuring 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 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 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 customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn
or BgpAsnExtended
when creating the customer gateway. If the ASN is larger than 2,147,483,647
, you must use BgpAsnExtended
.
Default: 65000
Valid values: 1
to 2,147,483,647
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. If OutsideIpAddressType
in your VPN connection options is set to PrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType
is set to PublicIpv4
, you can use a public IPv4 address.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn
or BgpAsnExtended
when creating the customer gateway. If the ASN is larger than 2,147,483,647
, you must use BgpAsnExtended
.
Valid values: 2,147,483,648
to 4,294,967,295
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 the client IP address is preserved as the source. The following are the possible values.
true
- Use the client IP address as the source.
false
- Use the network interface IP address as the source.
Default: false
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" } } }, "CreateIpamExternalResourceVerificationTokenRequest": { "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 that will create the token.
" }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "Token tags.
", "locationName": "TagSpecification" }, "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 } } }, "CreateIpamExternalResourceVerificationTokenResult": { "type": "structure", "members": { "IpamExternalResourceVerificationToken": { "shape": "IpamExternalResourceVerificationToken", "documentation": "The verification token.
", "locationName": "ipamExternalResourceVerificationToken" } } }, "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": "The locale for the pool should be one of the following:
An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.
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 or supported Amazon Web Services Local Zone.
" }, "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.
" }, "EnablePrivateGua": { "shape": "Boolean", "documentation": "Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
" } } }, "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 EC2 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 Services 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 Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.
" } } }, "CreatePublicIpv4PoolResult": { "type": "structure", "members": { "PoolId": { "shape": "Ipv4PoolEc2Id", "documentation": "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 Available Local Zones.
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 }, "TagSpecifications": { "shape": "TagSpecificationList", "documentation": "Traffic Mirroring tags specifications.
", "locationName": "TagSpecification" } } }, "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 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 on which to create the volume.
If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.
" }, "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 device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 1
to 2,147,483,647
The ID of the customer gateway.
", "locationName": "customerGatewayId" }, "IpAddress": { "shape": "String", "documentation": " IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType
in your VPN connection options is set to PrivateIpv4
, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType
is set to PublicIpv4
, you can use a public IPv4 address.
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" }, "BgpAsnExtended": { "shape": "String", "documentation": "The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 2,147,483,648
to 4,294,967,295
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 MyQuery01
in 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 used for the network performance request.
" }, "Statistic": { "shape": "StatisticType", "documentation": "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.
", "locationName": "metric" }, "Statistic": { "shape": "StatisticType", "documentation": "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" } } }, "DeleteIpamExternalResourceVerificationTokenRequest": { "type": "structure", "required": [ "IpamExternalResourceVerificationTokenId" ], "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 token ID.
" } } }, "DeleteIpamExternalResourceVerificationTokenResult": { "type": "structure", "members": { "IpamExternalResourceVerificationToken": { "shape": "IpamExternalResourceVerificationToken", "documentation": "The verification token.
", "locationName": "ipamExternalResourceVerificationToken" } } }, "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.
" }, "NetworkBorderGroup": { "shape": "String", "documentation": "The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.
" } } }, "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 erro